Re: [Flightgear-devel] RFC: man pages

[Cameron M. <li...@to...>]

* ap...@ea... [2001.08.29 16:58]:
> On Wednesday 29 August 2001 02:34 pm, you wrote:
> > I've put together a man page for fgfs and fgjs that I'd like some
> > feedback on and help with.  You can see my current working version at
> > http://wtlug.org/~hrothgar/fgfs/manpages/.  The txt/ directory contains
> > a plain text version that you can view with your web browser.
> > Otherwise, download the .in files and do `man ./fgfs.1.in`.
> >
> > The fgjs man page is faily simple.  Any additions to that file are
> > welcome since I'm not familiar with that utility.
> >
> > The fgjs man page is quite long.  Search for "FIXME" to see areas that
> > need work.  Here's an overview of the FIXMEs:
> >
> >   * I'm not sure how to describe all of the IO options.
> >   * I have no idea what --joyclient= is for
> >   * I don't know what --props= is for
> >
> > Also, the ENVIRONMENT and FILES sections may need some additions.  All
> > listed options came from src/Main/options.cxx.  There are some that are
> > not listed in the --help output (which should be added, BTW).  Some may
> > be obsolete.  If you have any comments, I'm listening.
> >
> > Part of my rationale behind doing this is for Ove Kaaven, the debian
> > flightgear package maintainer.  Debian requires man pages for all
> > binaries (as all distros should), and there are outstanding man page
> > "bug" reports[1] for the flightgear package.  And besides that, it's
> > still a good idea to have man pages.  :-)
> >
> > [1] http://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=flightgear&archive=no
> 
> A couple notes:
> It would be nice if  --enable-x and --disable-x were grouped together

I considered that, but it created more trouble than it was worth.  The
general convention for man pages is to list options in alphabetical
order.  I think that makes options easier to find and makes the man page
a better reference document.  I don't have the last say here, but that's
the way I see it.

What about added a line like "See also --disable-x" and visa versa?

> and the default called out.

I'll try to do that for the --(en|dis)able-* options.

> --vc and --mach work with LaRCsim as well as JSBSim.

Okay, I think I got that from the --help output.  I'll fix it.

Thanks, Tony
-- 
Cameron Moore