This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
cmd:prompt [2011/03/07 20:34] mcb30 |
cmd:prompt [2012/03/28 23:32] mcb30 |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Prompt the user to press a key ====== | + | ====== Prompt user to press key ====== |
===== Synopsis ===== | ===== Synopsis ===== | ||
- | prompt [--key <keycode>] [--timeout <timeout>] [<text>] | + | prompt [--key <key>] [--timeout <timeout>] [<text>] |
===== Examples ===== | ===== Examples ===== | ||
Line 14: | Line 14: | ||
prompt Press any key to continue | prompt Press any key to continue | ||
+ | |||
+ | === Exit script if 'q' is pressed === | ||
+ | |||
+ | prompt --key q Press 'q' to quit && exit || | ||
=== Exit script unless F12 is pressed within 2 seconds === | === Exit script unless F12 is pressed within 2 seconds === | ||
Line 31: | Line 35: | ||
The displayed text will be cleared when the user presses a key, or if the timeout expires. | The displayed text will be cleared when the user presses a key, or if the timeout expires. | ||
- | The keycodes used for the ''--key'' option are extended ASCII character values. The values for special keys such as ''Ctrl-B'' and ''F12'' are defined in [[http://git.ipxe.org/ipxe.git/blob/HEAD:/src/include/ipxe/keys.h|include/ipxe/keys.h]] within the iPXE source code. Some useful values are: | + | The ''%%--key%%'' option can be specified as a character literal (such as ''q'' or ''@'') or as an extended ASCII character value. The values for special keys such as ''Ctrl-B'' and ''F12'' are defined in [[http://git.ipxe.org/ipxe.git/blob/HEAD:/src/include/ipxe/keys.h|include/ipxe/keys.h]] within the iPXE source code. Some useful values are: |
^ Key ^ Keycode | | ^ Key ^ Keycode | |