syslinux/README.menu

   1 $Id: README.menu,v 1.5 2005/01/21 01:35:33 hpa Exp $
   2
   3 There are two menu systems included with SYSLINUX, the advanced menu
   4 system, and the simple menu system.
   5
   6
   7 +++ THE ADVANCED MENU SYSTEM +++
   8
   9 The advanced menu system, written by Murali Krishnan Ganapathy, is
  10 located in the menu/ subdirectly.  It allows the user to create
  11 hierarchial submenus, dynamic options, checkboxes, and just about
  12 anything you want.  It requires that the menu is compiled from a
  13 simple C file, see menu/simple.c and menu/complex.c for examples.
  14
  15 The advanced menu system doesn't support serial console at this time.
  16
  17 See menu/README for more information.
  18
  19
  20 +++ THE SIMPLE MENU SYSTEM +++
  21
  22 The simple menu system is a single module located at
  23 com32/modules/menu.c32.  It uses the same configuration file as the
  24 regular SYSLINUX command line, and displays all the LABEL statements.
  25
  26 To use the menu system, simply make sure menu.c32 is in the
  27 appropriate location for your boot medium (the same directory as the
  28 configuration file for SYSLINUX, EXTLINUX and ISOLINUX, and the same
  29 directory as pxelinux.0 for PXELINUX), and put the following options
  30 in your configuration file:
  31
  32 DEFAULT menu.c32
  33 PROMPT 0
  34
  35
  36 There are a few menu additions to the command line, all starting with
  37 the keyword MENU; like the rest of the SYSLINUX config file
  38 language, it is case insensitive:
  39
  40 MENU TITLE title
  41
  42         Give the menu a title.  The title is presented at the top of
  43         the menu.
  44
  45 MENU LABEL label
  46
  47         (Only valid after a LABEL statement.)
  48         Changes the label displayed for a specific entry.  This allows
  49         you to have a label that isn't suitable for the command line,
  50         for example:
  51
  52         # Soft Cap Linux
  53         LABEL softcap
  54                 MENU LABEL Soft Cap ^Linux 9.6.36
  55                 KERNEL softcap-9.6.36.bzi
  56                 APPEND whatever
  57
  58         # A very dense operating system
  59         LABEL brick
  60                 MENU LABEL ^Windows CE/ME/NT
  61                 KERNEL chain.c32
  62                 APPEND hd0 2
  63
  64         The ^ symbol in a MENU LABEL statement defines a hotkey.
  65         The hotkey will be highlighted in the menu and will move the
  66         menu cursor immediately to that entry.
  67
  68 MENU HIDE
  69
  70         (Only valid after a LABEL statement.)
  71         Suppresses a particular LABEL entry from the menu.
  72
  73
  74 MENU DEFAULT
  75
  76         (Only valid after a LABEL statement.)
  77         Indicates that this entry should be the default.  If no
  78         default is specified, use the first one.
  79
  80
  81 MENU PASSWD passwd
  82
  83         (Only valid after a LABEL statement.)
  84         Sets a password on this menu entry.  "passwd" can be either a
  85         cleartext password or a SHA-1 encrypted password; use the
  86         included Perl script "sha1pass" to encrypt passwords.
  87         (Obviously, if you don't encrypt your passwords they will not
  88         be very secure at all.)
  89
  90         If you are using passwords, you want to make sure you also use
  91         the settings "NOESCAPE 1", "PROMPT 0", and either set
  92         "ALLOWOPTIONS 0" or use a master password (see below.)
  93
  94         If passwd is an empty string, this menu entry can only be
  95         unlocked with the master password.
  96
  97
  98 MENU MASTER PASSWD passwd
  99
 100         Sets a master password.  This password can be used to boot any
 101         menu entry, and is required for the [Tab] and [Esc] keys to
 102         work.
 103
 104
 105 The menu system honours the TIMEOUT command; if TIMEOUT is specified
 106 it will execute the ONTIMEOUT command if one exists, otherwise it will
 107 pick the default menu option.
 108
 109 Normally, the user can press [Tab] to edit the menu entry, and [Esc]
 110 to return to the SYSLINUX command line.  However, if the configuration
 111 file specifies ALLOWOPTIONS 0, these keys will be disabled, and if
 112 MENU MASTER PASSWD is set, they require the master password.
 113
 114 The simple menu system supports serial console, using the normal
 115 SERIAL directive.  However, it can be quite slow over a slow serial
 116 link; you probably want to set your baudrate to 38400 or higher if
 117 possible.  It requires a Linux/VT220/ANSI-compatible terminal on the
 118 other end.
 119