aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-04-19 17:18:52 +0200
committerMattias Andrée <maandree@kth.se>2016-04-19 17:18:52 +0200
commit539bc7a01aa9d018a15713cbdfa8007ddd3c772c (patch)
treeaf4b10aae265f0be5145ce2a76e1685251f0f4f3
parentadd makefile (diff)
downloadmetar-539bc7a01aa9d018a15713cbdfa8007ddd3c772c.tar.gz
metar-539bc7a01aa9d018a15713cbdfa8007ddd3c772c.tar.bz2
metar-539bc7a01aa9d018a15713cbdfa8007ddd3c772c.tar.xz
update doc
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--README20
-rw-r--r--metar.132
2 files changed, 46 insertions, 6 deletions
diff --git a/README b/README
index 2926e4d..dc4b063 100644
--- a/README
+++ b/README
@@ -6,7 +6,7 @@ SYNOPSIS
metar print
metar set STATION
metar list [PREFIX]
- metar closest LATITUDE LONGITUDE [LIST]
+ metar closest [LATITUDE LONGITUDE] [LIST]
DESCRIPTION
metar is a simple utility for find whether stations (hence referred to
@@ -49,11 +49,13 @@ ACTIONS
name, country, ICAO station identifier, and location. The
ICAO station identifier is in parenthesis.
- closest LATITUDE LONGITUDE [LIST]
+ closest [LATITUDE LONGITUDE] [LIST]
Given a LATITUDE and LONGITUDE in decimal format, print the
ICAO station identifier of the closest METAR station. If you
have already created a list of all stations using the action
list, specify the filename of that list as the LIST argument.
+ If LATITUDE and LONGITUDE are omitted, ~/.config/geolocation,
+ or /etc/geolocation, is used.
FILES
~/.config/metar
@@ -69,6 +71,20 @@ FILES
Fallback file use if ~/.config/metar is missing. Other
programs are encouraged to use this file too.
+ ~/config/geolocation
+ Used to get your location in case 'metar closest' is invoked
+ without LATITUDE and LONGITUDE. This file contains your
+ geographical location using the Global Positioning System in
+ decimal format. This will never change. Other programs are
+ encouraged to use this file too.
+
+ If the file contains more than one line, only the first line,
+ even if it is empty, is used.
+
+ /etc/geolocation
+ Fallback file use if ~/.config/geolocation is missing. Other
+ programs are encouraged to use this file too.
+
NOTES
US Americans, remember, you are on the Western Hemisphere. Therefore,
you should specify a negative longitude when using the action closest.
diff --git a/metar.1 b/metar.1
index 35ef30c..ec5de4c 100644
--- a/metar.1
+++ b/metar.1
@@ -18,8 +18,8 @@ list
.br
.B metar
closest
-.I LATITUDE
-.I LONGITUDE
+.RI [ LATITUDE
+.IR LONGITUDE ]
.RI [ LIST ]
.SH "DESCRIPTION"
.B metar
@@ -73,7 +73,7 @@ Each station is will be printed on a line, containing the its
name, country, ICAO station identifier, and location. The
ICAO station identifier is in parenthesis.
.TP
-\fBclosest\fP \fILATITUDE\fP \fILONGITUDE\fP [\fILIST\fP]
+\fBclosest\fP [\fILATITUDE\fP \fILONGITUDE\fP] [\fILIST\fP]
Given a
.I LATITUDE
and
@@ -83,7 +83,12 @@ closest METAR station. If you have already created a list of
all stations using the action list, specify the filename of
that list as the
.I LIST
-argument.
+argument. If
+.I LATITUDE
+and
+.I LONGITUDE
+are omitted, ~/.config/geolocation, or /etc/geolocation,
+is used.
.SH "FILES"
.TP
~/config/metar
@@ -98,6 +103,25 @@ even if it is empty, is used.
/etc/metar
Fallback file use if ~/.config/metar is missing. Other
programs are encouraged to use this file too.
+.TP
+~/config/geolocation
+Used to get your location in case
+.B metar closest
+is invoked without
+.I LATITUDE
+annd
+.IR LONGITUDE .
+This file contains your geographical location using the Global
+Positioning System in decimal format. This will never change.
+Other programs are encouraged to use this file too.
+
+If the file contains more than one line, only the first line,
+even if it is empty, is used.
+.TP
+/etc/geolocation
+Fallback file use if ~/.config/geolocation is missing. Other
+programs are encouraged to use this file too.
+.TP
.SH "NOTES"
US Americans, remember, you are on the Western Hemisphere. Therefore,
you should specify a negative longitude when using the action closest.