Imported from archive.
[weather.git] / weatherrc.5
1 .TH WEATHERRC 5 "March 26, 2006"
2 .SH NAME
3 weatherrc \- configuration file format for the
4 .BR weather (1)
5 utility
6 .SH DESCRIPTION
7 The weatherrc file format is intended to specify a set of macros
8 by which to group a METAR station ID for current conditions data with a
9 city/state combination for a forecast, but many of the other
10 command\-line options/flags for the weather utility can be specified as
11 well. The file is organized as an INI-format config, with the alias name
12 in [] brackets and the associated parameter/value pairs on following
13 lines. Parameters and their values as separated by = or : characters.
14 Multi-word values do not need quoting.
15 .SH PARAMETERS
16 These parameters are supported...
17 .TP
18 .B city
19 the city name (ex: Raleigh Durham)
20 .TP
21 .B forecast
22 include a local forecast (possible values are False and True or 0 and 1)
23 .TP
24 .B id
25 the METAR station ID (ex: KRDU)
26 .TP
27 .B conditions
28 output current conditions (possible values are False and True or 0 and 1)
29 .TP
30 .B st
31 the state abbreviation (ex: NC)
32 .TP
33 .B verbose
34 show full decoded feeds (possible values are False and True or 0 and 1)
35 .SH EXAMPLES
36 Following is an example
37 .B ~/.weatherrc
38 defining the default settings to be used when running the utility with no
39 aliases specified, and a couple definitions for aliases named home and
40 work...
41 .P
42 .RS
43 [default]
44 .br
45 City = Asheville
46 .br
47 Forecast = True
48 .br
49 ID = KAVL
50 .br
51 St = NC
52 .P
53 [home]
54 .br
55 City = Raleigh Durham
56 .br
57 ID = KRDU
58 .br
59 St = NC
60 .P
61 [work]
62 .br
63 City = Greensboro
64 .br
65 ID = KGSO
66 .br
67 St = NC
68 .RE
69 .SH SEE ALSO
70 .BR weather (1)
71 .SH AUTHOR
72 Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.