blob: d9d34c4c105d3f1854502852865f1a22560bb3d9 [file] [log] [blame]
apw3812c032006-12-07 21:01:14 +00001CONMUX -- Console Multiplexor
2=============================
3CONMUX is a console abstractor. Presenting any console with a
4consistent location, naming and semantic. Access to the console,
5and hardreset of the machine is the same regardless of the underlying
6access methodology.
7
8
9License
10-------
11See the COPYING file for details.
12
13
14Installation
15------------
16See the INSTALL file for details.
17
18
19Configuration
20-------------
21A console multiplexor is defined using a per instance configuration file.
22The standard startup scripts expect this to be in the ROOT/etc and have
23a .cf suffix.
24
25Below is an example configuration defining the console for a NUMA-Q:
26
27 $ cat kite.cf
28 # START:autoboot
29 listener kite
30 socket console 'kite console' console.server.here.com:6000
31 command 'hardreset' 'initated a hard reset' \
32 'conmux-attach -o status localhost/kite reboot-numaq vcs \
33 vcsconsole.server.here.com kite 12346 administrator passwd'
34 $
35
36These are connected to using the console command, using the symbolic console
37name:
38
39 $ console kite
40
41
42Automatic Startup
43-----------------
44See the start script for automated startup of console daemons.
45This script is designed to be used at system boot time out of
46/etc/init.d.
47
48
49Documentation and Examples
50--------------------------
51More detailed information on the workings of conmux can be found in
52'conmux.html'. Example configuration files can be found in the
53'examples' directory.
54
55
56Legal
57-----
58(C) Copyright IBM Corp. 2004, 2005, 2006
59Author: Andy Whitcroft <andyw@uk.ibm.com>
60
61The Console Multiplexor is released under the GNU Public License V2