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

EXAMPLES

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

FILES

137       /etc/lcdproc/lcdproc.conf, lcdproc's default configuration file
138
139

SEE ALSO

141       LCDd(8), lcdproc-config(5)
142
143

AUTHOR

145       Many people have contributed to LCDproc.  See the CREDITS file for more
146       details.
147
148       All questions should be sent to the lcdproc mailing list.  The  mailing
149       list, and the newest version of LCDproc, should be available from here:
150
151                 http://www.lcdproc.org/
152
153
154
156       LCDproc  is released as "WorksForMe-Ware".  In other words, it is free,
157       kinda neat, and we don't guarantee that it will do anything in particu‐
158       lar on any machine except the ones it was developed on.
159
160       It  is  technically released under the GNU GPL license (you should have
161       received  the  file,  "COPYING",   with   LCDproc)   (also,   look   on
162       http://www.fsf.org/  for  more  information), so you can distribute and
163       use it for free -- but you must make the source code  freely  available
164       to anyone who wants it.
165
166       For  any  sort of real legal information, read the GNU GPL (GNU General
167       Public License).  It's worth reading.
168
169
170
171LCDproc                          24 March 2011                      lcdproc(1)
Impressum