Skip to content

Commit 8fa6e80

Browse files
Merge pull request #64 from MicrosoftDocs/release-1.1
2 parents 11563c3 + 0f00825 commit 8fa6e80

File tree

12 files changed

+180
-16
lines changed

12 files changed

+180
-16
lines changed

TerminalDocs/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
href: panes.md
2525
- name: Cascadia Code
2626
href: cascadia-code.md
27+
- name: Tips and tricks
28+
href: tips-and-tricks.md
2729
- name: Tutorials
2830
items:
2931
- name: Powerline setup

TerminalDocs/command-line-arguments.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Windows Terminal command-line arguments
33
description: Learn how to create command-line arguments for Windows Terminal.
44
author: cinnamon-msft
55
ms.author: cinnamon
6-
ms.date: 05/19/2020
6+
ms.date: 06/18/2020
77
ms.topic: how-to
88
ms.service: terminal
99
---
@@ -34,13 +34,21 @@ Below is the full list of supported commands and options for the `wt` command li
3434
| Option | Description |
3535
| ------ | ----------- |
3636
| `--help`, `-h`, `-?`, `/?` | Displays the help message. |
37+
| `--maximized`, `-M` | Launches the terminal maximized. |
38+
| `--fullscreen`, `-F` | Launches the terminal as full screen. |
39+
40+
> [!IMPORTANT]
41+
> `--maximized`, `-M` and `--fullscreen`, `-F` are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
3742
3843
| Command | Parameters | Description |
3944
| ------- | ---------- | ----------- |
40-
| `new-tab` | `--profile, -p profile-name`, `--startingDirectory, -d starting-directory`, `commandline` | Creates a new tab. |
41-
| `split-pane` | `-H, --horizontal`, `-V, --vertical`, `--profile, -p profile-name`, `--startingDirectory, -d starting-directory`, `commandline` | Splits a new pane. |
45+
| `new-tab` | `--profile, -p profile-name`, `--startingDirectory, -d starting-directory`, `commandline`, `--title` | Creates a new tab. |
46+
| `split-pane` | `-H, --horizontal`, `-V, --vertical`, `--profile, -p profile-name`, `--startingDirectory, -d starting-directory`, `commandline`, `--title` | Splits a new pane. |
4247
| `focus-tab` | `--target, -t tab-index` | Focuses on a specific tab. |
4348

49+
> [!IMPORTANT]
50+
> `--title` is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
51+
4452
## Command line argument examples
4553

4654
Commands may vary slightly depending on which command line you're using.
@@ -193,6 +201,37 @@ Execution aliases do not work in WSL distributions. If you want to use wt.exe fr
193201

194202
The `-H` flag (or `--horizontal`) indicates that you would like the panes to be split horizontally. The `-V` flag (or `--vertical`) indicates that you would like the panes split vertically.
195203

204+
### Tab title ([Preview](https://aka.ms/terminal-preview/))
205+
206+
To open a new terminal instance with custom tab titles, use the `--title` argument. To set the title of each tab when opening two tabs, enter:
207+
208+
<!-- Start tab selectors. -->
209+
#### [Command Prompt](#tab/windows)
210+
211+
```bash
212+
wt --title tabname1 ; new-tab -p "Ubuntu-18.04" --title tabname2
213+
```
214+
215+
#### [PowerShell](#tab/powershell)
216+
217+
```powershell
218+
wt --title tabname1 `; new-tab -p "Ubuntu-18.04" --title tabname2
219+
```
220+
221+
#### [Linux](#tab/linux)
222+
223+
```bash
224+
cmd.exe /c "wt.exe" --title tabname1 \; new-tab -p "Ubuntu-18.04" --title tabname2
225+
```
226+
227+
Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running `cmd.exe`. The `/c` option tells CMD to terminate after running and the `\;` forward-slash + semicolon separates commands.
228+
229+
---
230+
<!-- End tab selectors. -->
231+
232+
> [!IMPORTANT]
233+
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
234+
196235
### Tab focus
197236

198237
To open a new terminal instance with a specific tab in focus, use the `-t` flag (or `--target`), along with the tab-index number. To open your default profile in the first tab and the "Ubuntu-18.04" profile focused in the second tab (`-t 1`), enter:

TerminalDocs/customize-settings/global-settings.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Windows Terminal Global Settings
33
description: Learn how to customize the global settings within Windows Terminal.
44
author: cinnamon-msft
55
ms.author: cinnamon
6-
ms.date: 05/19/2020
6+
ms.date: 06/18/2020
77
ms.topic: how-to
88
ms.service: terminal
99
ms.localizationpriority: high
@@ -21,10 +21,13 @@ Set the default profile that opens by typing <kbd>ctrl+shift+t</kbd>, typing the
2121

2222
**Necessity:** Required
2323

24-
**Accepts:** GUID as a string
24+
**Accepts:** GUID or profile name as a string
2525

2626
**Default value:** PowerShell's GUID
2727

28+
> [!IMPORTANT]
29+
> Using the profile name for `defaultProfile` is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
30+
2831
<br />
2932

3033
___
@@ -98,13 +101,13 @@ When this is set to `true`, tabs are always displayed. When it's set to `false`
98101

99102
:::row:::
100103
:::column span="":::
101-
This sets the width of the tabs. `"equal"` makes each tab the same width. `"titleLength"` sizes each tab to the length of its title.
104+
This sets the width of the tabs. `"equal"` makes each tab the same width. `"titleLength"` sizes each tab to the length of its title. `"compact"` will shrink every inactive tab to the width of the icon, leaving the active tab more space to display its full title.
102105

103106
**Property name:** `tabWidthMode`
104107

105108
**Necessity:** Optional
106109

107-
**Accepts:** `"equal"`, `"titleLength"`
110+
**Accepts:** `"equal"`, `"titleLength"`, `"compact"`
108111

109112
**Default value:** `"equal"`
110113

@@ -115,6 +118,9 @@ This sets the width of the tabs. `"equal"` makes each tab the same width. `"titl
115118
:::column-end:::
116119
:::row-end:::
117120

121+
> [!IMPORTANT]
122+
> The `"compact"` setting is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
123+
118124
### Hide close all tabs popup
119125

120126
:::row:::
@@ -142,18 +148,36 @@ ___
142148

143149
## Launch settings
144150

145-
### Launch maximized
151+
### Launch on startup ([Preview](https://aka.ms/terminal-preview/))
152+
153+
When set to `true`, this enables the launch of Windows Terminal at startup. Setting this to `false` will disable the startup task entry. Note: if the Windows Terminal startup task entry is disabled either by org policy or by user action this setting will have no effect.
154+
155+
**Property name:** `startOnUserLogin`
146156

147-
This defines whether the terminal will launch as maximized to fill the entire screen or in a window.
157+
**Necessity:** Optional
158+
159+
**Accepts:** `true`, `false`
160+
161+
**Default value:** `false`
162+
163+
> [!IMPORTANT]
164+
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
165+
166+
### Launch size
167+
168+
This defines whether the terminal will launch as maximized, fullscreen, or in a window.
148169

149170
**Property name:** `launchMode`
150171

151172
**Necessity:** Optional
152173

153-
**Accepts:** `"default"`, `"maximized"`
174+
**Accepts:** `"default"`, `"maximized"`, `"fullscreen"`
154175

155176
**Default value:** `"default"`
156177

178+
> [!IMPORTANT]
179+
> The `"fullscreen"` setting is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
180+
157181
### Launch position
158182

159183
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.

TerminalDocs/customize-settings/key-bindings.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Windows Terminal Key Bindings
33
description: Learn how to create custom key bindings for Windows Terminal.
44
author: cinnamon-msft
55
ms.author: cinnamon
6-
ms.date: 05/19/2020
6+
ms.date: 06/18/2020
77
ms.topic: how-to
88
ms.service: terminal
99
ms.localizationpriority: high
@@ -150,18 +150,28 @@ This opens the dropdown menu.
150150
{ "command": "openNewTabDropdown", "keys": "ctrl+shift+space" }
151151
```
152152

153-
### Open settings file
153+
### Open settings files
154154

155-
This opens the settings file.
155+
This opens either the default or custom settings files. Without the `target` field, this will open the settings.json file.
156156

157157
**Command name:** `openSettings`
158158

159159
**Default binding:**
160160

161161
```json
162-
{ "command": "openSettings", "keys": "ctrl+," }
162+
{ "command": "openSettings", "keys": "ctrl+," },
163+
{ "command": { "action": "openSettings", "target": "defaultsFile" }, "keys": "ctrl+alt+," },
163164
```
164165

166+
#### Actions
167+
168+
| Name | Necessity | Accepts | Description |
169+
| ---- | --------- | ------- | ----------- |
170+
| `target` | Optional | `"settingsFile"`, `"defaultsFile"`, `"allFiles"` | The settings file to open. |
171+
172+
> [!IMPORTANT]
173+
> The `target` field is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
174+
165175
### Toggle full screen
166176

167177
This allows you to switch between full screen and default window sizes.

TerminalDocs/customize-settings/profile-settings.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Windows Terminal Profile Settings
33
description: Learn how to customize the individual profiles within Windows Terminal.
44
author: cinnamon-msft
55
ms.author: cinnamon
6-
ms.date: 05/19/2020
6+
ms.date: 06/18/2020
77
ms.topic: how-to
88
ms.service: terminal
99
ms.localizationpriority: high
@@ -174,6 +174,21 @@ This sets the profile's font size in points.
174174

175175
**Default value:** `12`
176176

177+
### Font weight ([Preview](https://aka.ms/terminal-preview/))
178+
179+
This sets the weight (lightness or heaviness of the strokes) for the profile's font.
180+
181+
**Property name:** `fontWeight`
182+
183+
**Necessity:** Optional
184+
185+
**Accepts:** `"normal"`, `"thin"`, `"extra-light"`, `"light"`, `"semi-light"`, `"medium"`, `"semi-bold"`, `"bold"`, `"extra-bold"`, `"black"`, `"extra-black"`, or an integer corresponding to the numeric representation of the OpenType font weight
186+
187+
**Default value:** `"normal"`
188+
189+
> [!IMPORTANT]
190+
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
191+
177192
### Padding
178193

179194
:::row:::
@@ -251,6 +266,27 @@ This sets the percentage height of the cursor starting from the bottom. This wil
251266

252267
___
253268

269+
## Keyboard settings
270+
271+
### AltGr aliasing ([Preview](https://aka.ms/terminal-preview/))
272+
273+
This allows you to control if Windows Terminal will treat <kbd>ctrl+alt</kbd> as an alias for <kbd>AltGr</kbd>.
274+
275+
**Property name:** `altGrAliasing`
276+
277+
**Necessity:** Optional
278+
279+
**Accepts:** `true`, `false`
280+
281+
**Default value:** `true`
282+
283+
> [!IMPORTANT]
284+
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
285+
286+
<br />
287+
288+
___
289+
254290
## Color settings
255291

256292
### Color scheme

TerminalDocs/docfx.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
{
2525
"files": [
2626
"**/*.png",
27+
"**/*.gif",
2728
"**/*.jpg"
2829
],
2930
"exclude": [
1.1 MB
Loading

TerminalDocs/images/tab-color.png

27.1 KB
Loading

TerminalDocs/images/tab-rename.gif

530 KB
Loading
-103 KB
Loading

0 commit comments

Comments
 (0)