conmux/README

   1 CONMUX -- Console Multiplexor
   2 =============================
   3 CONMUX is a console abstractor.  Presenting any console with a
   4 consistent location, naming and semantic.  Access to the console,
   5 and hardreset of the machine is the same regardless of the underlying
   6 access methodology.
   7
   8
   9 License
  10 -------
  11 See the COPYING file for details.
  12
  13
  14 Installation
  15 ------------
  16 See the INSTALL file for details.
  17
  18
  19 Configuration
  20 -------------
  21 A console multiplexor is defined using a per instance configuration file.
  22 The standard startup scripts expect this to be in the ROOT/etc and have
  23 a .cf suffix.
  24
  25 Below 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
  36 These are connected to using the console command, using the symbolic console
  37 name:
  38
  39   $ console kite
  40
  41
  42 Automatic Startup
  43 -----------------
  44 See the start script for automated startup of console daemons.
  45 This script is designed to be used at system boot time out of
  46 /etc/init.d.
  47
  48
  49 Documentation and Examples
  50 --------------------------
  51 More 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
  56 Legal
  57 -----
  58 (C) Copyright IBM Corp. 2004, 2005, 2006
  59 Author: Andy Whitcroft <andyw@uk.ibm.com>
  60
  61 The Console Multiplexor is released under the GNU Public License V2