Add FAQ entry about --headers values

Be as clear as possible about what the --headers command-line option
or headers configuration option does, and what sorts of values are
valid for it.
This commit is contained in:
Jeremy Stanley
2017-09-16 15:47:03 +00:00
parent 2a84a53f4a
commit 1ec2848c20

24
FAQ
View File

@@ -2,7 +2,7 @@
Frequently Asked Questions About the Weather Utility Frequently Asked Questions About the Weather Utility
====================================================== ======================================================
:Copyright: (c) 2006-2012 Jeremy Stanley <fungi@yuggoth.org>. Permission :Copyright: (c) 2006-2017 Jeremy Stanley <fungi@yuggoth.org>. Permission
to use, copy, modify, and distribute this software is to use, copy, modify, and distribute this software is
granted under terms provided in the LICENSE file distributed granted under terms provided in the LICENSE file distributed
with this software. with this software.
@@ -54,3 +54,25 @@ As of the 2.0 release, this question is no longer relevant.
--------------------------------------------------------------- ---------------------------------------------------------------
As of the 2.0 release, this is no longer necessary. See FAQ entries #2 As of the 2.0 release, this is no longer necessary. See FAQ entries #2
and #3 for more detail. and #3 for more detail.
7. What values are valid for a --headers list?
----------------------------------------------
The default set it uses if you don't override it yourself on the command
line or in configuration is as follows::
heat_index
precipitation_last_hour
relative_humidity
sky_conditions
temperature
weather
wind
windchill
These are a case-insensitive match against the start of lines in a
decoded METAR up to the first colon (:) with underscores (_) replaced by
spaces. You can see the full METAR for a given condition report by
passing --verbose or by observing one directly (perhaps by looking in
your *datacache* directory). Unfortunately I haven't found any proper
specification for the decoded METAR format used by the NWS so know of no
comprehensive list of what lines might appear.