Category : Databases and related files
Archive   : FPLAN.ZIP
Filename : FPLAN.1

 
Output of file : FPLAN.1 contained in archive : FPLAN.ZIP
'\" t \" must preprocess with tbl with troff. -*- nroff -*
.\" $Id: fplan.1,v 2.17 89/11/14 20:29:26 tynor Exp $
.\"-------------------------------------------
.TH FPLAN 1 "11 November 1989" FPLAN "Flight Planning"
.\"-------------------------------------------
.SH NAME
fplan \- flight planner
.\"-------------------------------------------
.SH SYNOPSIS
.LP
\fBfplan -l\fP \fIdesignator ...\fP
.br
\fBfplan -r\fP [ \fB\-\fP | \fIplanfile\fP ]
.br
\fBfplan -g\fP [ \fB\-\fP | \fIplanfile\fP ] (Sun systems only)
.br
\fBfplan\fP [ \fB\-n|w\fP ][ \fB\-b\fP ][ \fB\-d\fP ][ \fB\-e\fP ][
\fB\-s\fP ][ \fB\-t\fP ][ \fB\-\fP | \fIplanfile\fP ]
.br
.\"-------------------------------------------
.SH DESCRIPTION
.LP
\fBfplan\fP reads the \fIplanfile\fP consisting of departure and
destination airports, navigation aids, intermediate checkpoints, fuel
consumption rates, winds aloft, and produces a flight plan including
wind corrected heading, fuel consumption for each leg, vor fixes for
each checkpoint, etc. \fBfplan\fP uses \fBnav(5)\fP format databases
for upward compatibility with those widely distributed databases.
.PP
The primary differences between \fBfplan\fP and \fBnav(1)\fP are that
\fBfplan\fP will automatically compute VOR cross fixes (radial and
distance to/from fix) at each waypoint along the flight and allow you
to enter a waypoint as ``15 miles since the previous waypoint along
the current heading''. These features provide a kind of flight plan
more useful in VFR / dead reckoning flight, where frequent checkpoints
are necessary. On Sun systems, a graphic preview of the flight can be
displayed in a scrollable window.
.\"-------------------------------------------
.SH OPTIONS
.LP
.TP 10
.B \-l
Lookup the \fIdesignator(s)\fP in the databases and
print their information to the standard output. If any designator
exists in both the airports and navigation aids databases, then both
entries are printed.
.TP
.B \-r
Produce a return trip based on the input plan file. All waypoints are
reversed and incremental waypoints are recomputed. Correct \fBnav\fP
directives are included so that each waypoint uses the same VORs as in
the input file. Fuel, wind, airspeed and altitude directives are not
included in the reversed plan.
.TP
.B \-g
(Sun systems only). Preview the flight in a Sunview window. (NOTE: the
previewer uses a naive projection system - curvature of the earth is
ignored. Do not use the preview map for navigation). The window is
divided into two sections: the command panel and the map. The map is a
scrollable canvas where each waypoint and navaid is drawn. The command
panel contains the following items:
.br
\fBQUIT\fP - Quits the previewer.
.br
\fBTO FIRST\fP - Scrolls the map to make the first waypoint visible.
.br
\fBTO LAST\fP - Scrolls the map to make the last waypoint visible.
.br
\fBBRIEF\fP - Toggles whether incremental waypoints are shown (similar
to the \fB-b\fP option).
.br
\fBSCALE\fP - Sets the scale of the map. The default scale is 100
pixels per degree of latitude.
.TP
.B \-
Read the planfile from the standard input. If this option is present,
then no \fIplanfile\fP may be specified.
.TP
.B \-d
Append a sorted summary of all database objects used in the planfile.
.TP
.B \-e
Use Epson (IBM/PC) style box characters on the output form instead of the
default `+', `-', and `|'. Produces a more readable form if your terminal
and/or printer is capable of printing IBM box characters.
.TP
.B \-n
Select the narrow output format (no VOR cross fixes). Fits on a 80
character terminal. Mutually exclusive with the \fB\-w\fP option
[DEFAULT].
.TP
.B \-w
Select the wide output format (with VOR cross fixes). Can be up to 136
characters wide (depending on the number of active VORs). Mutually
exclusive with the \fB\-n\fP option.
.TP
.B \-s
Select statute miles (and miles per hour) for output form. Default is
nautical miles (and knots). Note: All speeds and distances in the
\fIplanfile\fP are assumed to be knots and nautical miles unless
explicitly marked by the \fBmi\fP or \fBmph\fP keywords.
.TP
.B \-b
Selects \fIbrief\fP mode. Intermediate waypoints (those which are not
turning points) are not included in the output form. Useful for seeing
the 'big picture'.
.TP
.B \-t
Disables automatically tracking navaids in the primary navigation
radio (nav(1)). By default the nav(1) VOR automatically tracks to the
next navaid (or from the previous one). When this option is enabled
[DEFAULT], user specified nav(1) assignments are overridden.
.\"-------------------------------------------
.SH "PLANFILE FORMAT"
\fBfplan\fP accepts a reasonably free-format input language to specify
departure and destination airports, winds aloft, intermediate
waypoints, etc. The \fIplanfile\fP consists of any number of
semicolon (;) separated descriptors. Comments are introduced by a
hash mark (#) in any column (all characters following the # on the
line are ignored). Each boldfaced keyword is case sensative - all are
lowercase. A \fIdesignator\fP, on the other hand, is not case
sensative - they may be written in upper or lowercase. In the case of
a conflict with an \fBfplan\fP keyword (e.g. if there is an airport
named VIA), use uppercase to prevent \fBfplan\fP from interpreting VIA
as a keyword. Each descriptor is listed below.
.TP 20
.\"-----------------
\fBfrom\fP \fIdesignator\fP ;
Specifies the departure airport. \fIDesignator\fP is an airport
designator (e.g. ORD). The private and public airports.nav databases
are searched. It is an error if the \fIdesignator\fP cannot be found
in any database. (Example: \fIfrom ORD;\fP).
.\"-----------------
.TP
\fBto\fP \fIdesignator\fP ;
Specifies the destination airport. \fIDesignator\fP is an airport
designator (e.g. ORD). The private and public airports.nav databases
are searched. It is an error if the \fIdesignator\fP cannot be found
in any database. (Example: \fIto ATL;\fP).
.\"-----------------
.PP
Intermediate waypoints can be specified in three ways: by designator
(for vors or airports in the databases), by geographic coordinates
(latitude and longitude), or as a `distance since last turn' (useful
for VFR, dead reckoning flights where it is helpful to have a
checkpoint every 10 minutes or so).
.TP 20
\fBvia\fP \fIdesignator\fP ;
Specifies a navaid or airport waypoint. \fIDesignator\fP is a
navaid, intersection, or airport designator (e.g. RMG). The private
and public vors.nav, then airports.nav databases are searched. It is
an error if the \fIdesignator\fP cannot be found in any database.
(Example: \fIvia CMI;\fP).
.\"-----------------
.TP
\fBvia\fP \fIlatitude\fP , \fIlongitude [, name [, city [, comment ]]]\fP ;
Specifies a geographic coordinate checkpoint. Use positive latitudes
for north, negative for south. Use positive longitudes for west,
negative for east. Use \fIdegrees.minutes\fP notation: 45.678 means 45
degrees, 67.8 minutes. Up to three optional comma-separated strings
(corresponding to the \fIname\fP, \fIcity\fP, and \fIcomment\fP,
strings in the output form) may be specified. (Examples: \fIvia 33.51,
84.38, ``Tank Farms'', ``Atlanta'', ``7nm NW of FTY'';\fP or \fIvia
33.51, 84.38, ``Tank Farms'', ``Atlanta'';\fP or even just \fIvia
33.51, 84.38;\fP).
.\"-----------------
.TP
\fBvia\fP \fIdistance [, name [, city [, comment ]]]\fP ;
Specifies an `incremental' checkpoint. If positive, \fIDistance\fP is
a number specifying the number of \fInautical\fP miles (unless the
\fBmi\fP keyword is specified - then statute miles) since the last
turn point. If negative, then the distance until the next turn point.
Incremental waypoints are very useful for intermediate waypoints in
VFR / dead reckoning flight, where it is often necessary to have
checkpoints every 10 miles or so. They are also useful for specifying
`end-of-climb' or `beginning-of-descent' points. The optional strings
are described under geographic coordinate checkpoints. Warning:
successive `incremental' distances refer to the previous
non-`incremental' checkpoint. Thus the following two waypoints
actually refer to the same point: \fIvia 10, ``point 1'';\fP and
\fIvia 10, ``point 2''\fP. (Examples: \fIvia 12;\fP or \fIvia 13.4
mi;\fP or \fIvia 5, ``Montefusco's Lake'';\fP)
.PP
The following directives are used to specify the wind and true airspeed.
.TP 20
\fBwind\fP \fIheading\fP \fB@\fP \fIspeed\fP ;
Specifies the wind speed and direction. If no wind is specified, it
is assumed to be calm. (Example: \fIwind 320@15;\fP).
.TP
\fBtas\fP \fIspeed\fP ;
Specifies the true airspeed. If no true airspeed is specified, time
estimates will not be made. The speed is assumed to be in knots unless
the \fBmph\fP keyword is specified. (Example: \fItas 95;\fP or \fItas
95mph;\fP).
.PP
In order for fuel consumption computations to be made, the initial
amount of fuel on board and burn rate must be specified.
.TP 20
\fBfuel_amt\fP \fInumber\fP ;
Specifies the initial amount (pounds, gallons, liters, whatever) of
fuel on board. (Example: \fIfuel_amt 24.5;\fP).
.TP
\fBfuel_rate\fP \fInumber\fP ;
Specifies the fuel burn rate in units per hour - use the same units
as in the \fBfuel_amt\fP directive. (Example: \fIfuel_rate 5.4;\fP).
.TP
\fBfuel_used\fP \fInumber\fP ;
Specifies fuel burn not computable from the burn rate (e.g. for taxi
and climb). Use the same units as in the \fBfuel_amt\fP directive.
(Example: \fIfuel_used 0.8;\fP).
.PP
The flight altitude may be specified with the following directive. It
is currently simply copied to the output form, but future versions of
\fBfplan\fP may use it to look up true airspeed and fuel economy from
an aircraft specific database.
.TP 20
\fBalt\fP \fIfeet\fP ;
Specifies the flight altitude for the succeeding legs. (Example:
\fIalt 5500;\fP).
.PP
VOR cross fixes can be computed for each waypoint. Up to 6
simultaneous fixes may be specified. By default, nav(1) automatically
tracks to the next waypoint (if it is a navigation aid), or from the
previous waypoint. This can be disabled by the \fB-t\fP command line
switch. When auto track is enabled (the default), user specified
values for nav(1) are ignored.
.TP 20
\fBnav (\fP \fInumber\fP \fB)\fP \fIdesignator\fP ;
Specifies which VOR to track in the \fInumber\fP navigation radio. It
is an error if no navaid named \fIdesignator\fP can be found in the
databases. (Example: \fInav(2) cmi;\fP).
.\"-------------------------------------------
.SH EXAMPLE
The following example planfile illustrates a simple flight from
Chicago O'Hare to Champaign, IL via the DuPage VOR with a 5 knot wind
from 320. True airspeed is set for 95 knots. VOR cross fixes from the
Peotone VOR (EON) will be computed. Initial fuel is 24.5 gallons and
fuel economy is set to 5.4 gallons per hour.
.nf
.sp
nav(2) EON;
fuel_amt 24.5;
fuel_rate 5.4;
tas 95;
wind 230@5;
from ORD;
via DPA;
to CMI;
.sp
.fi
Running
.B fplan
with this planfile produces (elided in order to fit the narrow page):
.sp
.\" if this is nroff, then don't use tbl since the column widths
.\" usually end up too wide for an 80 column terminal. If it's troff,
.\" then use tbl since we don't have constant width fonts to do our
.\" formatting.
.if n \{ .nf
+-------- / -------+---+-----+ +--------+
|CHECKPOI / DESIG| | FUEL| | VOR|
|CITY / FREQ|DIS| ETE+------+---+----+-----+--------+ FREQ|
|COMMENT / AT/LONG|REM| ATE| MC|TAS|DIST| ALT| VOR|DME RAD|
+-------- / -------+---+-----> WIND|EGS| ETE| RATE| FREQ<--------+
|CHICAGO- / ORD| | 24.5| MH|AGS| ATE| FUEL|DME RAD| EON|
|CHICAGO, / | 0| +------+---+----+-----+--------+ 113.20|
| / 87.543]|132| | 256| 95| 21| | DPA|43 171T|
+-------- / -------+---+----->230@05| 90| 14| 5.4| 108.40<--------+
|DUPAGE / DPA| | 23.3| 254| | | 1.2|21 253T| EON|
| / 108.40| 21| 14+------+---+----+-----+--------+ 113.20|
|L [IL] C / 88.210]|111| | 176| 95| 111| | CMI|45 144T|
+-------- / -------+---+----->230@05| 92|1:12| 5.4| 110.00<--------+
|UNIVERSI / CMI| | 16.8| 179| | | 6.5|111 175T| EON|
|CHAMPAIG / 120.40|132| 1:26+------+---+----+-----+--------+ 113.20|
|CHICAGO / 88.167]| 0| | |77 015T|
+-------- / -------+---+-----+ +--------+
.fi
\}
.if t \{ .nf
.bp
\s-2
Speeds in knots; Distances in nautical miles
.fi
.TS
tab (~) center;
| l || r | r | r | r r r r re | re | .
_~_~_~_~~~~~~_
CHECKPOINT~DESIG~~FUEL~~~~~~VOR
.T&
| l || r | r | r | r | r | r | r | re | re | .
CITY~FREQ~DIS~ETE~_~_~_~_~_~FREQ
COMMENT~T/LONG~REM~ATE~MC~TAS~DIST~ALT~VOR~RAD DME
_~_~_~_~WIND~EGS~ETE~RATE~FREQ~_~
CHICAGO-O~ORD~~24.5~MH~AGS~ATE~FUEL~RAD DME~EON
CHICAGO, IL~~0~~_~_~_~_~_~113.20
CHICAGO~87.543]~132~~256~95~21~~DPA~171T 43
_~_~_~_~230@05~90~14~5.4~108.40~_
DUPAGE~DPA~~23.3~254~~~1.2~253T 21~EON
~108.40~21~14~_~_~_~_~_~113.20
L [IL] CHIC~88.210]~111~~176~95~111~~CMI~144T 45
_~_~_~_~230@05~92~1:12~5.4~110.00~_
UNIVERSITY~CMI~~16.8~179~~~6.5~175T 111~EON
CHAMPAIGN/~120.40~132~1:26~_~_~_~_~_~113.20
.T&
| l || r | r | r | r r r r re | re | .
CHICAGO~88.167]~0~~~~~~~015T 77
_~_~_~_~~~~~~_
.TE
\s+2
\}
.\"-------------------------------------------
.SH ENVIRONMENT
.B fplan
recognizes the following environment variables to specify where to
look for its databases:
.TP 12
.B NAV
Overrides the location of the public databases (Unix default is
"/usr/local/lib/preflight", MSDOS default is "\\lib\\flight").
.TP
.B NAV_PRIVATE
Overrides the location of the private databases (Unix default is
"~/preflight", MSDOS default is "\\flight").
.\"-------------------------------------------
.SH FILES
The database files used by \fBfplan\fP are specially formatted for
quick lookup. Use \fBpaddb\fP to convert a text file into the
formatted version suitable for use with \fBfplan\fP.
.sp
.PD 0
.TP 15
.B airports.nav
Airports database in \fBfplan(5)\fP format.
.TP
.B vors.nav
Navigation aids database in \fBfplan(5)\fP format.
.PD
.\"-------------------------------------------
.SH SEE ALSO
\fBnav(1)\fP, \fBfplan(5)\fP, \fBnav(5)\fP, \fBpaddb(1)\fP
.LP
.\"-------------------------------------------
.SH AUTHOR
Steve Tynor \- [email protected]
.\"-------------------------------------------
.SH DISCLAIMER
USE AT YOUR OWN RISK! I assume no responsibility for any errors
in this program, its database or documentation. I will make an effort
to fix bugs, but if you crash and burn because, for example, fuel
estimates in this program were inaccurate, it's your own fault for
trusting somebody else's code! Remember, as Pilot In Command, it's
\fIyour\fP responsibility to do complete preflight planning. Use this
program as a flight planning aid, but verify its results before using
them.
.\"-------------------------------------------
.SH LIMITATIONS
The airways.nav databases are currently not used.


  3 Responses to “Category : Databases and related files
Archive   : FPLAN.ZIP
Filename : FPLAN.1

  1. Very nice! Thank you for this wonderful archive. I wonder why I found it only now. Long live the BBS file archives!

  2. This is so awesome! 😀 I’d be cool if you could download an entire archive of this at once, though.

  3. But one thing that puzzles me is the “mtswslnkmcjklsdlsbdmMICROSOFT” string. There is an article about it here. It is definitely worth a read: http://www.os2museum.com/wp/mtswslnk/