| 1 | WARNING! |
|---|
| 2 | This man page hasn't been updated since V0.3.4. |
|---|
| 3 | |
|---|
| 4 | |
|---|
| 5 | SYNOPSIS |
|---|
| 6 | |
|---|
| 7 | lcdproc - displays system status on Matrix-Orbital 20x4 LCD |
|---|
| 8 | on a serial port |
|---|
| 9 | |
|---|
| 10 | USAGE |
|---|
| 11 | |
|---|
| 12 | lcdproc [-d device] [-c contrast] [modelist] |
|---|
| 13 | |
|---|
| 14 | DESCRIPTION |
|---|
| 15 | |
|---|
| 16 | lcdproc uses a 20x4 character LCD manufactured by Matrix-Orbital |
|---|
| 17 | to display status information about the system. |
|---|
| 18 | |
|---|
| 19 | Currently, only Linux is supported (kernels 2.0 and greater), and |
|---|
| 20 | /proc filesystem support is required. In addition, only displays |
|---|
| 21 | made by Matrix-Orbital are supported at this time (their displays |
|---|
| 22 | have built-in controllers and a very good BIOS). |
|---|
| 23 | |
|---|
| 24 | lcdproc understands these options: |
|---|
| 25 | |
|---|
| 26 | -l driver |
|---|
| 27 | The lcd display driver to use. So far, this can only be: |
|---|
| 28 | text Text-mode output. (20x4) |
|---|
| 29 | MtxOrb Matrix Orbital displays... (20x4) |
|---|
| 30 | curses Curses-based terminal output (20x4) |
|---|
| 31 | debug Verbose debugging text output (terminal) |
|---|
| 32 | |
|---|
| 33 | -d device |
|---|
| 34 | The serial port attached to the display. Usually /dev/cua0 |
|---|
| 35 | or /dev/cua1. This device is locked by lcdproc. |
|---|
| 36 | |
|---|
| 37 | -c contrast |
|---|
| 38 | Sets the display's contrast setting to the value specified, |
|---|
| 39 | ranging from 0 to 255. Note that values below around 30 |
|---|
| 40 | yield invisible characters from most viewing angles, and |
|---|
| 41 | values above 200 yield solid cells from most viewing |
|---|
| 42 | angles. |
|---|
| 43 | |
|---|
| 44 | modelist |
|---|
| 45 | A list specifying what screens to display, and in what order; |
|---|
| 46 | in the form: |
|---|
| 47 | |
|---|
| 48 | mode [mode mode mode ...] |
|---|
| 49 | |
|---|
| 50 | where mode is one of... |
|---|
| 51 | "C" (CPU usage), |
|---|
| 52 | "G" (CPU Graph like Xload), |
|---|
| 53 | "M" (Memory Usage), |
|---|
| 54 | "X" (X-Load), |
|---|
| 55 | "T" (Date, time, Uptime, OS version) |
|---|
| 56 | "D" (Disk Stats), |
|---|
| 57 | "B" (Battery Stats), |
|---|
| 58 | "A" (About), |
|---|
| 59 | "O" (old date and time screen), (removed soon?) |
|---|
| 60 | "U" (System Uptime), (will be removed soon?) |
|---|
| 61 | |
|---|
| 62 | For example: |
|---|
| 63 | |
|---|
| 64 | lcdproc -d /dev/cua1 -c 180 C M D X -l MtxOrb |
|---|
| 65 | |
|---|
| 66 | selects /dev/cua1 (com2) as the serial port for the |
|---|
| 67 | MtxOrb driver, sets the display's contrast to 180, |
|---|
| 68 | and specifies the following modes: |
|---|
| 69 | |
|---|
| 70 | - CPU Usage, updated every 1/8th of a second for 4 seconds. |
|---|
| 71 | - Memory usage, updated every 1/4th of a second for 4 seconds. |
|---|
| 72 | - Uptime, updated every 1/2 second for 4 seconds. |
|---|
| 73 | - Date and Time, updated every 1/2 second for 4 seconds. |
|---|
| 74 | - X-Load average over time, updated once per mode cycle. |
|---|
| 75 | |
|---|
| 76 | |
|---|
| 77 | CAVEATS |
|---|
| 78 | |
|---|
| 79 | The command line will change a lot Real Soon Now(tm). Be sure to |
|---|
| 80 | check on this when installing new versions. |
|---|
| 81 | |
|---|
| 82 | The "idle" stat on the time screen (D) reflects how much idle time |
|---|
| 83 | your system has had since booting. So, if you leave the machine |
|---|
| 84 | running at night without doing anything, you'll have at least 50% |
|---|
| 85 | idle. :) |
|---|
| 86 | |
|---|
| 87 | KNOWN BUGS |
|---|
| 88 | |
|---|
| 89 | - Only supports 20x4 displays, so far. |
|---|
| 90 | - Doesn't lock the com port... yet. |
|---|
| 91 | - Doesn't always shut down correctly when killed by init. (?) |
|---|
| 92 | (during "shutdown -h now", for example) |
|---|
| 93 | |
|---|
| 94 | CONTACT INFORMATION |
|---|
| 95 | |
|---|
| 96 | LCDproc was written by William Ferrell (choadster@earthlink.net) and |
|---|
| 97 | Scott Scriven (scriven@cs.colostate.edu). |
|---|
| 98 | |
|---|
| 99 | Matrix Orbital (http://www.matrix-orbital.com/) designed and |
|---|
| 100 | manufactures the LCD displays. |
|---|
| 101 | |
|---|
| 102 | The newest version of LCDproc should be available from here: |
|---|
| 103 | |
|---|
| 104 | http://lcdproc.omnipotent.net/ |
|---|
| 105 | |
|---|
| 106 | LEGAL STUFF |
|---|
| 107 | |
|---|
| 108 | LCDproc is released as "WorksForMe-Ware". In other words, it is free, |
|---|
| 109 | kinda neat, and we don't guarantee that it will do anything in |
|---|
| 110 | particular on any machine except the ones it was developed on. |
|---|
| 111 | |
|---|
| 112 | It is technically released under the GNU GPL license (you should |
|---|
| 113 | have received the file, "COPYING", with LCDproc) (also, look on |
|---|
| 114 | http://www.fsf.org/ for more information), so you can distribute and |
|---|
| 115 | use it for free -- but you must make the source code freely available |
|---|
| 116 | to anyone who wants it. |
|---|
| 117 | |
|---|
| 118 | For any sort of real legal information, read the GNU GPL (GNU General |
|---|
| 119 | Public License). It's worth reading. |
|---|
