Skip to content

Commit

Permalink
config: Specify height/width units (characters) for consoleSize
Browse files Browse the repository at this point in the history
This is pretty clear from the examples like:

  "consoleSize": {
    "height": 25,
    "width": 80
  }

But examples are not normative, so this commit makes the character
units normative.

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Apr 7, 2017
1 parent 0946333 commit 8941dda
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion config.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount

* **`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to that process, defaults to false.
As an example, if set to true on Linux a pseudoterminal pair is allocated for the container process and the pseudoterminal slave is duplicated on the container process's [standard streams][stdin.3].
* **`consoleSize`** (object, OPTIONAL) specifies the console size of the terminal if attached, containing the following properties:
* **`consoleSize`** (object, OPTIONAL) specifies the console size in characters of the terminal if attached, containing the following properties:
* **`height`** (uint, REQUIRED)
* **`width`** (uint, REQUIRED)
* **`cwd`** (string, REQUIRED) is the working directory that will be set for the executable.
Expand Down

0 comments on commit 8941dda

Please sign in to comment.