.TH weatherrc 5 "2016\-11\-08" "2.3" \" -*- nroff -*-
\" Copyright (c) 2006-2016 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.
.SH NAME
weatherrc \- configuration file format for the
.BR weather (1)
utility
.SH DESCRIPTION
.
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.
.
These parameters are supported...
.TP
.B alert
include local alert notices (possible values are
.BR False " and " True " or " 0 " and " 1 )
.TP
.B atypes
list of alert notification types to display (ex:
.BR tornado_warning,urgent_weather_message )
.TP
.B cache
control all caching (possible values are
.BR False " and " True " or " 0 " and " 1 )
.TP
.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
.BR False " and " True " or " 0 " and " 1 )
.TP
.B defargs
list of default command-line arguments (ex:
.BR avl,rdu )
.TP
.B forecast
include a local forecast (possible values are
.BR False " and " True " or " 0 " and " 1 )
.TP
.B headers
list of conditions headers to display (ex:
.BR temperature,wind )
.TP
.B imperial
filter/convert conditions for US/UK units (possible values are
.BR False " and " True " or " 0 " and " 1 )
.TP
.B metric
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
.BR False " and " True " or " 0 " and " 1 )
.TP
.B setpath
directory search path for correlation sets (ex:
.BR .:~/.weather )
.TP
.B verbose
show full decoded feeds (possible values are
.BR False " and " True " or " 0 " and " 1 )
.SH EXAMPLES
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
.in 0
.nf
[default]
defargs = home,work

[home]
description = Conditions and Forecast at Home
forecast = True
metar = http://tgftp.nws.noaa.gov/data/observations/metar/decoded/KRDU.TXT
zone_forecast = http://tgftp.nws.noaa.gov/data/forecasts/zone/nc/ncz041.txt

[work]
description = Conditions at Work
metar = http://tgftp.nws.noaa.gov/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)