Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-26 12:27:52 +00:00
Code Issues Releases Activity

Update docs for $if_running.

Browse Source
This commit is contained in:
Brenden Matthews 2009-03-15 22:14:07 -06:00
parent c2b1728af9
commit 21e9964c5a
4 changed files with 273 additions and 271 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
README
View File

@ -4,7 +4,7 @@ conky(1) conky(1)
1mNAME0m
conky - A system monitor for X originally based on the torsmo code, but
more kickass. It just keeps on given’er. Yeah.
more kickass. It just keeps on given'er. Yeah.
1mSYNOPSIS0m
1mconky 22m[4moptions24m]
@ -44,9 +44,9 @@ conky(1) conky(1)
popular distributions. Here are some installation instructions for a
few:
Gentoo users -- Conky is in Gentoo’s Portage... simply use "emerge app-
Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
admin/conky" for installation. There is also usually an up-to-date
ebuild within Conky’s package or in the git repo.
ebuild within Conky's package or in the git repo.
Debian, etc. users -- Conky should be in your repositories, and can be
installed by doing "aptitude install conky".
@ -73,7 +73,6 @@ conky(1) conky(1)
been tested with anything other than gcc, and is not guaranteed to work
with other compilers.
1mYOU SHOULD KNOW0m
Conky is generally very good on resources. That said, the more you try
to make Conky do, the more resources it is going to consume.
@ -91,7 +90,7 @@ conky(1) conky(1)
1m-q | --quiet0m
Run Conky in ’quiet mode’ (ie. no output)
Run Conky in 'quiet mode' (ie. no output)
1m-a | --alignment=ALIGNMENT0m
@ -124,7 +123,7 @@ conky(1) conky(1)
1m-t | --text=TEXT0m
Text to render, remember single quotes, like -t ’ $uptime ’
Text to render, remember single quotes, like -t ' $uptime '
1m-u | --interval=SECONDS0m
@ -155,14 +154,14 @@ conky(1) conky(1)
You might want to copy it to $HOME/.conkyrc and then start modifying
it. Other configs can be found at http://conky.sf.net/
1malias0m
Use this to create aliases of variables. The first argument is
1malias 22mUse this to create aliases of variables. The first argument is
the new name, the second the old name, and the other arguments
are passed on to the variable. Example: If you want to use $alpha
instead of ${beta gamma delta} then you have to write the following:
alias alpha beta gamma delta . PS: Instead of creating an alias
in the config you can also use environment variables. Example:
Start conky like this: alpha="beta gamma delta" conky
are passed on to the variable. Example: If you want to use $al‐
pha instead of ${beta gamma delta} then you have to write the
following: alias alpha beta gamma delta . PS: Instead of creat‐
ing an alias in the config you can also use environment vari‐
ables. Example: Start conky like this: alpha="beta gamma delta"
conky
1malignment0m
@ -195,8 +194,8 @@ conky(1) conky(1)
1mtop_cpu_separate0m
If true, cpu in top will show usage of one processor’s power. If
false, cpu in top will show the usage of all processors’ power
If true, cpu in top will show usage of one processor's power. If
false, cpu in top will show the usage of all processors' power
combined.
@ -209,12 +208,12 @@ conky(1) conky(1)
1mdefault_shade_color0m
Default shading color and border’s shading color
Default shading color and border's shading color
1mdouble_buffer0m
Use the Xdbe extension? (eliminates flicker) It is highly recom‐
mended to use own window with this one so double buffer won’t be
mended to use own window with this one so double buffer won't be
so big.
@ -254,9 +253,9 @@ conky(1) conky(1)
1mimap 22mDefault global IMAP server. Arguments are: "host user pass [-i
interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
fault port is 143, default folder is ’INBOX’, default interval
fault port is 143, default folder is 'INBOX', default interval
is 5 minutes, and default number of retries before giving up is
5. If the password is supplied as ’*’, you will be prompted to
5. If the password is supplied as '*', you will be prompted to
enter the password when Conky starts.
@ -283,7 +282,7 @@ conky(1) conky(1)
Size of the standard text buffer (default is 256 bytes). This
buffer is used for intermediary text, such as individual lines,
output from $exec vars, and various other variables. Increasing
the size of this buffer can drastically reduce Conky’s perfor‐
the size of this buffer can drastically reduce Conky's perfor‐
mance, but will allow for more text display per variable. The
size of this buffer cannot be smaller than the default value of
256 bytes.
@ -310,7 +309,7 @@ conky(1) conky(1)
1mmusic_player_interval0m
Music player thread update interval (defaults to Conky’s update
Music player thread update interval (defaults to Conky's update
interval)
@ -377,7 +376,7 @@ conky(1) conky(1)
1mout_to_x0m
When set to no, there will be no output in X (useful when you
also use things like out_to_console). If you set it to no, make
sure that it’s placed before all other X-related setting (take
sure that it's placed before all other X-related setting (take
the first line of your configfile to be sure). Default value is
yes
@ -397,7 +396,7 @@ conky(1) conky(1)
1mpop3 22mDefault global POP3 server. Arguments are: "host user pass [-i
interval] [-p port] [-e command] [-r retries]". Default port is
110, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
tries before giving up is 5. If the password is supplied as '*',
you will be prompted to enter the password when Conky starts.
@ -430,10 +429,10 @@ conky(1) conky(1)
variable is being inserted into the stuff below TEXT at the cor‐
responding position, but before some substitutions are applied:
’\n’ -> newline
’\\’ -> backslash
’\ ’ -> space
’\N’ -> template argument N
'\n' -> newline
'\\' -> backslash
'\ ' -> space
'\N' -> template argument N
1mtotal_run_times0m
@ -674,7 +673,7 @@ conky(1) conky(1)
1mcpubar (cpu number) (height),(width)0m
Bar that shows CPU usage, height is bar’s height in pixels. See
Bar that shows CPU usage, height is bar's height in pixels. See
$cpu for more info on SMP.
@ -760,7 +759,7 @@ conky(1) conky(1)
1mexec command0m
Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I’d
ing: this takes a lot more resources than other variables. I'd
recommend coding wanted behaviour in C and posting a patch.
@ -778,7 +777,7 @@ conky(1) conky(1)
1mexeci interval command0m
Same as exec but with specific interval. Interval can’t be less
Same as exec but with specific interval. Interval can't be less
than update_interval in configuration. See also $texeci
@ -792,7 +791,7 @@ conky(1) conky(1)
1mexecp command0m
Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I’d
ing: this takes a lot more resources than other variables. I'd
recommend coding wanted behaviour in C and posting a patch. This
differs from $exec in that it parses the output of the command,
so you can insert things like ${color red}hi!${color} in your
@ -805,7 +804,7 @@ conky(1) conky(1)
1mexecpi interval command0m
Same as execp but with specific interval. Interval can’t be less
Same as execp but with specific interval. Interval can't be less
than update_interval in configuration. Note that the output from
the $execpi command is still parsed and evaluated at every in‐
terval.
@ -819,23 +818,23 @@ conky(1) conky(1)
1mfreq (n)0m
Returns CPU #n’s frequency in MHz. CPUs are counted from 1. If
Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mfreq_g (n)0m
Returns CPU #n’s frequency in GHz. CPUs are counted from 1. If
Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mfreq_dyn (n)0m
Returns CPU #n’s frequency in MHz (defaults to 1), but is calcu‐
Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐
lated by counting to clock cycles to complete an instruction.
Only available for x86/amd64.
1mfreq_dyn_g (n)0m
Returns CPU #n’s frequency in GHz (defaults to 1), but is calcu‐
Returns CPU #n's frequency in GHz (defaults to 1), but is calcu‐
lated by counting to clock cycles to complete an instruction.
Only available for x86/amd64.
@ -865,15 +864,15 @@ conky(1) conky(1)
File system used space
1mgoto x 22mThe next element will be printed at position ’x’.
1mgoto x 22mThe next element will be printed at position 'x'.
1mgw_iface0m
Displays the default route’s interface or "multiple"/"none" ac‐
Displays the default route's interface or "multiple"/"none" ac‐
cordingly.
1mgw_ip 22mDisplays the default gateway’s IP or "multiple"/"none" accord‐
1mgw_ip 22mDisplays the default gateway's IP or "multiple"/"none" accord‐
ingly.
@ -885,7 +884,7 @@ conky(1) conky(1)
1mhead logfile lines (interval)0m
Displays first N lines of supplied text text file. If interval
is not supplied, Conky assumes 2x Conky’s interval. Max of 30
is not supplied, Conky assumes 2x Conky's interval. Max of 30
lines can be displayed, or until the text buffer is filled.
@ -896,7 +895,7 @@ conky(1) conky(1)
1mhwmon (dev) type n0m
Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
ted if you have only one hwmon device. Parameter type is either
’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ meaning
'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.
@ -912,8 +911,8 @@ conky(1) conky(1)
1mi2c (dev) type n0m
I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
if you have only one I2C device. Parameter type is either ’in’
or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ meaning tem‐
if you have only one I2C device. Parameter type is either 'in'
or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
perature. Parameter n is number of the sensor. See
/sys/bus/i2c/devices/ on your local computer.
@ -942,7 +941,7 @@ conky(1) conky(1)
1mi8k_left_fan_rpm0m
If running the i8k kernel driver for Inspiron laptops, displays
the left fan’s rate of rotation, in revolutions per minute as
the left fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
@ -956,7 +955,7 @@ conky(1) conky(1)
1mi8k_right_fan_rpm0m
If running the i8k kernel driver for Inspiron laptops, displays
the right fan’s rate of rotation, in revolutions per minute as
the right fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
@ -994,7 +993,7 @@ conky(1) conky(1)
1mibm_brightness0m
If running the IBM ACPI, displays the brigtness of the laptops’s
If running the IBM ACPI, displays the brigtness of the laptops's
LCD (0-7).
@ -1027,12 +1026,13 @@ conky(1) conky(1)
1mstring22m: argument is enclosed in quotation mark or the checks for
double and long failed before.
Valid operands are: ’>’, ’<’, ’>=’, ’<=’, ’==’, ’!=’.
Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1mif_running (process)0m
if PROCESS is running, display everything $if_running and the
matching $endif
matching $endif. This uses the ``pidof'' command, so the -x
switch is also supported.
1mif_mounted (mountpoint)0m
@ -1052,7 +1052,7 @@ conky(1) conky(1)
1mif_updatenr (updatenr)0m
If it’s the UPDATENR-th time that conky updates, display every‐
If it's the UPDATENR-th time that conky updates, display every‐
thing between $if_updatenr and the matching $endif. The counter
resets when the highest UPDATENR is reached. Example :
"{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
@ -1066,7 +1066,7 @@ conky(1) conky(1)
passing arguments to this object. Arguments are: "host user pass
[-i interval] [-p port] [-e command] [-r retries]". Default port
is 143, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
tries before giving up is 5. If the password is supplied as '*',
you will be prompted to enter the password when Conky starts.
@ -1076,7 +1076,7 @@ conky(1) conky(1)
passing arguments to this object. Arguments are: "host user pass
[-i interval] [-p port] [-e command] [-r retries]". Default port
is 143, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
tries before giving up is 5. If the password is supplied as '*',
you will be prompted to enter the password when Conky starts.
@ -1188,7 +1188,7 @@ conky(1) conky(1)
1mwidth) mbox0m
Print a summary of recent messages in an mbox format mailbox.
mbox parameter is the filename of the mailbox (can be encapsu‐
lated using ’"’, ie. ${mboxscan -n 10 "/home/brenden/some box"}
lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1mmem 22mAmount of memory in use
@ -1318,7 +1318,7 @@ conky(1) conky(1)
1mmpd_bar (height),(width)0m
Bar of mpd’s progress
Bar of mpd's progress
1mmpd_bitrate0m
@ -1334,19 +1334,19 @@ conky(1) conky(1)
1mmpd_vol0m
MPD’s volume
MPD's volume
1mmpd_elapsed0m
Song’s elapsed time
Song's elapsed time
1mmpd_length0m
Song’s length
Song's length
1mmpd_percent0m
Percent of song’s progress
Percent of song's progress
1mmpd_random0m
@ -1418,14 +1418,14 @@ conky(1) conky(1)
charged or absent.
1mtime22m: Display the time remaining until the battery will be fully
charged or discharged at current rate. Nothing is displayed, if
battery is absent or if it’s present but fully charged and not
battery is absent or if it's present but fully charged and not
discharging.
1mplatform (dev) type n0m
Platform sensor from sysfs (Linux 2.6). Parameter dev may be
omitted if you have only one platform device. Platform type is
either ’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’
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.
@ -1436,7 +1436,7 @@ conky(1) conky(1)
passing arguments to this object. Arguments are: "host user pass
[-i interval] [-p port] [-e command] [-r retries]". Default port
is 110, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
tries before giving up is 5. If the password is supplied as '*',
you will be prompted to enter the password when Conky starts.
@ -1447,7 +1447,7 @@ conky(1) conky(1)
"host user pass [-i interval] [-p port] [-e command] [-r re‐
tries]". Default port is 110, default interval is 5 minutes, and
default number of retries before giving up is 5. If the password
is supplied as ’*’, you will be prompted to enter the password
is supplied as '*', you will be prompted to enter the password
when Conky starts.
@ -1465,14 +1465,14 @@ conky(1) conky(1)
1mscroll length (step) text0m
Scroll ’text’ by ’step’ characters showing ’length’ number of
Scroll 'text' by 'step' characters showing 'length' number of
characters at the same time. The text may also contain vari‐
ables. ’step’ is optional and defaults to 1 if not set. If a var
ables. 'step' is optional and defaults to 1 if not set. If a var
creates output on multiple lines then the lines are placed be‐
hind each other separated with a ’|’-sign. Do NOT use vars that
hind each other separated with a '|'-sign. Do NOT use vars that
change colors or otherwise affect the design inside a scrolling
text. If you want spaces between the start and the end of
’text’, place them at the end of ’text’ not at the front ("foo‐
'text', place them at the end of 'text' not at the front ("foo‐
bar" and " foobar" can both generate "barfoo" but "foobar " will
keep the spaces like this "bar foo").
@ -1483,8 +1483,8 @@ conky(1) conky(1)
1msmapi (ARGS)0m
when using smapi, display contents of the /sys/devices/plat‐
form/smapi directory. ARGS are either ’(FILENAME)’ or ’bat (IN‐
DEX) (FILENAME)’ to display the corresponding files’ content.
form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
DEX) (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.
@ -1497,7 +1497,7 @@ conky(1) conky(1)
1msmapi_bat_perc (INDEX)0m
when using smapi, display the remaining capacity in percent of
the battery with index INDEX. This is a separate variable be‐
cause it supports the ’use_spacer’ configuration option.
cause it supports the 'use_spacer' configuration option.
1msmapi_bat_power INDEX0m
@ -1599,12 +1599,12 @@ conky(1) conky(1)
1mtab (width, (start))0m
Puts a tab of the specified width, starting from column ’start’.
Puts a tab of the specified width, starting from column 'start'.
1mtail logfile lines (interval)0m
Displays last N lines of supplied text text file. If interval is
not supplied, Conky assumes 2x Conky’s interval. Max of 30 lines
not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
can be displayed, or until the text buffer is filled.
@ -1655,7 +1655,7 @@ conky(1) conky(1)
1mtotaldown net0m
Total download, overflows at 4 GB on Linux with 32-bit arch and
there doesn’t seem to be a way to know how many times it has al‐
there doesn't seem to be a way to know how many times it has al‐
ready done that before conky has started.
@ -1729,12 +1729,12 @@ conky(1) conky(1)
1mvoltage_mv (n)0m
Returns CPU #n’s voltage in mV. CPUs are counted from 1. If
Returns CPU #n's voltage in mV. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mvoltage_v (n)0m
Returns CPU #n’s voltage in V. CPUs are counted from 1. If omit‐
Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
ted, the parameter defaults to 1.
@ -1823,7 +1823,7 @@ conky(1) conky(1)
1mxmms2_elapsed0m
Song’s elapsed time
Song's elapsed time
1mxmms2_size0m
@ -1831,7 +1831,7 @@ conky(1) conky(1)
1mxmms2_percent0m
Percent of song’s progress
Percent of song's progress
1mxmms2_status0m
@ -1839,7 +1839,7 @@ conky(1) conky(1)
1mxmms2_bar (height),(width)0m
Bar of XMMS2’s progress
Bar of XMMS2's progress
1mxmms2_smart0m
@ -1859,7 +1859,7 @@ conky(1) conky(1)
1mEXAMPLES0m
conky 1m-t ’${time %D %H:%M}’ -o -u 300m
conky 1m-t '${time %D %H:%M}' -o -u 300m
Start Conky in its own window with date and clock as text and 30
sec update interval.
@ -1870,9 +1870,9 @@ conky(1) conky(1)
4m~/.conkyrc24m default configuration file
1mBUGS0m
Drawing to root or some other desktop window directly doesn’t work with
all window managers. Especially doesn’t work well with Gnome and it has
been reported that it doesn’t work with KDE either. Nautilus can be
Drawing to root or some other desktop window directly doesn't work with
all window managers. Especially doesn't work well with Gnome and it has
been reported that it doesn't work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree

3
doc/conky.1
View File

@ -894,7 +894,8 @@ Valid operands are:
.TP
\fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
if PROCESS is running, display everything $if_running
and the matching $endif
and the matching $endif. This uses the ``pidof'' command, so the
-x switch is also supported.
.TP
\fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>

2
doc/docs.xml
View File

@ -16,7 +16,7 @@
<firstname>Brenden</firstname>
<surname>Matthews</surname>
</author>
<date>2008-12-07</date>
<date>2009-03-15</date>
</refentryinfo>
<refmeta>

3
doc/variables.xml
View File

@ -1079,7 +1079,8 @@
</term>
<listitem>
if PROCESS is running, display everything $if_running
and the matching $endif
and the matching $endif. This uses the ``pidof'' command, so the
-x switch is also supported.
<para></para></listitem>
</varlistentry>