From f4de307b58a4328a250d2b6513cc14f0b58948d9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=98yvind=20A=2E=20Holm?= Date: Thu, 1 Dec 2016 02:08:27 +0100 Subject: [PATCH] doc/: Delete and ignore gpst.1 and gpst.html, they should be generated d992995c-b762-11e6-bc3c-279c2a0468a3 --- doc/.gitignore | 2 + doc/Makefile | 2 +- doc/gpst.1 | 487 --------------------------------------------------------- doc/gpst.html | 127 --------------- 4 files changed, 3 insertions(+), 615 deletions(-) create mode 100644 doc/.gitignore delete mode 100644 doc/gpst.1 delete mode 100644 doc/gpst.html diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..95b4f2d --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +/gpst.1 +/gpst.html diff --git a/doc/Makefile b/doc/Makefile index 5792dff..b3f4699 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -17,7 +17,7 @@ $(HTMLFILE): $(DBFILE) .PHONY: clean clean: - # rm -fv $(HTMLFILE) $(MANPAGE) + rm -f $(HTMLFILE) $(MANPAGE) .PHONY: test test: diff --git a/doc/gpst.1 b/doc/gpst.1 deleted file mode 100644 index cb9c3da..0000000 --- a/doc/gpst.1 +++ /dev/null @@ -1,487 +0,0 @@ -'\" t -.\" Title: gpst -.\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 -.\" Date: 2010-05-01 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] -.\" Language: English -.\" -.TH "GPST" "1" "2010-05-01" "[FIXME: source]" "[FIXME: manual]" -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -gpst \- Converts between various GPS formats\&. -.SH "SYNOPSIS" -.HP \w'\fBgpst\fR\ 'u -\fBgpst\fR [\fIoptions\fR] [\fIfile\fR...] -.HP \w'\fBgpst\fR\ 'u -\fBgpst\fR {\-S} [\fIoptions\fR] [\fIfile\fR...] -.SH "DESCRIPTION" -.PP -\fB\-\-chronology\fR -.RS 4 -Check for broken chronology, warn about entries with an old timestamp\&. -.RE -.PP -\fB\-d\fR, \fB\-\-skip\-dups\fR -.RS 4 -If succeeding identical coordinates are found, print only the first one and ignore the rest\&. -.RE -.PP -\fB\-e\fR, \fB\-\-epoch\fR -.RS 4 -Use seconds since 1970\-01\-01 00:00:00 GMT as date format\&. -.RE -.PP -\fB\-\-fix\fR -.RS 4 -Comment out entries which is obviously wrong\&. Use together with -\fB\-\-chronology\fR -to fix those kind of errors\&. Does not work with GPX output yet\&. -.RE -.PP -\fB\-\-from\-date \fR\fB\fIx\fR\fR -.RS 4 -Used by the -pgwupd -format\&. Specifies from which date waypoints should be updated\&. No checks for valid date format here, let -PostgreSQL -take care of that\&. All variants it understands can be used here\&. -.RE -.PP -\fB\-h\fR, \fB\-\-help\fR -.RS 4 -Send a brief help summary to stdout\&. -.RE -.PP -\fB\-\-inside\fR -.RS 4 -Print only trackpoints inside a rectangle specified by -\fB\-\-pos1\fR -and -\fB\-\-pos2\fR\&. -.RE -.PP -\fB\-n\fR, \fB\-\-undefined \fR\fB\fIx\fR\fR -.RS 4 -Use -\fIx\fR -as undefined value\&. -.RE -.PP -\fB\-\-near\fR -.RS 4 -Add names of the three closest waypoints to the trackpoint\&. Unfinished and experimental, needs -\fBgpsbabel\fR(1), which is called from the program as -\fB/usr/local/bin/gpsbabel\fR\&. -.RE -.PP -\fB\-o\fR, \fB\-\-output\-format \fR\fB\fIx\fR\fR -.RS 4 -Use output format -\fIx\fR: -.PP -\fBclean\fR -.RS 4 -TAB\-separated format with longitude, latitude and altitude\&. -.RE -.PP -\fBcsv\fR -.RS 4 -TAB\-separated format: -.PP -date -.RS 4 -Date of trackpoint\&. Format: -\fIyyyy\fR\-\fImm\fR\-\fIdd\fRT\fIhh\fR:\fImm\fR:\fIss\fRZ -unless the -\fB\-\-epoch\fR -option is specified\&. If so, it\(cqs represented as number of seconds since 1970\-01\-01 00:00:00 UTC\&. -.RE -.PP -longitude -.RS 4 -Longitude, decimal degrees\&. -.RE -.PP -latitude -.RS 4 -Latitude, decimal degrees\&. -.RE -.PP -altitude -.RS 4 -Altitude in metres above sea level\&. Optional\&. If not present, the corresponding TAB is also printed, to keep the number of columns intact\&. -.RE -.RE -.PP -\fBgpsml\fR (Default) -.RS 4 -Line\-based XML which makes it easy to edit and grep\&. In the past, there was this big plan about making this the default storage format, so it was declared as The Honourable Default Output Format\&. But using GPX is the way to go, so this will probably change in the future\&. It\(cqs way too -de facto -and widely used, so storing GPS data in anything else is sheer waste of work\&. Probably not finished yet\&. -.RE -.PP -\fBgpstrans\fR -.RS 4 -The format generated by -\fBgpstrans\fR(1)\&. -.RE -.PP -\fBgpx\fR -.RS 4 -Not complete yet, but good enough in most cases\&. -.RE -.PP -\fBpgtab\fR -.RS 4 -TAB\-separated format for import into -PostgreSQL\&. Undefined values are written as -\eN -if the -\fB\-\-undefined\fR -option is not specified\&. -.PP -date -.RS 4 -Format: -\fIyyyy\fR\-\fImm\fR\-\fIdd\fRT\fIhh\fR:\fImm\fR:\fIss\fRZ -.RE -.PP -coor -.RS 4 -Format: -(\fIlat\fR,\fIlon\fR) -.RE -.PP -ele -.RS 4 -Altitude in metres above sea level\&. -.RE -.PP -name -.RS 4 -Short name of closest waypoint\&. Calculated in -PostgreSQL, so this value is always -\eN\&. -.RE -.PP -dist -.RS 4 -Distance in decimal degrees to closest waypoint\&. Calculated in -PostgreSQL, so this value is always -\eN\&. -.RE -.PP -description -.RS 4 -Description of waypoint\&. Calculated in -PostgreSQL, so this value is always -\eN\&. -.RE -.RE -.PP -\fBpgwtab\fR -.RS 4 -Output waypoints on a TAB\-separated format: -.PP -coor -.RS 4 -Format: -(\fIlat\fR,\fIlon\fR) -.RE -.PP -name -.RS 4 -Title of waypoint\&. -.RE -.PP -ele -.RS 4 -Elevation in metres above sea level\&. -.RE -.PP -type -.RS 4 -Type of waypoint, same as the GPX - -element\&. -.RE -.PP -time -.RS 4 -Timestamp of waypoint\&. -.RE -.PP -cmt -.RS 4 -Short waypoint description, used by the GPS as a comment\&. Same as the GPX - -element\&. -.RE -.PP -descr -.RS 4 -Long description, not used by the GPS\&. Same as the GPX - -element\&. -.RE -.PP -src -.RS 4 -Source of data, same as the - -GPX element\&. -.RE -.PP -sym -.RS 4 -GPS symbol name\&. Same as the - -GPX element\&. -.RE -.RE -.PP -\fBpgwupd\fR -.RS 4 -Output waypoints as SQL transactions which updates the -name -and -dist -columns\&. -.RE -.PP -\fBposcount\fR -.RS 4 -Creates a 3D plot where areas with many trackpoints are higher than areas with less track points\&. -.RE -.PP -\fBps\fR -.RS 4 -Postscript\&. Unfinished\&. -.RE -.PP -\fBsvg\fR -.RS 4 -Unfinished\&. -.RE -.PP -\fBxgraph\fR -.RS 4 -Input format for -\fBxgraph\fR(1)\&. -.RE -.PP -\fBygraph\fR -.RS 4 -Input format for -\fBygraph\fR(1)\&. -.RE -.RE -.PP -\fB\-\-outside\fR -.RS 4 -Print only trackpoints outside a rectangle specified by -\fB\-\-pos1\fR -and -\fB\-\-pos2\fR\&. -.RE -.PP -\fB\-\-pos1 \fR\fB\fIx1\fR\fR\fB,\fR\fB\fIy1\fR\fR, \fB\-\-pos2 \fR\fB\fIx2\fR\fR\fB,\fR\fB\fIy2\fR\fR -.RS 4 -Specifies corners of an area rectangle used by the -\fB\-\-inside\fR -and -\fB\-\-outside\fR -options\&. The -\fIx\fR -and -\fIy\fR -values are specified as decimal degrees, negative for west or south\&. -.RE -.PP -\fB\-r\fR, \fB\-\-require \fR\fB\fIx\fR\fR -.RS 4 -Specify requirements for trackpoints to be written\&. -\fIx\fR -is a string with the following flags: -.PP -\fBe\fR -.RS 4 -Print only waypoints which have an elevation\&. -.RE -.PP -\fBp\fR -.RS 4 -Print only waypoints which have a position\&. -.RE -.PP -\fBt\fR -.RS 4 -Print only waypoints which have a timestamp\&. -.RE -.RE -.PP -\fB\-R\fR, \fB\-\-round \fR\fB\fIx\fR\fR\fB=\fR\fB\fIy\fR\fR\fB[,\fIx2\fR=\fIy2\fR[\&.\&.\&.]]\fR -.RS 4 -Round trackpoint element -\fIx\fR -to -\fIy\fR -decimals\&. -.sp -Example: -\fB\-\-round lat=4,lon=5,ele=1\fR -.RE -.PP -\fB\-s\fR, \fB\-\-short\-date\fR -.RS 4 -Use short date format\&. -.RE -.PP -\fB\-S\fR, \fB\-\-save\-to\-file \fR\fB\fIx\fR\fR -.RS 4 -Save the unconverted data to a file with a filename starting with the timestamp of the first trackpoint\&. The parameter string -\fIx\fR -is added at the end of the filename\&. For the time being this option will ignore all other options\&. -.if n \{\ -.sp -.\} -.RS 4 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.ps +1 -\fBNote\fR -.ps -1 -.br -If several files are specified on the command line, all data will be saved into only one file\&. This behaviour may change in the future\&. -.sp .5v -.RE -.RE -.PP -\fB\-t\fR, \fB\-\-create\-breaks\fR -.RS 4 -Create breaks in track between points with a difference more than the number of seconds specified by the -\fBPAUSE_LIMIT\fR -variable\&. -.RE -.PP -\fB\-T \fR\fB\fIx\fR\fR, \fB\-\-time\-shift \fR\fB\fIx\fR\fR -.RS 4 -Move timestamps -\fIx\fR -seconds forwards or backwards in output\&. -\fIx\fR -can be a positive or negative integer\&. -.RE -.PP -\fB\-v\fR, \fB\-\-verbose\fR -.RS 4 -Verbose output, can be repeated\&. -.RE -.PP -\fB\-\-version\fR -.RS 4 -Print program version information\&. -.RE -.PP -\fB\-w\fR, \fB\-\-strip\-whitespace\fR -.RS 4 -Strip all unnecessary whitespace\&. -.RE -.PP -\fB\-y\fR, \fB\-\-double\-y\-scale\fR -.RS 4 -Double Y scale (latitude)\&. -.RE -.PP -\fB\-\-debug\fR -.RS 4 -Print debugging messages\&. -.RE -.SH "BUGS AND THINGS THAT NEED TO BE DONE" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Pretty incomplete in some areas\&. Some of the source formats are undocumented and thus incomplete\&. Some functionality is not working properly, for example the Postscript output\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Remove hardcodings\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Translate database column names to English\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Add more tests to cover all command\-line options\&. -.RE -.SH "AUTHOR" -.PP -Made by -Øyvind A\&. Holm -sunny@sunbase\&.org\&. -.SH "COPYRIGHT" -.PP -Copyleft \(co -Øyvind A\&. Holm -sunny@sunbase\&.org\&. This is free software; see the file -COPYING -for legalese stuff\&. -.SH "LICENSE" -.PP -This program is free software: you can redistribute it and/or modify it under the terms of the -GNU General Public License -as published by the -Free Software Foundation, either version 3 of the License, or (at your option) any later version\&. -.PP -This program is distributed in the hope that it will be useful, but -\fIWITHOUT ANY WARRANTY\fR; without even the implied warranty of -\fIMERCHANTABILITY\fR -or -\fIFITNESS FOR A PARTICULAR PURPOSE\fR\&. See the GNU General Public License for more details\&. -.PP -You should have received a copy of the GNU General Public License along with this program\&. If not, see -\m[blue]\fB\%http://www.gnu.org/licenses/\fR\m[]\&. -.SH "SEE ALSO" -.PP -\fBgpsbabel\fR(1) diff --git a/doc/gpst.html b/doc/gpst.html deleted file mode 100644 index ee2d6fd..0000000 --- a/doc/gpst.html +++ /dev/null @@ -1,127 +0,0 @@ - - -gpst

Name

gpst — Converts between various GPS formats.

Synopsis

gpst [ - options - ] [ - file - ...]

gpst {-S} [ - options - ] [ - file - ...]

Description

--chronology

Check for broken chronology, warn about entries with an - old timestamp.

-d, --skip-dups

If succeeding identical coordinates are found, print - only the first one and ignore the rest.

-e, --epoch

Use seconds since 1970-01-01 00:00:00 GMT as date - format.

--fix

Comment out entries which is obviously wrong. - Use together with --chronology to fix those - kind of errors. - Does not work with GPX output yet.

--from-date - x

Used by the pgwupd format. - Specifies from which date waypoints should be updated. - No checks for valid date format here, let - PostgreSQL take care of that. - All variants it understands can be used here.

-h, --help

Send a brief help summary to stdout.

--inside

Print only trackpoints inside a rectangle specified by - --pos1 and --pos2.

-n, --undefined - x

Use x as undefined - value.

--near

Add names of the three closest waypoints to the - trackpoint. - Unfinished and experimental, needs gpsbabel(1), which is called from - the program as - /usr/local/bin/gpsbabel.

-o, --output-format - x

Use output format x:

clean

TAB-separated format with longitude, latitude and - altitude.

csv

TAB-separated format: -

date

Date of trackpoint. - Format: - yyyy-mm-ddThh:mm:ssZ - unless the --epoch option is - specified. - If so, it’s represented as number of seconds since - 1970-01-01 00:00:00 UTC.

longitude

Longitude, decimal degrees.

latitude

Latitude, decimal degrees.

altitude

Altitude in metres above sea level. - Optional. - If not present, the corresponding TAB is also - printed, to keep the number of columns - intact.

gpsml (Default)

Line-based XML which makes it easy to edit and - grep. - In the past, there was this big plan about making this - the default storage format, so it was declared as The - Honourable Default Output Format. - But using GPX is the way to go, so this will probably - change in the future. - It’s way too de facto and - widely used, so storing GPS data in anything else is - sheer waste of work. - Probably not finished yet.

gpstrans

The format generated by gpstrans(1).

gpx

Not complete yet, but good enough in most - cases.

pgtab

TAB-separated format for import into - PostgreSQL. - Undefined values are written as \N if - the --undefined option is not - specified.

date

Format: - yyyy-mm-ddThh:mm:ssZ

coor

Format: - (lat,lon)

ele

Altitude in metres above sea level.

name

Short name of closest waypoint. - Calculated in - PostgreSQL, so this - value is always \N.

dist

Distance in decimal degrees to closest - waypoint. - Calculated in - PostgreSQL, so this - value is always \N.

description

Description of waypoint. - Calculated in - PostgreSQL, so this - value is always \N.

pgwtab

Output waypoints on a TAB-separated format:

coor

Format: - (lat,lon)

name

Title of waypoint.

ele

Elevation in metres above sea level.

type

Type of waypoint, same as the GPX <type> element.

time

Timestamp of waypoint.

cmt

Short waypoint description, used by the GPS - as a comment. - Same as the GPX <cmt> element.

descr

Long description, not used by the GPS. - Same as the GPX <desc> element.

src

Source of data, same as the <src> GPX element.

sym

GPS symbol name. - Same as the <sym> GPX element.

pgwupd

Output waypoints as SQL transactions which updates - the name and - dist columns.

poscount

Creates a 3D plot where areas with many - trackpoints are higher than areas with less track - points.

ps

Postscript. Unfinished.

svg

Unfinished.

xgraph

Input format for xgraph(1).

ygraph

Input format for ygraph(1).

--outside

Print only trackpoints outside a rectangle specified by - --pos1 and --pos2.

--pos1 - x1,y1, --pos2 - x2,y2

Specifies corners of an area rectangle used by the - --inside and --outside - options. - The x and - y values are specified as decimal - degrees, negative for west or south.

-r, --require - x

Specify requirements for trackpoints to be written. - x is a string with the following - flags:

e

Print only waypoints which have an - elevation.

p

Print only waypoints which have a position.

t

Print only waypoints which have a - timestamp.

-R, --round - x=y[,x2=y2[...]]

Round trackpoint element x to - y decimals.

Example:

--round lat=4,lon=5,ele=1

-s, --short-date

Use short date format.

-S, --save-to-file - x

Save the unconverted data to a file with a filename - starting with the timestamp of the first trackpoint. - The parameter string x is added at - the end of the filename. - For the time being this option will ignore all other - options.

Note

If several files are specified on the command line, - all data will be saved into only one file. - This behaviour may change in the future.

-t, - --create-breaks

Create breaks in track between points with a difference - more than the number of seconds specified by the - PAUSE_LIMIT variable.

-T x, - --time-shift - x

Move timestamps x seconds - forwards or backwards in output. - x can be a positive or negative - integer.

-v, --verbose

Verbose output, can be repeated.

--version

Print program version information.

-w, - --strip-whitespace

Strip all unnecessary whitespace.

-y, - --double-y-scale

Double Y scale (latitude).

--debug

Print debugging messages.

Bugs and things that need to be done

  • Pretty incomplete in some areas. - Some of the source formats are undocumented and thus incomplete. - Some functionality is not working properly, for example the - Postscript output.

  • Remove hardcodings.

  • Translate database column names to English.

  • Add more tests to cover all command-line options.

Author

Made by Øyvind A. Holm - .

Copyright

Copyleft © Øyvind A. Holm - . - This is free software; see the file COPYING for - legalese stuff.

License

This program is free software: you can redistribute it and/or - modify it under the terms of the GNU General Public - License as published by the Free Software Foundation, either version - 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be - useful, but WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or - FITNESS FOR A PARTICULAR PURPOSE. - See the GNU General Public License for more details.

You should have received a copy of the GNU General Public - License along with this program. - If not, see http://www.gnu.org/licenses/.

See also

gpsbabel(1)

-- 2.11.4.GIT