Correct and simplify URLError exception handling
[weather.git] / weatherrc.5
1 .TH weatherrc 5 "2020\-08\-23" "2.4.1" \" -*- nroff -*-
2 \" Copyright (c) 2006-2020 Jeremy Stanley <fungi@yuggoth.org>.
3 \" Permission to use, copy, modify, and distribute this software is
4 \" granted under terms provided in the LICENSE file distributed with
5 \" this software.
6 .SH NAME
7 weatherrc \- configuration file format for the
8 .BR weather (1)
9 utility
10 .SH DESCRIPTION
11 .
12 The \fIweatherrc\fR file format is intended to specify a set of aliases
13 by which to group URIs for METAR station conditions and alert/forecast
14 zones, but other command-line options and flags for the weather utility
15 can be specified as well.
16 .
17 The file is organized as an INI-format config, with the alias name in []
18 brackets and the associated parameter/value pairs on following lines.
19 .
20 Parameters and their values are separated by = or : characters.
21 .
22 Multi-word values do not need quoting.
23 .
24 These parameters are supported...
25 .TP
26 .B alert
27 include local alert notices (possible values are
28 .BR False " and " True " or " 0 " and " 1 )
29 .TP
30 .B atypes
31 list of alert notification types to display (ex:
32 .BR tornado_warning,urgent_weather_message )
33 .TP
34 .B cache
35 control all caching (possible values are
36 .BR False " and " True " or " 0 " and " 1 )
37 .TP
38 .B cache_data
39 control retrieved data caching (possible values are
40 .BR False " and " True " or " 0 " and " 1 )
41 .TP
42 .B cache_search
43 control search result caching (possible values are
44 .BR False " and " True " or " 0 " and " 1 )
45 .TP
46 .B cacheage
47 duration in seconds to refresh cached data (ex:
48 .BR 900 )
49 .TP
50 .B cachedir
51 directory for storing cached searches and data (ex:
52 .BR ~/.weather )
53 .TP
54 .B conditions
55 output current conditions (possible values are
56 .BR False " and " True " or " 0 " and " 1 )
57 .TP
58 .B defargs
59 list of default command-line arguments (ex:
60 .BR avl,rdu )
61 .TP
62 .B forecast
63 include a local forecast (possible values are
64 .BR False " and " True " or " 0 " and " 1 )
65 .TP
66 .B headers
67 list of conditions headers to display (ex:
68 .BR temperature,wind )
69 .TP
70 .B imperial
71 filter/convert conditions for US/UK units (possible values are
72 .BR False " and " True " or " 0 " and " 1 )
73 .TP
74 .B metric
75 filter/convert conditions for metric units (possible values are
76 .BR False " and " True " or " 0 " and " 1 )
77 .TP
78 .B quiet
79 skip preambles and don't indent (possible values are
80 .BR False " and " True " or " 0 " and " 1 )
81 .TP
82 .B setpath
83 directory search path for correlation sets (ex:
84 .BR .:~/.weather )
85 .TP
86 .B verbose
87 show full decoded feeds (possible values are
88 .BR False " and " True " or " 0 " and " 1 )
89 .SH EXAMPLES
90 The following is an example \fI~/.weather/weatherrc\fR defining a couple
91 aliases named home and work to be displayed when running the utility
92 with no aliases specified...
93 .P
94 .in 0
95 .nf
96 [default]
97 defargs = home,work
98
99 [home]
100 description = Conditions and Forecast at Home
101 forecast = True
102 metar = http://tgftp.nws.noaa.gov/data/observations/metar/decoded/KRDU.TXT
103 zone_forecast = http://tgftp.nws.noaa.gov/data/forecasts/zone/nc/ncz041.txt
104
105 [work]
106 description = Conditions at Work
107 metar = http://tgftp.nws.noaa.gov/data/observations/metar/decoded/KGSO.TXT
108 .fi
109 .P
110 Now if
111 .B weather is invoked by itself on the command line, it will output
112 conditions for home and work, and also a forecast for home only.
113 .SH AUTHOR
114 Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.
115 .SH SEE ALSO
116 .BR weather (1)