diff --git a/doc/command_options.xml b/doc/command_options.xml index adfa599f..fc0b9240 100644 --- a/doc/command_options.xml +++ b/doc/command_options.xml @@ -30,7 +30,7 @@ Config file to load instead of - ~/.config/conky/conky.conf. + ~/.config/conky/conky.conf. diff --git a/doc/config_settings.xml b/doc/config_settings.xml index 4bab79d1..449bf201 100644 --- a/doc/config_settings.xml +++ b/doc/config_settings.xml @@ -96,8 +96,8 @@ A comma-separated list of strings to use as the bars of a graph output to console/shell. The first list item is used for the - minimum bar height and the last item is used for the maximum, e.g. - " ,_,=,#". + minimum bar height and the last item is used for the maximum, e.g. " + ,_,=,#". @@ -796,7 +796,7 @@ If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (e.g. '#ffffff'), a shorthand hex value (e.g. '#fff'), or a valid RGB name (see - /usr/lib/X11/rgb.txt). + /usr/lib/X11/rgb.txt). diff --git a/doc/docs.xml b/doc/docs.xml index dd5103c9..84f30782 100644 --- a/doc/docs.xml +++ b/doc/docs.xml @@ -127,8 +127,9 @@ you try to make Conky do, the more resources it is going to consume. An easy way to force Conky to reload your - ~/.config/conky/conky.conf: "killall -SIGUSR1 conky". Saves you the - trouble of having to kill and then restart. + ~/.config/conky/conky.conf: "killall -SIGUSR1 + conky". Saves you the trouble of having to kill and then + restart. Options @@ -137,17 +138,21 @@ Configuration Settings Default configuration file location is - $HOME/.config/conky/conky.conf or ${sysconfdir}/conky/conky.conf. On most - systems, sysconfdir is /etc, and you can find the sample config file there - (/etc/conky/conky.conf). - You might want to copy it to $HOME/.config/conky/conky.conf and then - start modifying it. Other configs can be found at - http://conky.sf.net/&config_settings; + ~/.config/conky/conky.conf or + ${sysconfdir}/conky/conky.conf. On most systems, + sysconfdir is /etc, and you can find the sample config file there in + /etc/conky/conky.conf. + You might want to copy it to + ~/.config/conky/conky.conf and then start modifying + it. Other configs can be found at + + https://github.com/brndnmtthws/conky.&config_settings; Objects/Variables Colours are parsed using XParsecolor(), there might be a list of - them: /usr/share/X11/rgb.txt. Colour can be also in #rrggbb format - (hex). + them: + /usr/share/X11/rgb.txt. Colour can be also in #rrggbb + format (hex). Some objects may create threads, and sometimes these threads will not be destroyed until Conky terminates. There is no way to destroy or clean up threads while Conky is running. For example, if you use an MPD @@ -197,7 +202,8 @@ Do not start Conky, but have it output the builtin - default config file to ~/.config/conky/conky.conf for later + default config file to + ~/.config/conky/conky.conf for later customising. @@ -236,7 +242,9 @@ See Also - https://github.com/brndnmtthws/conky + + https://github.com/brndnmtthws/conky + #conky on irc.freenode.net diff --git a/doc/variables.xml b/doc/variables.xml index b9dc51ae..acd2c9be 100644 --- a/doc/variables.xml +++ b/doc/variables.xml @@ -7,9 +7,10 @@ ACPI ac adapter state. On linux, the adapter option - specifies the subfolder of /sys/class/power_supply containing the - state information (tries "AC" and "ADP1" if there is no argument - given). Non-linux systems ignore it. + specifies the subfolder of + /sys/class/power_supply containing the state + information (tries "AC" and "ADP1" if there is no argument given). + Non-linux systems ignore it. @@ -384,7 +385,8 @@ - Title of current tune with optional maximum length specifier. + Title of current tune with optional maximum length + specifier. @@ -575,6 +577,7 @@ PID of the first process that has string in its commandline. + @@ -730,8 +733,8 @@ Change drawing color to 'color' which is a name of a color - or a hexcode preceded with #, e.g. #0A1B2C. If you use ncurses only the - following colors are supported: red, green, yellow, blue, magenta, + or a hexcode preceded with #, e.g. #0A1B2C. If you use ncurses only + the following colors are supported: red, green, yellow, blue, magenta, cyan, black, and white. @@ -983,10 +986,11 @@ The name of the distribution. It could be that some of the untested distributions will show up wrong or as "unknown", if that's the case post a bug on sourceforge, make sure it contains the name of - your distribution, the contents of /proc/version and if there is a - file that only exists on your distribution, also add the path of that - file in the bug. If there is no such file, please add another way - which we can use to identify your distribution. + your distribution, the contents of + /proc/version and if there is a file that + only exists on your distribution, also add the path of that file in + the bug. If there is no such file, please add another way which we can + use to identify your distribution. @@ -1564,11 +1568,11 @@ omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See - /sys/class/hwmon/ on your local computer. The optional arguments - 'factor' and 'offset' allow precalculation of the raw input, which is - being modified as follows: 'input = input * factor + offset'. Note - that they have to be given as decimal values (i.e. contain at least - one decimal place). + /sys/class/hwmon/ on your local computer. + The optional arguments 'factor' and 'offset' allow precalculation of + the raw input, which is being modified as follows: 'input = input * + factor + offset'. Note that they have to be given as decimal values + (i.e. contain at least one decimal place). @@ -1592,11 +1596,11 @@ omitted if you have only one I2C device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See - /sys/bus/i2c/devices/ on your local computer. The optional arguments - 'factor' and 'offset' allow precalculation of the raw input, which is - being modified as follows: 'input = input * factor + offset'. Note - that they have to be given as decimal values (i.e. contain at least - one decimal place). + /sys/bus/i2c/devices/ on your local + computer. The optional arguments 'factor' and 'offset' allow + precalculation of the raw input, which is being modified as follows: + 'input = input * factor + offset'. Note that they have to be given as + decimal values (i.e. contain at least one decimal place). @@ -1872,7 +1876,7 @@ longArgument consists of only digits. - stringArgument is enclosed in quotation marks + stringArgument is enclosed in quotation marks. (") Valid operands are: '>', '<', '>=', '<=', '==', '!='. @@ -2134,7 +2138,8 @@ - The value of /proc/sys/vm/laptop_mode. + The value of + /proc/sys/vm/laptop_mode. @@ -2285,6 +2290,7 @@ Print a summary of recent messages in an mbox format mailbox. mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"} + @@ -3310,7 +3316,8 @@ - The priority of the process (see 'priority' in "man 5 proc"). + The priority of the process (see 'priority' in "man 5 + proc"). @@ -3629,11 +3636,11 @@ omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See - /sys/bus/platform/devices/ on your local computer. The optional - arguments 'factor' and 'offset' allow precalculation of the raw input, - which is being modified as follows: 'input = input * factor + offset'. - Note that they have to be given as decimal values (i.e. contain at - least one decimal place). + /sys/bus/platform/devices/ on your local + computer. The optional arguments 'factor' and 'offset' allow + precalculation of the raw input, which is being modified as follows: + 'input = input * factor + offset'. Note that they have to be given as + decimal values (i.e. contain at least one decimal place). @@ -3828,10 +3835,11 @@ when using smapi, display contents of the - /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or - 'bat (INDEX) (FILENAME)' to display the corresponding files' content. - This is a very raw method of accessing the smapi values. When - available, better use one of the smapi_* variables instead. + /sys/devices/platform/smapi directory. ARGS + are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the + corresponding files' content. This is a very raw method of accessing + the smapi values. When available, better use one of the smapi_* + variables instead. @@ -4620,9 +4628,12 @@ 'locID' must be a valid location identifier for the required uri. For the NOAA site this must be a valid ICAO (see for instance - https://pilotweb.nas.faa.gov/qryhtml/icao/). For the weather.com - site this must be a valid location ID (see for instance - http://aspnetresources.com/tools/locid.aspx). + + https://pilotweb.nas.faa.gov/qryhtml/icao/). + For the weather.com site this must be a valid location ID (see for + instance + + http://aspnetresources.com/tools/locid.aspx). 'data_type' must be one of the following: