This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
cmd:item [2012/03/29 13:19] mcb30 |
cmd:item [2012/03/29 13:38] mcb30 |
||
---|---|---|---|
Line 32: | Line 32: | ||
===== Description ===== | ===== Description ===== | ||
- | Add a menu item with the specified label and display text. If no menu is specified, the default (unnamed) menu will be used. If a key is specified, it will be used as the shortcut key for the menu item. If the ''%%--default%%'' option is specified, the menu item will become the default selection. If no label is provided or if the ''%%--gap%%'' option is specified, the menu item will function as a menu separator (which cannot ever be selected). | + | Add a menu item with the specified label and display text. If no menu is specified, the default (unnamed) menu will be used. If a key is specified, it will be used as the shortcut key for the menu item. If the ''%%--default%%'' option is specified, the menu item will become the default selection. If no label is provided or if the ''%%--gap%%'' option is specified, the menu item will function as a menu separator (which cannot be selected by the user). |
The label will not be displayed. It will be used by the ''[[:cmd:choose]]'' command to indicate the selection made by the user. | The label will not be displayed. It will be used by the ''[[:cmd:choose]]'' command to indicate the selection made by the user. | ||
Line 66: | Line 66: | ||
===== Notes ===== | ===== Notes ===== | ||
+ | |||
+ | The display text will be truncated if necssary 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: | 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 Boot (F)edora | + | item --key f fedora Boot (F)edora |
- | item --key x Boot Windows (X)P | + | item --key x winxp Boot Windows (X)P |
If you want your menu 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: | If you want your menu 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: |