This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
cmd:read [2013/03/07 13:36] mcb30 |
cmd:read [2021/04/23 11:40] mcb30 |
||
---|---|---|---|
Line 3: | Line 3: | ||
===== Synopsis ===== | ===== Synopsis ===== | ||
- | read <setting> | + | read [--timeout <timeout>] <setting> |
===== Examples ===== | ===== Examples ===== | ||
Line 26: | Line 26: | ||
===== Description ===== | ===== Description ===== | ||
- | Set value of the specified configuration [[:settings|setting]] to the value provided by the user. | + | Set value of the specified configuration [[:settings|setting]] to the value provided by the user, waiting for the specified timeout (in milliseconds). If no timeout is explicitly specified, or if a zero timeout is specified, then iPXE will wait indefinitely. |
The value will be interpreted according to the type specified as part of the setting name. For example, to prompt the user to enter a configuration setting for an NTP server address (DHCP option 42): | The value will be interpreted according to the type specified as part of the setting name. For example, to prompt the user to enter a configuration setting for an NTP server address (DHCP option 42): | ||
Line 37: | Line 37: | ||
^ Success | The configuration setting was applied successfully | | ^ Success | The configuration setting was applied successfully | | ||
- | ^ Failure | The configuration setting was not applied successfully | | + | ^ Failure | The configuration setting was not applied successfully, or no key was pressed within the timeout period | |
===== See also ===== | ===== See also ===== |