fill out and reformat the boot command docs

This commit is contained in:
Matthew Hooker 2018-04-13 20:08:22 -07:00
parent f5b09c8c38
commit c753391f43
No known key found for this signature in database
GPG Key ID: 7B5F933D9CE8C6A1
1 changed files with 26 additions and 26 deletions

View File

@ -5,54 +5,53 @@ command, they will be replaced by the proper key:
- `<del>` - Delete - `<del>` - Delete
- `<enter>` and `<return>` - Simulates an actual "enter" or "return" keypress. - `<enter> <return>` - Simulates an actual "enter" or "return" keypress.
- `<esc>` - Simulates pressing the escape key. - `<esc>` - Simulates pressing the escape key.
- `<tab>` - Simulates pressing the tab key. - `<tab>` - Simulates pressing the tab key.
- `<f1>` - `<f12>` - Simulates pressing a function key. - `<f1> - <f12>` - Simulates pressing a function key.
- `<up>` `<down>` `<left>` `<right>` - Simulates pressing an arrow key. - `<up> <down> <left> <right>` - Simulates pressing an arrow key.
- `<spacebar>` - Simulates pressing the spacebar. - `<spacebar>` - Simulates pressing the spacebar.
- `<insert>` - Simulates pressing the insert key. - `<insert>` - Simulates pressing the insert key.
- `<home>` `<end>` - Simulates pressing the home and end keys. - `<home> <end>` - Simulates pressing the home and end keys.
- `<pageUp>` `<pageDown>` - Simulates pressing the page up and page down keys. - `<pageUp> <pageDown>` - Simulates pressing the page up and page down keys.
- `<leftAlt>` `<rightAlt>` - Simulates pressing the alt key. - `<leftAlt> <rightAlt>` - Simulates pressing the alt key.
- `<leftCtrl>` `<rightCtrl>` - Simulates pressing the ctrl key. - `<leftCtrl> <rightCtrl>` - Simulates pressing the ctrl key.
- `<leftShift>` `<rightShift>` - Simulates pressing the shift key. - `<leftShift> <rightShift>` - Simulates pressing the shift key.
- `<leftAltOn>` `<rightAltOn>` - Simulates pressing and holding the alt key. - `<leftSuper> <rightSuper>` - Simulates pressing the ⌘ or Windows key.
- `<leftCtrlOn>` `<rightCtrlOn>` - Simulates pressing and holding the ctrl key. - `<wait> <wait5> <wait10>` - Adds a 1, 5 or 10 second pause before
- `<leftShiftOn>` `<rightShiftOn>` - Simulates pressing and holding the shift key.
- `<leftAltOff>` `<rightAltOff>` - Simulates releasing a held alt key.
- `<leftCtrlOff>` `<rightCtrlOff>` - Simulates releasing a held ctrl key.
- `<leftShiftOff>` `<rightShiftOff>` - Simulates releasing a held shift key.
- `<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 sending any additional keys. This is useful if you have to generally wait
for the UI to update before typing more. for the UI to update before typing more.
- `<waitXX>` - Add user defined time.Duration pause before sending any - `<waitXX>` - Add an arbitrary pause before sending any additional keys. The
additional keys. For example `<wait10m>` or `<wait1m20s>` format of `XX` is a possibly signed sequence of decimal numbers, each with
optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`.
Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. For example
`<wait10m>` or `<wait1m20s>`
When using modifier keys `ctrl`, `alt`, `shift` ensure that you release them,
otherwise they will be held down until the machine reboots. Use lowercase
characters as well inside modifiers.
For example: to simulate ctrl+c use `<leftCtrlOn>c<leftCtrlOff>`. ### On/Off variants
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.
To hold the `c` key down, you would use `<cOn>`. Likewise, `<cOff>` to release.
### Templates inside boot command
In addition to the special keys, each command to type is treated as a In addition to the special keys, each command to type is treated as a
[template engine](/docs/templates/engine.html). The [template engine](/docs/templates/engine.html). The
@ -62,6 +61,7 @@ available variables are:
that is started serving the directory specified by the `http_directory` that is started serving the directory specified by the `http_directory`
configuration parameter. If `http_directory` isn't specified, these will be configuration parameter. If `http_directory` isn't specified, these will be
blank! blank!
* `Name` - The name of the VM.
For more examples of various boot commands, see the sample projects from our For more examples of various boot commands, see the sample projects from our
[community templates page](/community-tools.html#templates). [community templates page](/community-tools.html#templates).