Re: [Flightgear-devel] RFC: man pages

[John C. <j4s...@ro...>]

On Wed, 29 Aug 2001, Cameron Moore 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.

For the FIXME stuff...medium would be either a network socket or
a serial port, direction is either in, out, or bidirectional, hz
is the update speed and options include the ip adress (or which serial
port(have somebody confirm this) port # to bind the socket to and the
packet type.

--atlas is the native format used by Per Leidmans moving map prog
--garmin is format used by garmin GPS units
--native is FGFS native format
--nmea is NMEA format used by navigation equipment
--props is the telnet interface

Here are examples from my .fgfsrc.....
#################################################
# Curt's groovy telnet interface
--props=socket,bi,5,localhost,5500,tcp

###################################################
# Socket for Atlas
--nmea=socket,out,0.5,localhost,5600,udp

In this case, I run atlas on the same box as FGFS,
the IP address should be the *destination* if you are
running atlas on a separate machine. AFAIK for
an inbound socket the IP address should be the machine feeding
data. Direction "in" is used on slaves when running multiple
display units.
Using the broadcast address for a network segment will
work as expected.

>   * 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.  :-)

Yes, absolutely. This is a great thing, thanks for putting in the effort.

TTYL
J

>
> [1] http://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=flightgear&archive=no
> --
> Cameron Moore
>
> _______________________________________________
> Flightgear-devel mailing list
> Fli...@li...
> http://lists.sourceforge.net/lists/listinfo/flightgear-devel
>