README.menu

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