X-Git-Url: https://www.yuggoth.org/gitweb?p=weather.git;a=blobdiff_plain;f=weatherrc.5;h=d490d76d74316d285652900d4bf718669a1c258e;hp=987ec34e0c27bb9b4b5c422a835f2ef89991cac1;hb=4d25a49d5a5ec5415f8e83ba26fea5adf4e5512a;hpb=b755668b64a70bb7b0efbf1bd0aff8c310471ee1 diff --git a/weatherrc.5 b/weatherrc.5 index 987ec34..d490d76 100644 --- a/weatherrc.5 +++ b/weatherrc.5 @@ -1,6 +1,8 @@ -.TH WEATHERRC 5 "March 26, 2006" "" \" -*- nroff -*- -\" Copyright (c) 2006 Jeremy Stanley , all rights reserved. -\" Licensed per terms in the LICENSE file distributed with this software. +.TH WEATHERRC 5 "March 15, 2010" "" \" -*- nroff -*- +\" Copyright (c) 2006-2010 Jeremy Stanley . +\" 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) @@ -17,23 +19,68 @@ Multi-word values do not need quoting. .SH PARAMETERS These parameters are supported... .TP +.B alert +include local alert notices +.TP +.B atypes +alert notification types to display +.TP +.B aurl +alert URL (including %atype% and %zone%) +.TP .B city the city name (ex: Raleigh Durham) .TP +.B conditions +output current conditions (possible values are False and True or 0 and 1) +.TP +.B flines +maximum number of forecast lines to show (integer value, 0 means unlimited) +.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) +.TP +.B headers +the conditions headers to display (ex: temperature,wind) +.TP .B id the METAR station ID (ex: KRDU) .TP -.B conditions -output current conditions (possible values are False and True or 0 and 1) +.B imperial +filter/convert for US/UK units +.TP +.B metric +filter/convert for metric units +.TP +.B murl +METAR URL (ex: http://metar.org/%id%.txt) +.TP +.B quiet +skip preambles and don't indent (possible values are False and True or 0 and 1) .TP .B st the state abbreviation (ex: NC) .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. .SH EXAMPLES Following is an example .B ~/.weatherrc