Commits

Paramvir Likhari committed f5638a0

Edited online

Comments (0)

Files changed (1)

 ----
 = NAME =
 
-**conkywx** − Program to display weather information using conky
+* **conkywx** − Program to display weather information using conky
 
 = SYNOPSIS =
 
-**conkywx** [-c or --config with path] [-t or --template with path] **\\  conkywx** [-c or --config with path] [-d or --data element]
+* **conkywx** [-c or --config with path] [-t or --template with path] **\\  conkywx** [-c or --config with path] [-d or --data element]
 
-**conkywx** without options or parameters will launch **Conkywx Weather Program Assistant**  
+* **conkywx** without options or parameters will launch **Conkywx Weather Program Assistant**  
 
 = DESCRIPTION =
 
-**conkywx** gets the weather data from wunderground website and displays the information using conky. This just helps in not having a web page open all the time. Having the web page open has it’s own benefits since not all the information is available here.
+* **conkywx** gets the weather data from wunderground website and displays the information using conky. This just helps in not having a web page open all the time. Having the web page open has it’s own benefits since not all the information is available here.
 
-I have used other weather programs but all RSS or json feeds are too limited - one has to refer to the data on the web pages. Thus we have a solution which gets the job done in bash script. Like I have read many places bash script is quite under rated - but is very powerful if you can get a handle on it.
+* I have used other weather programs but all RSS or json feeds are too limited - one has to refer to the data on the web pages. Thus we have a solution which gets the job done in bash script. Like I have read many places bash script is quite under rated - but is very powerful if you can get a handle on it.
 
-The program does it’s own calculations for:
-* Trends
-* UV condition text ( Low High etc )
-* Feels like or apparent temperature also known as heat index.
+* The program does it’s own calculations for:
+** Trends
+** UV condition text ( Low High etc )
+** Feels like or apparent temperature also known as heat index.
 
-Conkywx will automatically check once every 24 hours for new release of conkywx.
+*Conkywx will automatically check once every 24 hours for new release of conkywx.
 
 
 ----
 * Make changes to conkywx.conf to suit your Location, xml_ID etc - be guided by the [[Home#!config-file-options|CONFIG FILE OPTIONS]] section in this wiki.
 * There are many examples located in the examples directory in conkywx directory. Since the preferred usage is to make use of template files - you will find 2 files associated to each template - a *conkyrc.sh and a *template.sh file.
 * If you are using Gnome 3 - own_window_type in the *conkyrc.sh needs to be changed to normal
-* If you specify the full path of the config file with the **-c** option then the config file can reside anywhere - otherwise the default locations can be any one of these directories {{{ /etc/conkywx, ~/.config/conkywx or conkywx }}}
+* If you specify the full path of the config file with the **-c** option then the config file can reside anywhere - otherwise the default locations can be any one of these directories {{{ /etc/conkywx or ~/.config/conkywx or conkywx }}}
 
 
 ----
 
 **-c, --config**
 
-The default config file is located at /etc/conkywx/conkywx.conf For normal usage this file can be used with changes to Location and if you want to use the xml - near real time updates.
+* The default config file is located at /etc/conkywx/conkywx.conf For normal usage this file can be used with changes to Location and if you want to use the xml - near real time updates.
 
-To use multiple locations - multiple conky config files can be used - but - you will also need separate conkyrc and template files.
+* To use multiple locations - multiple conky config files can be used - but - you will also need separate conkyrc and template files.
 
-Interestingly if you combine -c with -d you can have multiple locations updated in one conkyrc.
+* Interestingly if you combine -c with -d you can have multiple locations updated in one conkyrc.
 
-A copy can be made of the default config file and placed in your home sub directory and a path to this file can be given with -c option.
+* A copy can be made of the default config file and placed in your home sub directory and a path to this file can be given with -c option.
 
-If you use the conkywx.conf in the /etc/conkywx directory then on upgrade your edited version **remains as is** and the newer/original version is saved as .pacnew by the pacman installer.
+* If you use the conkywx.conf in the /etc/conkywx directory then on upgrade your edited version **remains as is** and the newer/original version is saved as .pacnew by the pacman installer.
 
 **-t, --template**
 
-This program can use the template concept for updating a conky file. This is not to be confused with conky’s own in built user variable **template.** The benifits are that less code for the conkyrc file and the update is in one burst using a single call to **execpi.**
+* This program can use the template concept for updating a conky file. This is not to be confused with conky’s own in built user variable **template.** The benifits are that less code for the conkyrc file and the update is in one burst using a single call to **execpi.**
 
-Template files are the same data that you would normally place in a conkyrc file but here you place it in a separate file and give its location in the conkyrc file - see the example folder. This gets rid of putting execpi call for each element that needs to be called and then shown. Using execpi is also said to be a huge resource hog as per the conky usage wiki.
+* Template files are the same data that you would normally place in a conkyrc file but here you place it in a separate file and give its location in the conkyrc file - see the example folder. This gets rid of putting execpi call for each element that needs to be called and then shown. Using execpi is also said to be a huge resource hog as per the conky usage wiki.
 
-Each weather element to be placed in square brackets like so [BF] for Bearing font character. Look in the example directory for ideas - but it will be like {{{ ${image [PIC] -p 12,20 -s 100x100} }}} - the [PIC] will be automatially be replaced by the full path of the image.
+* Each weather element to be placed in square brackets like so [BF] for Bearing font character. Look in the example directory for ideas - but it will be like {{{ ${image [PIC] -p 12,20 -s 100x100} }}} - the [PIC] will be automatially be replaced by the full path of the image.
 
 **-d, --data**
 
-This program can also use individual data elements in the conkyrc directly by placing element after -d or --data.
+* This program can also use individual data elements in the conkyrc directly by placing element after -d or --data.
 
-Multiple locations can also be checked by placing a separate config file for each required element in one conkyrc.
+* Multiple locations can also be checked by placing a separate config file for each required element in one conkyrc.
 
-See examples below.
+* See examples below.
 
-**NOTE:** Using single -d or --data elements could be slow on some systems.
+**Notes:** 
 
-Square brackets "[]" are only required in templates - where -d option is used no square brackets to be used.
+* Using single -d or --data elements could be slow on some systems.
 
-The template statement line has to be the LAST line below the TEXT statement in conkyrc.
+* Square brackets "[]" are only required in templates - where -d option is used no square brackets to be used.
 
-For a list of data elements see below.
+* The template statement line has to be the LAST line below the TEXT statement in conkyrc.
 
-There is no bearing icon set as I have not found the ones I really like and the bearing font with ConkyWindNESW.otf does a fantastic job.
+* For a list of data elements see below.
+
+* There is no bearing icon set as I have not found the ones I really like and the bearing font with ConkyWindNESW.otf does a fantastic job.
 
 ----
 **[[Home#|Go To Top of Page]]**
 
 = CONKYWX WEATHER PROGRAM ASSISTANT =
 
-
-
 This utility is there to assist you in certain tasks which are required under certain conditions. You will need to choose from numbers 1 to 7 as displayed  below.
 
 Available options are:
 
 **xml_ID** 
 
-To get this xml_ID you need to visit the location of your interest which will give you the "Location" url [US] or number [rest of the world] at the bottom of the page you have a listing of private weather station feeding wunderground.
+* To get this xml_ID you need to visit the location of your interest which will give you the "Location" url [US] or number [rest of the world] at the bottom of the page you have a listing of private weather station feeding wunderground.
 
-You will also notice a lot of them - under Type column - have Rapid Fire in green - ideally one of these would make a good choice and you can select one closest to your location.
+* You will also notice a lot of them - under Type column - have Rapid Fire in green - ideally one of these would make a good choice and you can select one closest to your location.
 
-For example Wanneroo, Wanneroo, WESTERN AUSTRALIA URL weather station looks like this:
-{{{
+* For example Wanneroo, Wanneroo, WESTERN AUSTRALIA URL weather station looks like this:
+* {{{
 http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IWESTERN144
 }}}
 The xml_ID required is IWESTERN144
 
-This link was obtained from the Perth, Western Australia web page
-{{{
+* This link was obtained from the Perth, Western Australia web page
+* {{{
 http://www.wunderground.com/global/stations/94610
 }}}
 near the bottom of the web page under the Weather Stations section.
 
 **Location**
 
-Enter the location number from weather underground web 
+* Enter the location number from weather underground web 
 page url - most locations have a location number - BUT some
 do not - like the US sites!!! in which case use the URL and
 set Location to url. 
 
-In our example for Perth, Western Australia 
+* In our example for Perth, Western Australia {{{http://www.wunderground.com/global/stations/94610}}} - Location=94610
 
-http://www.wunderground.com/global/stations/94610
-
-Location=94610
-
-In other cases - since wunderground is dynamically driven site now - the full URL may be required
+* In other cases - since wunderground is dynamically driven site now - the full URL may be required
 
-For example for Scandriglia, Italy something like this works
-{{{
+* For example for Scandriglia, Italy something like this works
+* {{{
 http://www.wunderground.com/cgi-bin/findweather/getForecast?query=Scandriglia
 }}}
-Use the full URL
-{{{
+* Use the full URL
+* {{{
 Location=http://www.wunderground.com/cgi-bin/findweather/getForecast?query=Scandriglia
 }}}
 
-Location=url OR Location=number
+* Location=url OR Location=number
 
-Use only one location per config file! for more than one location - create a new config file and give the path to it with a -c command line option there are some test cases listed in the config file - just ensure only one location is uncommented. The lowest uncommented Location will be picked up in case more than one is uncommented.
+* Use only one location per config file! for more than one location - create a new config file and give the path to it with a -c command line option there are some test cases listed in the config file - just ensure only one location is uncommented. The lowest uncommented Location will be picked up in case more than one is uncommented.
 
-If you cannot figure out the number just use the full url to that page.
+* If you cannot figure out the number just use the full url to that page.
 
 
 **Units_to_Use**