Re: [Flightgear-devel] RFC: man pages

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

On Wed, 29 Aug 2001, Cameron Moore wrote:

> * j4s...@ro... [2001.08.29 17:27]:
> > 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 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.
>
> I understand the parameters (medium,...).  I'm just not sure what the
> difference is between the options.  Are these all just different
> protocols?  If so, how does this general description sound?:

I don't know if its protocol as much as format, but yes that's
the difference.

>
>   --atlas=medium,direction,hz,options,...
>          Open an IO connection using the Atlas protocol.

I would  cover what the options are in the first example.
Without the options defined it's unnecessarily terse.

>
> > --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.
>
> Okay.  What about --native-ctrls=?

This is a guess but I'd say it would be for feeding the
joystick/kbd/pedals attached to a slave machine to the master.
You probably should ask Curt when he gets back.


>
> I'm contemplating whether to add a section describing the IO option
> parameters with it basically being a short version of README.IO.
> --
> Cameron Moore
>
> _______________________________________________
> Flightgear-devel mailing list
> Fli...@li...
> http://lists.sourceforge.net/lists/listinfo/flightgear-devel
>