2018-04-13 19:48:26 -04:00
|
|
|
There are a set of special keys available. If these are in your boot
|
|
|
|
|
command, they will be replaced by the proper key:
|
|
|
|
|
|
|
|
|
|
- `<bs>` - Backspace
|
|
|
|
|
|
|
|
|
|
- `<del>` - Delete
|
|
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<enter> <return>` - Simulates an actual "enter" or "return" keypress.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
|
|
|
|
- `<esc>` - Simulates pressing the escape key.
|
|
|
|
|
|
|
|
|
|
- `<tab>` - Simulates pressing the tab key.
|
|
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<f1> - <f12>` - Simulates pressing a function key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<up> <down> <left> <right>` - Simulates pressing an arrow key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
|
|
|
|
- `<spacebar>` - Simulates pressing the spacebar.
|
|
|
|
|
|
|
|
|
|
- `<insert>` - Simulates pressing the insert key.
|
|
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<home> <end>` - Simulates pressing the home and end keys.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<pageUp> <pageDown>` - Simulates pressing the page up and page down keys.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-18 19:55:32 -04:00
|
|
|
- `<menu>` - Simulates pressing the Menu key.
|
|
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<leftAlt> <rightAlt>` - Simulates pressing the alt key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<leftCtrl> <rightCtrl>` - Simulates pressing the ctrl key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<leftShift> <rightShift>` - Simulates pressing the shift key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<leftSuper> <rightSuper>` - Simulates pressing the ⌘ or Windows key.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<wait> <wait5> <wait10>` - Adds a 1, 5 or 10 second pause before
|
|
|
|
|
sending any additional keys. This is useful if you have to generally wait
|
|
|
|
|
for the UI to update before typing more.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
- `<waitXX>` - Add an arbitrary pause before sending any additional keys. The
|
2018-04-16 17:03:54 -04:00
|
|
|
format of `XX` is a sequence of positive decimal numbers, each with
|
|
|
|
|
optional fraction and a unit suffix, such as `300ms`, `1.5h` or `2h45m`.
|
2018-04-13 23:08:22 -04:00
|
|
|
Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. For example
|
|
|
|
|
`<wait10m>` or `<wait1m20s>`
|
2018-04-13 19:48:26 -04:00
|
|
|
|
|
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
### On/Off variants
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
Any printable keyboard character, and of these "special" expressions, with the
|
|
|
|
|
exception of the `<wait>` types, can also be toggled on or off. For example, to
|
|
|
|
|
simulate ctrl+c, use `<leftCtrlOn>c<leftCtrlOff>`. Be sure to release them,
|
|
|
|
|
otherwise they will be held down until the machine reboots.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
To hold the `c` key down, you would use `<cOn>`. Likewise, `<cOff>` to release.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
2018-04-13 23:08:22 -04:00
|
|
|
### Templates inside boot command
|
2018-04-13 19:48:26 -04:00
|
|
|
|
|
|
|
|
In addition to the special keys, each command to type is treated as a
|
|
|
|
|
[template engine](/docs/templates/engine.html). The
|
|
|
|
|
available variables are:
|
|
|
|
|
|
|
|
|
|
- `HTTPIP` and `HTTPPort` - The IP and port, respectively of an HTTP server
|
|
|
|
|
that is started serving the directory specified by the `http_directory`
|
|
|
|
|
configuration parameter. If `http_directory` isn't specified, these will be
|
|
|
|
|
blank!
|
2018-04-14 16:00:43 -04:00
|
|
|
- `Name` - The name of the VM.
|
2018-04-13 19:48:26 -04:00
|
|
|
|
|
|
|
|
For more examples of various boot commands, see the sample projects from our
|
|
|
|
|
[community templates page](/community-tools.html#templates).
|
|
|
|
|
|
