aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Burwell <ben@benburwell.com>2020-02-06 15:04:34 -0500
committerBen Burwell <ben@benburwell.com>2020-02-06 15:04:34 -0500
commit8e1d9f44b2b2bc4031693855478f7201a7681053 (patch)
tree02e42178a5cbc42dacea9a47e79bff685a60011d /doc
parent6baa9b5f53393171afdf3ebff7e6f4e505b0f57b (diff)
improve docsHEADmaster
Diffstat (limited to 'doc')
-rw-r--r--doc/wx.1.scd62
1 files changed, 59 insertions, 3 deletions
diff --git a/doc/wx.1.scd b/doc/wx.1.scd
index 1b452d8..a11f65c 100644
--- a/doc/wx.1.scd
+++ b/doc/wx.1.scd
@@ -2,7 +2,7 @@ wx(1)
# NAME
-wx - a front-end CLI for NOAA Aviation Weather Center data
+wx - a command line interface for aviation weather
# SYNOPSIS
@@ -10,5 +10,61 @@ wx _command_
# COMMANDS
-*metar*
- fetch METAR data
+*metar* [_station_ ...]
+ fetch METAR data for _station_
+
+# METAR
+
+When fetching METARs, a time constraint must be supplied. A time constraint can
+either be in the form "past x" or "between x and y".
+
+Options:
+
+*--past* _duration_
+ fetch METARs from the past _duration_, formatted as a Go duration string
+ (e.g. _3h_).
+
+ *Default:* 1h
+
+*--since* _time_
+ fetch METARs since _time_, formatted as YYYY-MM-DDTHH:MM:SS
+
+*--until* _time_
+ fetch METARs until _time_, formatted as YYYY-MM-DDTHH:MM:SS
+
+*--rect* _minLat_,_minLon_,_maxLat_,_maxLon_
+ fetch METARs within the specified rectangle
+
+*--radial* _dist_,_lat_,_lon_
+ fetch METARs within _dist_ statute miles of the specified point
+
+*--path-dist* _dist_
+ when used with *--waypoint*, specify a maximum distance around the flight
+ path in which to fetch METARs.
+
+*--waypoint* _point_
+ fetch METARs along a flight path specified by multiple *--waypoint* arguments
+ in order from origin to destination. The _point_ may be either an ICAO
+ identifier or a lon,lat pair.
+
+*--min-dist* _dist_
+ when fetching METARs from multiple sources, enforce a minimum distance of
+ _dist_ degrees of latitude or longitude between stations to reduce the
+ density.
+
+*--most-recent*
+ fetch only the single most recent METAR that matches the station filters.
+
+*--most-recent-by-station* _type_
+ fetch the most recent METAR for each station that matches using _type_ as the
+ filter type, which can be one of constraint, postfilter, or false.
+
+ See _https://www.aviationweather.gov/dataserver/example?datatype=metar_ for
+ information about these options.
+
+ *Default:* constraint
+
+# AUTHORS
+
+Ben Burwell <wx@benburwell.com>. For more information, see
+_https://git.sr.ht/~benburwell/wxcli_.