item [--menu <menu>] [--key <key>] [--default] [<name>|--gap [<text>]]
item [--form <form>] [--key <key>] [--default] [--secret] [<name>|--gap [<text>]]
menu Please choose an operating system to boot item fedora Fedora Linux item win7 Windows 7 choose os
item --key f fedora Fedora Linux
item san Boot from ${root-path}
item --gap Operating systems:
item
form IPv4 networking item netX/ip IPv4 address item netX/netmask Subnet mask item netX/gateway Gateway address present
form Login credentials item email Email address item --secret password Password present
Add a menu item or form item with the specified name and display text. If no menu or form is specified, the default menu or form will be used. If a key is specified, it will be used as the shortcut key for the item. If the --default
option is specified, the item will become the default selection. If no name is provided or if the --gap
option is specified, the item will function as a separator (which cannot be selected by the user).
The name will not be displayed. For menu items, it will be used by the choose
command to indicate the selection made by the user. For form items, it will be used by the present
command to determine the setting into which the value will be stored.
The shortcut key can be specified as a character literal (such as f
) or as an extended ASCII character value. The values for special keys such as Ctrl-B
and F12
are defined in include/ipxe/keys.h within the iPXE source code. Some useful values are:
Key | Keycode |
---|---|
Ctrl-A | 0x01 |
Ctrl-B | 0x02 |
Ctrl-C | 0x03 |
… | |
Ctrl-Z | 0x1a |
F5 | 0x107e |
F6 | 0x127e |
F7 | 0x137e |
F8 | 0x147e |
F9 | 0x157e |
F10 | 0x167e |
F11 | 0x187e |
F12 | 0x197e |
Success | The menu or form item was successfully added |
---|---|
Failure | The menu or form item was not successfully added |
The display text will be truncated if necessary to fit within the available width.
Shortcut keys are not automatically displayed. You may wish to include an indication of the shortcut key within the display text. For example:
item --key f fedora Boot (F)edora item --key x winxp Boot Windows (X)P
You can specify a menu's default item either by using the --default
option when creating the menu item with the item
command, or by using the --default <name>
option when displaying the menu with the choose
command.
If you want your separator text to start with dashes, then you must use --
to prevent iPXE from attempting to interpret your separator text as an option. For example:
item --gap -- ---------------- Advanced configuration ----------------