-.TH WEATHERRC 5 "March 15, 2010" "" \" -*- nroff -*-
-\" Copyright (c) 2006-2010 Jeremy Stanley <fungi@yuggoth.org>.
+.TH weatherrc 5 "2012\-06\-24" "2.0" \" -*- nroff -*-
+\" Copyright (c) 2006-2012 Jeremy Stanley <fungi@yuggoth.org>.
\" Permission to use, copy, modify, and distribute this software is
\" granted under terms provided in the LICENSE file distributed with
\" this software.
.BR weather (1)
utility
.SH DESCRIPTION
-The weatherrc file format is intended to specify a set of macros
-by which to group a METAR station ID for current conditions data with a
-city/state combination for a forecast, but many of the other
-command\-line options and flags for the weather utility can be specified
-as well. The file is organized as an INI-format config, with the alias
-name in [] brackets and the associated parameter/value pairs on following
-lines. Parameters and their values as separated by = or : characters.
+.
+The \fIweatherrc\fR file format is intended to specify a set of aliases
+by which to group URIs for METAR station conditions and alert/forecast
+zones, but other command-line options and flags for the weather utility
+can be specified as well.
+.
+The file is organized as an INI-format config, with the alias name in []
+brackets and the associated parameter/value pairs on following lines.
+.
+Parameters and their values are separated by = or : characters.
+.
Multi-word values do not need quoting.
-.SH PARAMETERS
+.
These parameters are supported...
.TP
.B alert
-include local alert notices
+include local alert notices (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
.B atypes
-alert notification types to display
+list of alert notification types to display (ex:
+.BR tornado_warning,urgent_weather_message )
.TP
-.B aurl
-alert URL (including %atype% and %zone%)
+.B cache
+control all caching (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
-.B city
-the city name (ex: Raleigh Durham)
+.B cache_data
+control retrieved data caching (possible values are
+.BR False " and " True " or " 0 " and " 1 )
+.TP
+.B cache_search
+control search result caching (possible values are
+.BR False " and " True " or " 0 " and " 1 )
+.TP
+.B cacheage
+duration in seconds to refresh cached data (ex:
+.BR 900 )
+.TP
+.B cachedir
+directory for storing cached searches and data (ex:
+.BR ~/.weather )
.TP
.B conditions
-output current conditions (possible values are False and True or 0 and 1)
+output current conditions (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
-.B flines
-maximum number of forecast lines to show (integer value, 0 means unlimited)
+.B defargs
+list of default command-line arguments (ex:
+.BR avl,rdu )
.TP
.B forecast
-include a local forecast (possible values are False and True or 0 and 1)
-.TP
-.B furl
-forecast URL (ex: http://forecast.org/%st%/%city%.txt)
+include a local forecast (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
.B headers
-the conditions headers to display (ex: temperature,wind)
-.TP
-.B id
-the METAR station ID (ex: KRDU)
+list of conditions headers to display (ex:
+.BR temperature,wind )
.TP
.B imperial
-filter/convert for US/UK units
+filter/convert conditions for US/UK units (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
.B metric
-filter/convert for metric units
-.TP
-.B murl
-METAR URL (ex: http://metar.org/%id%.txt)
+filter/convert conditions for metric units (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
.B quiet
-skip preambles and don't indent (possible values are False and True or 0 and 1)
+skip preambles and don't indent (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.TP
-.B st
-the state abbreviation (ex: NC)
+.B setpath
+directory search path for correlation sets (ex:
+.BR .:~/.weather )
.TP
.B verbose
-show full decoded feeds (possible values are False and True or 0 and 1)
-.TP
-.B zones
-alert zones (ex: nc/ncc183,nc/ncz041)
-.SH URL FORMAT
-The placeholders %city% and %st% in the furl URL and %id% in the murl URL
-will be replaced with the city, st and id definitions respectively. If the
-placeholder has all letters lowercased, the replacement will be forced to
-all lowercase. If the placeholder has all letters uppercased, the
-replacement will be forced to all uppercase. If the placeholder has its
-first letter uppercased and the remainder lowercased, then all words in the
-replacement will start with an uppercase letter and the rest will be
-lowercase. If the placeholder has its last letter uppercased and the
-remainder lowercased, then case will be preserved in the replacement. Also,
-after replacement, any spaces in the resulting URL will be converted to
-underscore characters prior to use.
+show full decoded feeds (possible values are
+.BR False " and " True " or " 0 " and " 1 )
.SH EXAMPLES
-Following is an example
-.B ~/.weatherrc
-defining the default settings to be used when running the utility with no
-aliases specified, and a couple definitions for aliases named home and
-work...
+The following is an example \fI~/.weather/weatherrc\fR defining a couple
+aliases named home and work to be displayed when running the utility
+with no aliases specified...
.P
-.RS
+.in 0
+.nf
[default]
-.br
-City = Asheville
-.br
-Forecast = True
-.br
-ID = KAVL
-.br
-St = NC
-.P
+defargs = home,work
+
[home]
-.br
-City = Raleigh Durham
-.br
-ID = KRDU
-.br
-St = NC
-.P
+description = Conditions and Forecast at Home
+forecast = True
+metar = http://weather.noaa.gov/pub/data/observations/metar/decoded/KRDU.TXT
+zone_forecast = http://weather.noaa.gov/pub/data/forecasts/zone/nc/ncz041.txt
+
[work]
-.br
-City = Greensboro
-.br
-ID = KGSO
-.br
-St = NC
-.RE
-.SH SEE ALSO
-.BR weather (1)
+description = Conditions at Work
+metar = http://weather.noaa.gov/pub/data/observations/metar/decoded/KGSO.TXT
+.fi
+.P
+Now if
+.B weather is invoked by itself on the command line, it will output
+conditions for home and work, and also a forecast for home only.
.SH AUTHOR
Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.
+.SH SEE ALSO
+.BR weather (1)
projects / weather.git / blobdiff