source: npl/mediabox/lcdproc_edwin/src/INSTALL

Last change on this file was c5c522c, checked in by Edwin Eefting <edwin@datux.nl>, 8 years ago

initial commit, transferred from cleaned syn3 svn tree

  • Property mode set to 100644
File size: 6.1 KB
Line 
10. REALLY-QUICK START
2
3Try this, if you're in a hurry:
4        edit Makefile.config   (use your preferred text editor, of course)
5        make
6        su
7        make install
8
9
101. GETTING STARTED
11
12First read the README if you haven't already.
13
142. CONNECTING THE DISPLAY TO YOUR SYSTEM
15
16WARNING! Danger, Will Robinson, Danger! This is pretty easy, but if
17by chance you screw up your machine by crossing some wires or by
18pouring water on things with the power turned on, don't blame us!
19Neither we, Matrix Orbital Corporation, or any manufacturer of LCDs
20you're trying to use shall be held responsible for damage incurred
21by following these directions.
22
23These instructions are SPECIFICALLY FOR MATRIX ORBITAL'S DISPLAYS!
24Other displays will quite obviously have different requirements!
25
262.1. POWER CONNECTION
27
28Matrix Orbital has instructions online for connecting the power
29cable.  It's at http://www.matrix-orbital.com/addendum.htm
30Go there, if you're online.  Or you can just read this:
31
32The LCD takes either +5V or +12V, depending on which model you
33bought.  You should have the +5V model unless you requested
34otherwise.  Either amount can be provided conveniently by a slightly
35modified floppy power cable.
36
37       ************* For +5V, use the RED wire. **************
38       *********** For +12V, use the YELLOW wire. ************
39
40Basically, disconnect the wire you don't need (yellow for +12V, or red
41for +5V) and one of the black wires (they're both grounds so it
42shouldn't matter which one you use).  Then move the two remaining
43wires to the opposite ends of the connector. The power wire goes to the
44clearly marked +5V pin, and the black one goes to the also clearly
45marked GND pin.
46
47Assuming you modified the cable right (we'll have pictures on the
48web site in a few days to show how this connection should be made),
49plug the other end of your modified wire into your system's power
50cables and turn the system on (you don't need to connect the serial
51cable until you know you got the power working). The LCD should light
52up and tell you what version of the BIOS it has in it. If it does,
53you've got it. If it doesn't, uh-oh. Turn the machine off quickly and
54try it again.
55
562.2. SERIAL CONNECTION
57
58The LCD uses a standard DB9 serial connector. However you want to
59get from your motherboard or add-in card's serial port to the back of
60the LCD is up to you. In one of my machines, I just literally pulled
61one of the DB9 connectors off the back of my machine and plugged it
62straight into the LCD, so it was just running from the motherboard
63right to the LCD. YMMV (your milage may vary). In my new machine, I
64needed a longer cable, so I just went out and bought a 6' external
65serial cable, rolled it up and put it on top of my power supply, and
66everything worked.
67
68By default (at least mine was shipped this way ;) the LCD is
69configured to run at 19,200 baud, 8-N-1. You might want to make sure
70yours is set like this; otherwise you'll need to hack our code which
71you shouldn't have to do for this to work right.
72
733. BUILDING LCDPROC
74
75As long as you have a working gcc and make, this should work.
76
77 - Edit Makefile.config to configure some options.
78 - Run "make"
79
80LCDproc will build in (hopefully) a few seconds. It's not very big. If
81you want, you can install it (if you're root) by typing:
82
83make install
84
85This will install the binaries and the man page, and will make a link
86called /dev/lcd which points to whatever port you specified in the
87Makefile. It will also change the permissions on the specified port
88to allow all users to write to the port (so users can run LCDproc).
89If you _don't_ want to allow this, change the permissions back after
90installing LCDproc. :)
91
924. RUNNING LCDPROC / MANUAL INSTALL
93
94First, you'll need to run the LCDd server.  If you're in the LCDproc
95source directory, and have just built it, run...
96
97       server/LCDd -d joy -d MtxOrb
98
99This assumes you want to use the Matrix Orbital LCD driver and a
100joystick.  You can find out what other drivers are available by
101running "LCDd -h".  Note that you can use more than one driver at the
102same time.
103
104Then, you'll need some clients.  LCDproc comes with one:
105
106       clients/lcdproc/lcdproc C M T X &
107
108This will run the main LCDproc client, with the [C]pu, [M]emory,
109[T]ime, and [X]load screens.  The ampersand (&) puts it in the background.
110
111To install manually, you'll want to do something like the following:
112
113        su
114        cp server/LCDd /usr/local/bin
115        cp clients/lcdproc/lcdproc /usr/local/bin
116        cp docs/lcdproc.1.gz /usr/local/man/cat1
117        ln -s /dev/ttyS0 /dev/lcd
118
119Some prereleases or development releases will have broken auto-install
120scripts, so manual installs may be necessary for those versions.
121
122
1235. PUTTING LCDPROC IN SYSTEM STARTUP
124
125It's nice to have LCDproc start when the computer boots, so here's how
126to do it:
127
128In Slackware or RedHat:
129        Add lines to your /etc/rc.d/rc.local, such as the following:
130          echo "Starting LCDproc..."
131          /usr/local/bin/lcdproc C M X &
132
133In Debian:
134      - Make a file "/etc/init.d/lcd" which works the same as the
135        other scripts in that directory.  (it should accept "start"
136        and "stop" as parameters...)
137      - To start, run "LCDd" with any necessary parameters.  It will
138        put itself in the background as a daemon.
139      - Also in the "start" section, add "lcdproc" with some
140        parameters.  Be sure to put a "&" on the end, or the system
141        will get stuck there when you boot.
142      - And, put in any other clients you want to run all the time.
143      - For the "stop" section, simply "kill" all the programs you
144        started in the "start" section.  They will shut down and exit.
145        I recommend killing the server after all the clients, but it
146        really doesn't matter much.
147
148      - Now, add symlinks from /etc/rc[2-5].d/S50lcd to /etc/init.d/lcd,
149        and be sure to get /etc/rc[06].d/K50lcd to /etc/init.d/lcd.
150        This will cause LCDproc to shut down when your system does.
151
152That's all the OS`s we've actually done this with so far..
153
1546. OUR WEB SITE
155
156Visit http://lcdproc.omnipotent.net/ for the latest updates and news
157for LCDproc. If you've got comments, suggestions, bug fixes, or
158problems (related to LCDproc, not women ;), send e-mail to either
159William W. Ferrell (choadster@earthlink.net) or Scott Scriven
160(scriven@cs.colostate.edu).
Note: See TracBrowser for help on using the repository browser.