summaryrefslogtreecommitdiff
path: root/gps.1
diff options
context:
space:
mode:
authorGary E. Miller <gem@rellim.com>2006-08-18 23:42:08 +0000
committerGary E. Miller <gem@rellim.com>2006-08-18 23:42:08 +0000
commit2a488def273905cb325ea99ec61af4bbdd5cc8a1 (patch)
tree0ed57fb05137f81394c3080c0b9821df251fa9ef /gps.1
parent4bf8bd5599e2dc58477b399fdb102252a197f69e (diff)
downloadgpsd-2a488def273905cb325ea99ec61af4bbdd5cc8a1.tar.gz
Sync gps.1 with gps.xml
Diffstat (limited to 'gps.1')
-rw-r--r--gps.1192
1 files changed, 105 insertions, 87 deletions
diff --git a/gps.1 b/gps.1
index 4708a619..d02203c1 100644
--- a/gps.1
+++ b/gps.1
@@ -1,81 +1,106 @@
-.\" ** You probably do not want to edit this file directly **
-.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
-.\" Instead of manually editing it, you probably should edit the DocBook XML
-.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GPS" "1" "08/18/2006" "9 Aug 2004" "9 Aug 2004"
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH "NAME"
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "GPS" 1 "" "" ""
+.SH NAME
gps, xgps, xgpsspeed, cgps, cgpxlogger \- test clients for gpsd
.SH "SYNOPSIS"
+.ad l
+.hy 0
.HP 5
-\fBxgps\fR [\fIX\-options\fR] [\-h] [\-V] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\-altunits\ {[feet]\ [meters]}] [\-l\ [[d]\ [m]\ [s]]] [\-s\ \fIsmoothing\fR] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+\fBxgps\fR [\fIX\-options\fR] [\-h] [\-V] [\-speedunits\ {\fBmph\fR\ |\ \fBkph\fR\ |\ \fBknots\fR}] [\-altunits\ {\fBfeet\fR\ |\ \fBmeters\fR}] [\-l\ [\fBd\fR\ |\ \fBm\fR\ |\ \fBs\fR]] [\-s\ \fIsmoothing\fR] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+.ad
+.hy
+.ad l
+.hy 0
.HP 10
-\fBxgpsspeed\fR [\-rv] [\fIX\-options\fR] [\-h] [\-V] [\-nc\ \fIX\-color\fR] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+\fBxgpsspeed\fR [\-rv] [\fIX\-options\fR] [\-h] [\-V] [\-nc\ \fIX\-color\fR] [\-speedunits\ {\fBmph\fR\ |\ \fBkph\fR\ |\ \fBknots\fR}] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+.ad
+.hy
+.ad l
+.hy 0
.HP 5
-\fBcgps\fR [\-h] [\-s] [\-V] [\-speedunits\ {[mph]\ [kph]\ [knots]}] [\-altunits\ {[feet]\ [meters]}] [\-l\ [[d]\ [m]\ [s]]] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+\fBcgps\fR [\-h] [\-s] [\-V] [\-speedunits\ {\fBmph\fR\ |\ \fBkph\fR\ |\ \fBknots\fR}] [\-altunits\ {\fBfeet\fR\ |\ \fBmeters\fR}] [\-l\ [\fBd\fR\ |\ \fBm\fR\ |\ \fBs\fR]] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
+.ad
+.hy
+.ad l
+.hy 0
.HP 10
\fBgpxlogger\fR [\fIlogfile\fR]
+.ad
+.hy
+.ad l
+.hy 0
.HP 11
\fBcgpxlogger\fR [\-s\ \fIgpsd\-server\fR] [\-p\ \fIgpsd\-port\fR] [\-i\ \fIpoll\-interval\fR] [\-h]
+.ad
+.hy
+
.SH "DESCRIPTION"
+
.SS "xgps"
+
.PP
-xgps
-is a simple test client for
-gpsd
-with an X interface. It displays current GPS position/time/velocity information and (for GPSes that support the feature) the locations of accessible satellites.
+xgps is a simple test client for gpsd with an X interface\&. It displays current GPS position/time/velocity information and (for GPSes that support the feature) the locations of accessible satellites\&.
+
.PP
-xgps
-accepts an \-h option as for
-gpsd, or a \-V option to dump the package version and exit.
+xgps accepts an \-h option as for gpsd, or a \-V option to dump the package version and exit\&.
+
.PP
-An optional argument may specify a server to get data from; a colon\-separated suffix is taken as a port number. If there is a second colon\-separated suffix, that is taken as a device name to be handed to the daemon in an F= command.
+An optional argument may specify a server to get data from; a colon\-separated suffix is taken as a port number\&. If there is a second colon\-separated suffix, that is taken as a device name to be handed to the daemon in an F= command\&.
+
.PP
-The
-\fB\-speedunits\fR
-option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour. The default is miles per hour. This option can also be set as the X resource 'speedunits'.
+The \fB\-speedunits\fR option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour\&. The default is miles per hour\&. This option can also be set as the X resource 'speedunits'\&.
+
.PP
-The
-\fB\-altunits\fR
-option can be used to set the altitude units for display; follow the keyword with 'meters' or 'feet'. The default is feet. This option can also be set as the X resource 'altunits'.
+The \fB\-altunits\fR option can be used to set the altitude units for display; follow the keyword with 'meters' or 'feet'\&. The default is feet\&. This option can also be set as the X resource 'altunits'\&.
+
.PP
-The
-\fB\-l\fR
-option sets the format of latitude and longitude reports. The value 'd' produces decimal degrees and is the default. The value 'm' produces degrees and decimal minutes. The value 's' produces degrees, minutes, and decimal seconds.
+The \fB\-l\fR option sets the format of latitude and longitude reports\&. The value 'd' produces decimal degrees and is the default\&. The value 'm' produces degrees and decimal minutes\&. The value 's' produces degrees, minutes, and decimal seconds\&.
+
.PP
-The
-\fB\-s\fR
-option sets the number of received sentences to process after any fix is received before blanking any field. By default it is set to 4, which prevents annoying display flicker on NMEA devices that send several difference sentence types per update cycle, only one of which is a true fix. Set this option to zero to disable smoothing and see each update exactly as it is sent.
+The \fB\-s\fR option sets the number of received sentences to process after any fix is received before blanking any field\&. By default it is set to 4, which prevents annoying display flicker on NMEA devices that send several difference sentence types per update cycle, only one of which is a true fix\&. Set this option to zero to disable smoothing and see each update exactly as it is sent\&.
+
.PP
-There is a known bug in
-xgps; it assumes the default font size is no more than 18 pixels. If this is not the case, the satellite data display will show fewer than 12 satellites.
+There is a known bug in xgps; it assumes the default font size is no more than 18 pixels\&. If this is not the case, the satellite data display will show fewer than 12 satellites\&.
+
.SS "xgpsspeed"
+
.PP
-xgpsspeed
-is a speedometer that uses position information from the GPS. It accepts an \-h option and optional argument as for
-gps, or a \-V option to dump the package version and exit. Additionally, it accepts \-rv (reverse video) and \-nc (needle color) options.
+xgpsspeed is a speedometer that uses position information from the GPS\&. It accepts an \-h option and optional argument as for gps, or a \-V option to dump the package version and exit\&. Additionally, it accepts \-rv (reverse video) and \-nc (needle color) options\&.
+
.PP
-The \-speedunits option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour. The default is miles per hour. This option can also be set as the X resource 'speedunits'.
+The \-speedunits option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour\&. The default is miles per hour\&. This option can also be set as the X resource 'speedunits'\&.
+
.SS "cgps"
+
+.PP
+cgps is a client resembling xgps, but without the pictorial satellite display and able to run on a serial terminal or terminal emulator\&.
+
.PP
-cgps
-is a client resembling
-xgps, but without the pictorial satellite display and able to run on a serial terminal or terminal emulator.
-.PP
-The
-\fB\-s\fR
-option prevents
-cgps
-from printing the raw data. This display can also be toggled with the s command.
-.PP
-Rather than use X resources to determine which units to use,
-cgps
-looks at variables in its environment. Here are the variables and values it checks:
-.sp
-.nf
+The \fB\-s\fR option prevents cgps from printing the raw data\&. This display can also be toggled with the s command\&.
+
+.PP
+Rather than use X resources to determine which units to use, cgps looks at variables in its environment\&. Here are the variables and values it checks:
+
+.IP
+
GPSD_UNITS one of:
imperial = miles/feet
nautical = knots/feet
@@ -90,49 +115,42 @@ looks at variables in its environment. Here are the variables and values it chec
C = miles/feet
POSIX = miles/feet
[other] = km/meters
-.fi
+
.PP
-cgps
-terminates when you send it a SIGHUP or SIGINT; given default terminal settings this will happen when you type Ctl\-C at it. It will also terminate on 'q'
+cgps terminates when you send it a SIGHUP or SIGINT; given default terminal settings this will happen when you type Ctl\-C at it\&. It will also terminate on 'q'
+
.PP
-The 'j' command toggles whether or not fix data is cleared at start of cycle; see
-\fBgpsd\fR(8)
-for discussion.
+The 'j' command toggles whether or not fix data is cleared at start of cycle; see \fBgpsd\fR(8) for discussion\&.
+
.SS "cgpxlogger"
+
.PP
-This program connects to gpsd, polls for location, and logs each fix to standard output in GPX (XML) format.
+This program connects to gpsd, polls for location, and logs each fix to standard output in GPX (XML) format\&.
+
.PP
-The program also writes start and end messages to syslog.
+The program also writes start and end messages to syslog\&.
+
.SS "gpxlogger"
+
.PP
-This program listens to DBUS broadcasts from gpsd (org.gpsd.fix) and logs each fix to standard output as they arrive in an XML format.
+This program listens to DBUS broadcasts from gpsd (org\&.gpsd\&.fix) and logs each fix to standard output as they arrive in an XML format\&.
+
.PP
-The output may be composed of multiple tracks. A new track is created if there's no fix for 5 seconds.
+The output may be composed of multiple tracks\&. A new track is created if there's no fix for 5 seconds\&.
+
.PP
-The program also writes start and end messages to syslog.
+The program also writes start and end messages to syslog\&.
+
.SH "SEE ALSO"
+
.PP
-\fBgpsd\fR(8),
-\fBlibgps\fR(3),
-\fBlibgpsd\fR(3),
-\fBgpsprof\fR(1),
-\fBgpsfake\fR(1).
+ \fBgpsd\fR(8), \fBlibgps\fR(3), \fBlibgpsd\fR(3), \fBgpsprof\fR(1), \fBgpsfake\fR(1)\&.
+
.SH "AUTHORS"
+
+.PP
+Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S\&. Raymond(xgps)\&. Jeff Francis (cgps)\&. Amaury Jacquot <sxpert@esitcom\&.org> & Petter Reinholdtsen <pere@hungry\&.com> (gpxlogger)\&. Chris Kuethe <chris\&.kuethe@gmail\&.com> (cgpxlogger)\&.
+
.PP
-Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S. Raymond(xgps). Jeff Francis (cgps). Amaury Jacquot
-<sxpert@esitcom.org>
-& Petter Reinholdtsen
-<pere@hungry.com>
-(gpxlogger). Chris Kuethe
-<chris.kuethe@gmail.com>
-(cgpxlogger).
-.PP
-This manual page by Eric S. Raymond
-<esr@thyrsus.com>. There is a project page, with
-xgps
-screenshots, at
-[1]\&\fIberlios.de\fR.
-.SH "REFERENCES"
-.TP 3
-1.\ berlios.de
-\%http://gpsd.berlios.de/
+This manual page by Eric S\&. Raymond <esr@thyrsus\&.com>\&. There is a project page, with xgps screenshots, at berlios\&.de: \fIhttp://gpsd.berlios.de/\fR\&.
+