Skip to content

7124: add documentation for the new launch modes #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kayla Cinnamon (cinnamon-msft) merged 4 commits into from
Nov 10, 2020
Merged

7124: add documentation for the new launch modes #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32803a0
7124: add documentation for the new launch modes
Don-Vito Oct 9, 2020
049a1f4
7124: document new command line options for focus mode
Don-Vito Oct 10, 2020
c227da4
7124: fix typo
Don-Vito Oct 13, 2020
7a10c7b
7124: add version notes
Don-Vito Oct 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions TerminalDocs/command-line-arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ Below is the full list of supported commands and options for the `wt` command li
| `--help`, `-h`, `-?`, `/?` | Displays the help message. |
| `--maximized`, `-M` | Launches the terminal maximized. |
| `--fullscreen`, `-F` | Launches the terminal as full screen. |
| `--focus`, `-f` | Launches the terminal in the focus mode. Can be combined with `maximized`. |
Comment thread
Don-Vito marked this conversation as resolved.
Resolved

> [!IMPORTANT]
> The `--focus` flag is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), version 1.5+.

| Command | Parameters | Description |
| ------- | ---------- | ----------- |
Expand Down
15 changes: 9 additions & 6 deletions TerminalDocs/customize-settings/global-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,21 +176,24 @@ When set to `true`, this enables the launch of Windows Terminal at startup. Sett

**Default value:** `false`

### Launch size
### Launch mode

This defines whether the terminal will launch as maximized, full screen, or in a window.
This defines whether the terminal will launch as maximized, full screen, or in a window. Setting this to `focus` is equivalent to launching the terminal in the `default` mode, but with the focus mode enabled. Similar, setting this to `maximizedFocus` will result in launching the terminal in a maximized window w ith the focus mode enabled.

**Property name:** `launchMode`

**Necessity:** Optional

**Accepts:** `"default"`, `"maximized"`, `"fullscreen"`
**Accepts:** `"default"`, `"maximized"`, `"fullscreen"`, `"focus"`, `"maximizedFocus"`

**Default value:** `"default"`
Comment thread
Don-Vito marked this conversation as resolved.
Resolved

> [!IMPORTANT]
> The `"focus"` and `"maximizedFocus"` modes are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), version 1.5+.

### Launch position

This sets the pixel position of the top left corner of the window upon first load. On a system with multiple displays, these coordinates are relative to the top left of the primary display. If an X or Y coordinate is not provided, the terminal will use the system default for that value. If `launchMode` is set to `"maximized"`, the window will be maximized on the monitor specified by those coordinates.
This sets the pixel position of the top left corner of the window upon first load. On a system with multiple displays, these coordinates are relative to the top left of the primary display. If an X or Y coordinate is not provided, the terminal will use the system default for that value. If `launchMode` is set to `"maximized"` (or `"maximizedFocus"`), the window will be maximized on the monitor specified by those coordinates.

**Property name:** `initialPosition`

Expand All @@ -202,7 +205,7 @@ This sets the pixel position of the top left corner of the window upon first loa

### Columns on first launch

This is the number of character columns displayed in the window upon first load. If `launchMode` is set to `"maximized"`, this property is ignored.
This is the number of character columns displayed in the window upon first load. If `launchMode` is set to `"maximized"` (or `"maximizedFocus"`), this property is ignored.

**Property name:** `initialCols`

Expand All @@ -214,7 +217,7 @@ This is the number of character columns displayed in the window upon first load.

### Rows on first launch

This is the number of rows displayed in the window upon first load. If `launchMode` is set to `"maximized"`, this property is ignored.
This is the number of rows displayed in the window upon first load. If `launchMode` is set to `"maximized"` (or `"maximizedFocus"`), this property is ignored.

**Property name:** `initialRows`

Expand Down