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/vesamenu.c32 (graphical) or com32/modules/menu.c32 (text
  22 mode only).  It uses the same configuration file as the regular
  23 SYSLINUX command line, and displays all the LABEL statements.
  24
  25 To use the menu system, simply make sure [vesa]menu.c32 is in the
  26 appropriate location for your boot medium (the same directory as the
  27 configuration file for SYSLINUX, EXTLINUX and ISOLINUX, and the same
  28 directory as pxelinux.0 for PXELINUX), and put the following options
  29 in your configuration file:
  30
  31 DEFAULT menu.c32
  32 PROMPT 0
  33
  34
  35 There are a few menu additions to the command line, all starting with
  36 the keyword MENU; like the rest of the SYSLINUX config file
  37 language, it is case insensitive:
  38
  39 MENU TITLE title
  40
  41         Give the menu a title.  The title is presented at the top of
  42         the menu.
  43
  44 MENU LABEL label
  45
  46         (Only valid after a LABEL statement.)
  47         Changes the label displayed for a specific entry.  This allows
  48         you to have a label that isn't suitable for the command line,
  49         for example:
  50
  51         # Soft Cap Linux
  52         LABEL softcap
  53                 MENU LABEL Soft Cap ^Linux 9.6.36
  54                 KERNEL softcap-9.6.36.bzi
  55                 APPEND whatever
  56
  57         # A very dense operating system
  58         LABEL brick
  59                 MENU LABEL ^Windows CE/ME/NT
  60                 KERNEL chain.c32
  61                 APPEND hd0 2
  62
  63         The ^ symbol in a MENU LABEL statement defines a hotkey.
  64         The hotkey will be highlighted in the menu and will move the
  65         menu cursor immediately to that entry.
  66
  67         Reusing hotkeys is disallowed, subsequent entries will not be
  68         highlighted, and will not work.
  69
  70         Keep in mind that the LABELs, not MENU LABELs, must be unique,
  71         or odd things will happen to the command-line.
  72
  73 MENU HIDE
  74
  75         (Only valid after a LABEL statement.)
  76         Suppresses a particular LABEL entry from the menu.
  77
  78
  79 MENU DEFAULT
  80
  81         (Only valid after a LABEL statement.)
  82         Indicates that this entry should be the default.  If no
  83         default is specified, use the first one.
  84
  85
  86 MENU PASSWD passwd
  87
  88         (Only valid after a LABEL statement.)
  89         Sets a password on this menu entry.  "passwd" can be either a
  90         cleartext password or a SHA-1 encrypted password; use the
  91         included Perl script "sha1pass" to encrypt passwords.
  92         (Obviously, if you don't encrypt your passwords they will not
  93         be very secure at all.)
  94
  95         If you are using passwords, you want to make sure you also use
  96         the settings "NOESCAPE 1", "PROMPT 0", and either set
  97         "ALLOWOPTIONS 0" or use a master password (see below.)
  98
  99         If passwd is an empty string, this menu entry can only be
 100         unlocked with the master password.
 101
 102
 103 MENU MASTER PASSWD passwd
 104
 105         Sets a master password.  This password can be used to boot any
 106         menu entry, and is required for the [Tab] and [Esc] keys to
 107         work.
 108
 109
 110 MENU BACKGROUND filename
 111
 112         For vesamenu.c32, sets the background image.  The image should
 113         be 640x480 pixels and either in PNG or JPEG format.
 114
 115
 116 MENU INCLUDE filename
 117
 118         Include the contents of the configuration file filename at
 119         this point.  Keep in mind that the included data is only seen
 120         by the menu system; the core syslinux code does not parse this
 121         command, so any labels defined in it are unavailable.
 122
 123
 124 MENU AUTOBOOT message
 125
 126         Replaces the message "Automatic boot in # seconds".  The
 127         symbol # is replaced with the number of seconds remaining.
 128
 129
 130 MENU TABMSG message
 131
 132         Replaces the message "Press [Tab] to edit options".
 133
 134
 135 MENU NOTABMSG message
 136
 137         Takes the place of the TABMSG message if option editing is
 138         disabled.  Defaults to blank.
 139
 140
 141 MENU PASSPROMPT message
 142
 143         Replaces the message "Password required".
 144
 145
 146 MENU COLOR element ansi foreground background shadow
 147
 148         Sets the color of element "element" to the specified color
 149         sequence:
 150
 151         screen          Rest of the screen
 152         border          Border area
 153         title           Title bar
 154         unsel           Unselected menu item
 155         hotkey          Unselected hotkey
 156         sel             Selection bar
 157         hotsel          Selected hotkey
 158         scrollbar       Scroll bar
 159         tabmsg          Press [Tab] message
 160         cmdmark         Command line marker
 161         cmdline         Command line
 162         pwdborder       Password box border
 163         pwdheader       Password box header
 164         pwdentry        Password box contents
 165         timeout_msg     Timeout message
 166         timeout         Timeout counter
 167
 168
 169         "ansi" is a sequence of semicolon-separated ECMA-48 Set
 170         Graphics Rendition (<ESC>[m) sequences:
 171
 172         0     reset all attributes to their defaults
 173         1     set bold
 174         4     set underscore (simulated with color on a color display)
 175         5     set blink
 176         7     set reverse video
 177         22    set normal intensity
 178         24    underline off
 179         25    blink off
 180         27    reverse video off
 181         30    set black foreground
 182         31    set red foreground
 183         32    set green foreground
 184         33    set brown foreground
 185         34    set blue foreground
 186         35    set magenta foreground
 187         36    set cyan foreground
 188         37    set white foreground
 189         38    set underscore on, set default foreground color
 190         39    set underscore off, set default foreground color
 191         40    set black background
 192         41    set red background
 193         42    set green background
 194         43    set brown background
 195         44    set blue background
 196         45    set magenta background
 197         46    set cyan background
 198         47    set white background
 199         49    set default background color
 200
 201         These are used (a) in text mode, and (b) on the serial
 202         console.
 203
 204
 205         "foreground" and "background" are color codes in #AARRGGBB
 206         notation, where AA RR GG BB are hexadecimal digits for alpha
 207         (opacity), red, green and blue, respectively.  #00000000
 208         represents fully transparent, and #ffffffff represents opaque
 209         white.
 210
 211
 212         "shadow" controls the handling of the graphical console text
 213         shadow.  Permitted values are "none" (no shadowing), "std" or
 214         "standard" (standard shadowing - foreground pixels are
 215         raised), "all" (both background and foreground raised), and
 216         "rev" or "reverse" (background pixels are raised.)
 217
 218
 219         If any field is set to "*" or omitted (at the end of the line)
 220         then that field is left unchanged.
 221
 222
 223         The current defaults are:
 224
 225         menu color screen       37;40      #80ffffff #00000000 std
 226         menu color border       30;44      #40000000 #00000000 std
 227         menu color title        1;36;44    #c00090f0 #00000000 std
 228         menu color unsel        37;44      #90ffffff #00000000 std
 229         menu color hotkey       1;37;44    #ffffffff #00000000 std
 230         menu color sel          7;37;40    #e0000000 #20ff8000 all
 231         menu color hotsel       1;7;37;40  #e0400000 #20ff8000 all
 232         menu color scrollbar    30;44      #40000000 #00000000 std
 233         menu color tabmsg       31;40      #90ffff00 #00000000 std
 234         menu color cmdmark      1;36;40    #c000ffff #00000000 std
 235         menu color cmdline      37;40      #c0ffffff #00000000 std
 236         menu color pwdborder    30;47      #80ffffff #20ffffff std
 237         menu color pwdheader    31;47      #80ff8080 #20ffffff std
 238         menu color pwdentry     30;47      #80ffffff #20ffffff std
 239         menu color timeout_msg  37;40      #80ffffff #00000000 std
 240         menu color timeout      1;37;40    #c0ffffff #00000000 std
 241
 242
 243 MENU WIDTH 80
 244 MENU MARGIN 10
 245 MENU PASSWORDMARGIN 3
 246 MENU ROWS 12
 247 MENU TABMSGROW 18
 248 MENU CMDLINEROW 18
 249 MENU ENDROW 24
 250 MENU PASSWORDROW 11
 251 MENU TIMEOUTROW 20
 252
 253         These options control the layout of the menu on the screen.
 254         The values above are the defaults.
 255
 256
 257 The menu system honours the TIMEOUT command; if TIMEOUT is specified
 258 it will execute the ONTIMEOUT command if one exists, otherwise it will
 259 pick the default menu option.
 260
 261 Normally, the user can press [Tab] to edit the menu entry, and [Esc]
 262 to return to the SYSLINUX command line.  However, if the configuration
 263 file specifies ALLOWOPTIONS 0, these keys will be disabled, and if
 264 MENU MASTER PASSWD is set, they require the master password.
 265
 266 The simple menu system supports serial console, using the normal
 267 SERIAL directive.  However, it can be quite slow over a slow serial
 268 link; you probably want to set your baudrate to 38400 or higher if
 269 possible.  It requires a Linux/VT220/ANSI-compatible terminal on the
 270 other end.
 271
 272
 273         +++ USING AN ALTERNATE CONFIGURATION FILE +++
 274
 275
 276 It is also possible to load a secondary configuration file, to get to
 277 another menu.  To do that, invoke menu.c32 with the name of the
 278 secondary configuration file.
 279
 280 LABEL othermenu
 281         MENU LABEL Another Menu
 282         KERNEL menu.c32
 283         APPEND othermenu.conf
 284
 285 If you specify more than one file, they will all be read, in the order
 286 specified.  The dummy filename ~ (tilde) is replaced with the filename
 287 of the main configuration file.
 288
 289 # The file graphics.conf contains common color and layout commands for
 290 # all menus.
 291 LABEL othermenu
 292         MENU LABEL Another Menu
 293         KERNEL vesamenu.c32
 294         APPEND graphics.conf othermenu.conf
 295
 296 # Return to the main menu
 297 LABEL mainmenu
 298         MENU LABEL Return to Main Menu
 299         KERNEL vesamenu.c32
 300         APPEND graphics.conf ~
 301
 302 See also the MENU INCLUDE directive above.