From c753391f43a506d24043708743acd13446b04b60 Mon Sep 17 00:00:00 2001 From: Matthew Hooker Date: Fri, 13 Apr 2018 20:08:22 -0700 Subject: [PATCH] fill out and reformat the boot command docs --- .../partials/builders/_boot-command.html.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/website/source/partials/builders/_boot-command.html.md b/website/source/partials/builders/_boot-command.html.md index e4e206cae..a8dc570a0 100644 --- a/website/source/partials/builders/_boot-command.html.md +++ b/website/source/partials/builders/_boot-command.html.md @@ -5,54 +5,53 @@ command, they will be replaced by the proper key: - `` - Delete -- `` and `` - Simulates an actual "enter" or "return" keypress. +- ` ` - Simulates an actual "enter" or "return" keypress. - `` - Simulates pressing the escape key. - `` - Simulates pressing the tab key. -- `` - `` - Simulates pressing a function key. +- ` - ` - Simulates pressing a function key. -- `` `` `` `` - Simulates pressing an arrow key. +- ` ` - Simulates pressing an arrow key. - `` - Simulates pressing the spacebar. - `` - Simulates pressing the insert key. -- `` `` - Simulates pressing the home and end keys. +- ` ` - Simulates pressing the home and end keys. -- `` `` - Simulates pressing the page up and page down keys. +- ` ` - Simulates pressing the page up and page down keys. -- `` `` - Simulates pressing the alt key. +- ` ` - Simulates pressing the alt key. -- `` `` - Simulates pressing the ctrl key. +- ` ` - Simulates pressing the ctrl key. -- `` `` - Simulates pressing the shift key. +- ` ` - Simulates pressing the shift key. -- `` `` - Simulates pressing and holding the alt key. +- ` ` - Simulates pressing the ⌘ or Windows key. -- `` `` - Simulates pressing and holding the ctrl key. - -- `` `` - Simulates pressing and holding the shift key. - -- `` `` - Simulates releasing a held alt key. +- ` ` - 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. -- `` `` - Simulates releasing a held ctrl key. +- `` - Add an arbitrary pause before sending any additional keys. The + 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 + `` or `` -- `` `` - Simulates releasing a held shift key. -- `` `` `` - 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. +### On/Off variants -- `` - Add user defined time.Duration pause before sending any - additional keys. For example `` or `` +Any printable keyboard character, and of these "special" expressions, with the +exception of the `` types, can also be toggled on or off. For example, to +simulate ctrl+c, use `c`. Be sure to release them, +otherwise they will be held down until the machine reboots. -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. +To hold the `c` key down, you would use ``. Likewise, `` to release. -For example: to simulate ctrl+c use `c`. +### Templates inside boot command In addition to the special keys, each command to type is treated as a [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` configuration parameter. If `http_directory` isn't specified, these will be blank! +* `Name` - The name of the VM. For more examples of various boot commands, see the sample projects from our [community templates page](/community-tools.html#templates).