Shlomi Fish
Fri, 25 Jan 2002 01:59:46 -0800
On Thu, 24 Jan 2002, Tzafrir Cohen wrote: > man pages > > Some of you probably read my rant to linux-il about this. I don't like to > write man pages. Nadav has suggested me to check the groff (7) (not groff > (1)). I managed to somehow skip groff(7) when looking for documentation). > > That man page serves two useful purposes: > > 1. It gives a resonable refeernce to groff > 2. It gives a sample of a groff page that is written The Right Way (unlike > most man pages, including biditext, refreshd and r2l). > > Unfortunetly I have not had a chance to check perl pod. I can write the man page in perl POD. I successfully employed POD to write the man pages of Freecell Solver and FCFS RWLock. I'm aware of several other projects (almost all Perl Modules and Scripts as well as mhash) which use it. Perl POD is not spectacular, but it is very nice for writing man pages. Tzafrir, if you can give me the text of the man page, I can podify it. (or you can learn POD on your own, based on "man perlpod" and the various examples around) I also remember seeing a package called help2man (http://www.gnu.org/software/help2man/) which you may find helpful in case you don't want to learn POD. > I also tried a > bit, and didn't like very much, the package manedit. Manedit is a gnome > editor saves sources to man pages in some xml format, and converts this to > groff. Others may have a different opinion. > > > And I'll conclude this post with the credits list: > > * Matan Ziv-Av, who wrote biditext initially > * Ilya Konstantinov, for getting it to work with QT (Hooking on > XDrawString16 etc.) > * mulix, for r2llib, parts of biditext > * choo, r2l-plugins (terminal, dockapp and gnome applet) > * emil, for refreshd and solaris debugging > * Shlomif, The perl-gtk early client(where is the KDE applet iindeed?) > Like I said, I gave up on writing it, after it did not behave as I expected it. I don't mind hacking on it some more, but I'll need someone knowledgeable who can answer my questions. Regards, Shlomi Fish > * And anybody else who may have contributed > > Thanks! > > -- ---------------------------------------------------------------------- Shlomi Fish [EMAIL PROTECTED] Home Page: http://t2.technion.ac.il/~shlomif/ Home E-mail: [EMAIL PROTECTED] He who re-invents the wheel, understands much better how a wheel works. -------------------------------------------------------------------------- Haifa Linux Club Mailing List (http://linuxclub.il.eu.org) To unsub send an empty message to [EMAIL PROTECTED]