1lcdproc(1)                       LCDproc suite                      lcdproc(1)
2
3
4

NAME

6       lcdproc - system status information client
7
8

SYNOPSIS

10       lcdproc [-hfv] [-c config] [-s host] [-p port] [-e delay] [screen ...]
11
12

DESCRIPTION

14       lcdproc  is  the  client in the LCDproc suite that displays information
15       about the local system's status on an LCD that is connected to an  LCDd
16       server daemon.
17
18       Due  to  the  client-server architecture it does not matter whether the
19       LCDd daemon runs on the local machine or on a remote system.
20
21       Most settings of lcdproc are configured through its configuration  file
22       /etc/sysconfig/lcdproc/lcdproc.conf,  some  of  them  can  be overriden
23       using command line options.
24
25       Before running lcdproc you should carefully read through that file  and
26       modify the settings therein according to your needs.
27
28       When  compiled  appropriately, some aspects of lcdproc can even config‐
29       ured at run time using a menu on the LCD.
30
31       Currently, only Linux, the BSD variants FreeBSD,  NetBSD,  OpenBSD  and
32       Darwin  as  well  as Solaris are supported, but not all features may be
33       available on all platforms.
34
35

OPTIONS

37       lcdproc understands these command line options:
38
39       -c config
40              Use  a  configuration  file   other   than   /etc/sysconfig/lcd‐
41              proc/LCDd.conf
42
43       -s host
44              Connect to the LCDd server on host, instead to the one listed in
45              te Server parameter in the config file's [lcdproc] section.   If
46              not  given  here  and not specified in the config file or if the
47              default config file does not exist, it defaults to 'localhost.
48
49       -p port
50              Use port port when connecting to the LCDd server on host.   This
51              option  overrides  the Port parameter in the config file's [lcd‐
52              proc] section.  Without a default config file or when not set in
53              the config file, it defaults to the LCDproc port 13666.
54
55       -f     Run  in  the  foreground, overriding the Foreground parameter in
56              the config file's [lcdproc] section.  The default, if not in the
57              config file or without a config file, is to daemonize lcdproc as
58              it is intended to display the system information  in  the  back‐
59              ground.
60
61       -e delay
62              Sleep  delay in 100ths of seconds between updating screens in an
63              update cycle.  This option overrides the Delay parameter in  the
64              config  file's [lcdproc] section.  When not given and not in the
65              config file, it defaults to 0.
66
67       -h     Show help screen.
68
69       -v     Print the version of lcdproc and exit.
70
71       screen can be one of the following:
72
73              C CPU           show detailed CPU usage
74
75              P SMP-CPU       CPU usage overview: one line per CPU, especially
76                              useful on SMP systems.
77
78              G CPUGraph      CPU histogram
79
80              L Load          Load histogram
81
82              M Memory        memory & swap usage
83
84              S ProcSize      memory usage of 5 biggest processes
85
86              D Disk          filling level of the mounted file systems
87
88              I Iface         network interface usage
89
90              B Battery       battery status
91
92              T TimeDate      time & date information
93
94              O OldTime       old time screen
95
96              U Uptime        uptime screen
97
98              K BigClock      big clock
99
100              N MiniClock     minimal clock
101
102              A About         credits page
103
104              On  the  command  line  you may either use the short or the long
105              screen name.  In the config file, the long  names  are  used  as
106              section labels to configure the screens further.
107
108              You  may  also  prefix the screen names with an exclamation mark
109              '!' to disable a screen that was activated in  the  config  file
110              instead of activating a disabled one.
111
112

EXAMPLES

114              lcdproc C M D '!L'
115
116       With  the  command line specified above, lcdproc loads the default con‐
117       figuration file, connects to the LCDd server specified therein and then
118       displays  the  following  screens in addition to those activated in the
119       configuration file on the LCD:
120
121       *      detailed CPU Usage
122
123       *      Memory & swap usage
124
125       *      filling level of the mounted file systems
126
127       The
128
129       *      Load histogram
130
131       screen is disabled and therefore not shown in the display.  (The quotes
132       are  not  part  of  lcdproc's command line syntax; they are required to
133       disable special interpretation of the exclamation mark by the shell).
134
135
136

FILES

138       /etc/sysconfig/lcdproc/lcdproc.conf,  lcdproc's  default  configuration
139       file
140
141

SEE ALSO

143       LCDd(8), lcdproc-config(5)
144
145

AUTHOR

147       LCDproc  was originally written by William Ferrell (wwf@splatwerks.org)
148       andr Scott Scriven (scriven@cs.colostate.edu).
149
150       Since that time various people have contributed to LCDproc.
151
152       The newest version of LCDproc should be available from here:
153
154                 http://www.lcdproc.org/
155
156
158       LCDproc is released as "WorksForMe-Ware".  In other words, it is  free,
159       kinda neat, and we don't guarantee that it will do anything in particu‐
160       lar on any machine except the ones it was developed on.
161
162       It is technically released under the GNU GPL license (you  should  have
163       received   the   file,   "COPYING",   with   LCDproc)  (also,  look  on
164       http://www.fsf.org/ for more information), so you  can  distribute  and
165       use  it  for free -- but you must make the source code freely available
166       to anyone who wants it.
167
168       For any sort of real legal information, read the GNU GPL  (GNU  General
169       Public License).  It's worth reading.
170
171
172
173LCDproc                        22 November 2008                     lcdproc(1)
Impressum