Skip to content

Commit

Permalink
Merge pull request #176 from MicrosoftDocs/cinnamon/release-1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@cinnamon-msft
cinnamon-msft authored Nov 11, 2020
2 parents 310b63f + c9aa4ed commit 9508aee
Show file tree
Hide file tree
Showing 8 changed files with 95 additions and 51 deletions.
4 changes: 2 additions & 2 deletions TerminalDocs/command-line-arguments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal command-line arguments
description: Learn how to create command-line arguments for Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 08/26/2020
ms.date: 11/11/2020
ms.topic: how-to
---

Expand Down Expand Up @@ -38,7 +38,7 @@ Below is the full list of supported commands and options for the `wt` command li
| `--focus`, `-f` | Launches the terminal in the focus mode. Can be combined with `maximized`. |

> [!IMPORTANT]
> The `--focus` flag is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), version 1.5+.
> The `--focus` and `-f` flags are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
| Command | Parameters | Description |
| ------- | ---------- | ----------- |
Expand Down
4 changes: 2 additions & 2 deletions TerminalDocs/command-palette.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Command Palette
description: Learn how to use the command palette in the Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 09/22/2020
ms.date: 11/11/2020
ms.topic: how-to
ms.localizationpriority: high
---
Expand All @@ -22,7 +22,7 @@ You can invoke the command palette by typing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<k

## Command line mode

If you'd like to enter a `wt` command into the command palette, you can do so by starting with the `>` character. This will run the `wt` command in the current window. More information on `wt` commands can be found on the [Command line arguments page](./command-line-arguments.md).
If you'd like to enter a `wt` command into the command palette, you can do so by deleting the `>` character in the text box. This will run the `wt` command in the current window. More information on `wt` commands can be found on the [Command line arguments page](./command-line-arguments.md).

![Windows Terminal command line mode](./images/command-palette-command-line-mode.gif)

Expand Down
46 changes: 34 additions & 12 deletions TerminalDocs/customize-settings/actions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Actions
description: Learn how to create custom actions for Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 09/22/2020
ms.date: 11/11/2020
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -445,11 +445,9 @@ _This command is not currently bound in the default settings_.
| ---- | --------- | ------- | ----------- |
| `title` | Optional | String | The new title to use for this tab. If omitted, this command will revert the tab title back to its original value. |

### Open tab renamer
### Open tab rename text box ([Preview](https://aka.ms/terminal-preview))

This command changes the tab title into a text field that lets you edit the title for the current tab.

Clearing the text field will reset the tab title back to the default for the current shell instance.
This command changes the tab title into a text field that lets you edit the title for the current tab. Clearing the text field will reset the tab title back to the default for the current shell instance.

**Command name:** `openTabRenamer`

Expand All @@ -461,6 +459,9 @@ _This command is not currently bound in the default settings_.
{ "command": "openTabRenamer", "keys": "ctrl+alt+a" }
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Change tab color

This command can be used to change the color of a tab to a specific value.
Expand All @@ -479,7 +480,7 @@ _This command is not currently bound in the default settings_.
{ "command": { "action": "setTabColor", "color": null }, "keys": "" }
```

#### Arguments
#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
Expand Down Expand Up @@ -536,7 +537,7 @@ This changes focus to a different pane depending on the direction.
| ---- | --------- | ------- | ----------- |
| `direction` | Required | `"left"`, `"right"`, `"up"`, `"down"` | Direction in which the focus will move. |

### Zoom a pane
### Zoom a pane ([Preview](https://aka.ms/terminal-preview))

:::row:::
:::column span="":::
Expand All @@ -557,6 +558,9 @@ This expands the focused pane to fill the entire contents of the window.
:::column-end:::
:::row-end:::

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Resize a pane

This changes the size of the active pane.
Expand Down Expand Up @@ -630,12 +634,12 @@ This copies the selected terminal content to your clipboard.
{ "command": { "action": "copy", "singleLine": false }, "keys": "ctrl+insert" }
```

#### Clipboard Actions
#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `singleLine` | Optional | `true`, `false` | When `true`, the copied content will be copied as a single line. When `false`, newlines persist from the selected text. |
| `copyFormatting` | Optional | `true`, `false`, `"all"`, `"none"`, `"html"`, `"rtf"` | When `true`, the color and font formatting of the selected text is also copied to your clipboard. When `false`, only plain text is copied to your clipboard. You can also specify which formats you would like to copy. When `null`, the global `copyFormatting` behavior is inherited. |
| `copyFormatting` | Optional | `true`, `false`, `"all"`, `"none"`, `"html"`, `"rtf"` | When `true`, the color and font formatting of the selected text is also copied to your clipboard. When `false`, only plain text is copied to your clipboard. You can also specify which formats you would like to copy. When `null`, the global `"copyFormatting"` behavior is inherited. |

### Paste

Expand All @@ -662,7 +666,7 @@ ___

### Scroll up

This scrolls the screen up.
This scrolls the screen up by the number of rows defined by `"rowsToScroll"`. If `"rowsToScroll"` is not provided, it will scroll up the amount defined by the system default, which is the same amount as mouse scrolling.

**Command name:** `scrollUp`

Expand All @@ -672,9 +676,18 @@ This scrolls the screen up.
{ "command": "scrollUp", "keys": "ctrl+shift+up" }
```

#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `rowsToScroll` | Optional | Integer | The number of rows to scroll. |

> [!IMPORTANT]
> The `"rowsToScroll"` action is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Scroll down

This scrolls the screen down.
This scrolls the screen down by the number of rows defined by `"rowsToScroll"`. If `"rowsToScroll"` is not provided, it will scroll down the amount defined by the system default, which is the same amount as mouse scrolling.

**Command name:** `scrollDown`

Expand All @@ -684,6 +697,15 @@ This scrolls the screen down.
{ "command": "scrollDown", "keys": "ctrl+shift+down" }
```

#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `rowsToScroll` | Optional | Integer | The number of rows to scroll. |

> [!IMPORTANT]
> The `"rowsToScroll"` action is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Scroll up a whole page

This scrolls the screen up by a whole page, which is the height of the window.
Expand Down Expand Up @@ -763,7 +785,7 @@ Changes the active color scheme.

**Command name:** `setColorScheme`

#### Arguments
#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
Expand Down
56 changes: 39 additions & 17 deletions TerminalDocs/customize-settings/global-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Global Settings
description: Learn how to customize the global settings within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 08/26/2020
ms.date: 11/11/2020
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -72,19 +72,21 @@ ___

## Tab settings

### Use tab switcher experience
### Use tab switcher experience ([Preview](https://aka.ms/terminal-preview))

:::row:::
:::column span="":::
When this is set to `true`, the `nextTab` and `prevTab` commands will use the tab switcher UI. The UI will show all the currently open tabs in a vertical list, navigable with the keyboard or mouse.
When this is set to `true` or `"mru"`, the `nextTab` and `prevTab` commands will use the tab switcher UI, with most recently used ordering. When set to `"inOrder"`, these actions will switch tabs in their current order in the tab bar. The UI will show all the currently open tabs in a vertical list, navigable with the keyboard or mouse.

The tab switcher will open on the initial press of the actions for `nextTab` and `prevTab`, and will stay open as long as a modifier key is held down. When all modifier keys are released, the switcher will close and the highlighted tab will be focused. <kbd>tab</kbd>/<kbd>shift+tab</kbd>, the <kbd>up</kbd> and <kbd>down</kbd> arrow keys, and the `nextTab`/`prevTab` actions can be used to cycle through the switcher UI.

**Property name:** `useTabSwitcher`
To disable the tab switcher, you can set this to `false` or `"disabled"`.

**Property name:** `tabSwitcherMode`

**Necessity:** Optional

**Accepts:** `true`, `false`
**Accepts:** `true`, `false`, `"mru"`, `"inOrder"`, `"disabled"`

**Default value:** `true`

Expand All @@ -95,6 +97,26 @@ The tab switcher will open on the initial press of the actions for `nextTab` and
:::column-end:::
:::row-end:::

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Enable tab switcher

When this is set to `true`, the `nextTab` and `prevTab` commands will use the tab switcher UI. The UI will show all the currently open tabs in a vertical list, navigable with the keyboard or mouse.

The tab switcher will open on the initial press of the actions for `nextTab` and `prevTab`, and will stay open as long as a modifier key is held down. When all modifier keys are released, the switcher will close and the highlighted tab will be focused. <kbd>tab</kbd>/<kbd>shift+tab</kbd>, the <kbd>up</kbd> and <kbd>down</kbd> arrow keys, and the `nextTab`/`prevTab` actions can be used to cycle through the switcher UI.

**Property name:** `useTabSwitcher`

**Necessity:** Optional

**Accepts:** `true`, `false`

**Default value:** `true`

> [!CAUTION]
> The `"useTabSwitcher"` setting is no longer available in versions 1.5 and later. It is recommended that you use the `"tabSwitcherMode"` setting instead.
### Always show tabs

:::row:::
Expand Down Expand Up @@ -178,7 +200,7 @@ When set to `true`, this enables the launch of Windows Terminal at startup. Sett

### Launch mode

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.
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 [focus mode](./actions.md#toggle-focus-mode) enabled. Similarly, setting this to `maximizedFocus` will result in launching the terminal in a maximized window with focus mode enabled.

**Property name:** `launchMode`

Expand All @@ -189,11 +211,11 @@ This defines whether the terminal will launch as maximized, full screen, or in a
**Default value:** `"default"`

> [!IMPORTANT]
> The `"focus"` and `"maximizedFocus"` modes are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), version 1.5+.
> The `"focus"` and `"maximizedFocus"` modes are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
### 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"` (or `"maximizedFocus"`), 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 @@ -205,7 +227,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"` (or `"maximizedFocus"`), 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 @@ -217,7 +239,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"` (or `"maximizedFocus"`), 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 Expand Up @@ -354,20 +376,20 @@ When this is set to `true`, trying to paste text with multiple lines will displa

___

## Scroll speed
## Disable animations ([Preview](https://aka.ms/terminal-preview))

This is the number of rows to scroll at a time with the mouse wheel. This will override the system setting if the value is not zero or `"system"`.
This disables visual animations across the application when set to `true`.

**Property name:** `rowsToScroll`
**Property name:** `disableAnimations`

**Necessity:** Optional

**Accepts:** Integer
**Accepts:** `true`, `false`

**Default value:** `"system"`
**Default value:** `false`

> [!CAUTION]
> The `rowsToScroll` setting is no longer available versions 1.2 and later. Windows Terminal will use the value configured in the system Mouse settings panel.
> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
<br />

Expand Down
16 changes: 10 additions & 6 deletions TerminalDocs/customize-settings/profile-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Profile Settings
description: Learn how to customize the individual profiles within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 08/26/2020
ms.date: 11/11/2020
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -397,15 +397,19 @@ When `useAcrylic` is set to `true`, this sets the transparency of the window for
___

## Background image settings

### Setting the background image

This sets the file location of the image to draw over the window background. The background image can be a .jpg, .png, or .gif file. Use keyword "DesktopWallpaper" to set the path to the desktop's wallpaper.
This sets the file location of the image to draw over the window background. The background image can be a .jpg, .png, or .gif file. `"desktopWallpaper"` will set the background image to the desktop's wallpaper.

**Property name:** `backgroundImage`

**Necessity:** Optional

**Accepts:** `File location as a string`, `"DesktopWallpaper"`
**Accepts:** File location as a string or `"desktopWallpaper"`

> [!IMPORTANT]
> The `"desktopWallpaper"` setting is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Background image stretch mode

Expand Down Expand Up @@ -528,9 +532,9 @@ This sets how the profile reacts to termination or failure to launch. `"graceful

___

## Bell settings
## Bell settings ([Preview](https://aka.ms/terminal-preview))

Controls what happens when the application emits a BEL character. When set to `"audible"`, the Terminal will play a sound. When set to `"none"`, nothing will happen.
Controls what happens when the application emits a BEL character. When set to `"audible"`, the terminal will play a sound. When set to `"none"`, nothing will happen.

**Property name:** `bellStyle`

Expand All @@ -541,7 +545,7 @@ Controls what happens when the application emits a BEL character. When set to `"
**Default value:** `"audible"`

> [!IMPORTANT]
> The `"bellStyle"` setting is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), version 1.5+.
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).
<br />

Expand Down
Binary file modified TerminalDocs/images/command-palette-command-line-mode.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 6 additions & 10 deletions TerminalDocs/troubleshooting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Troubleshooting
description: Learn fixes to common obstacles in the Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 09/22/2020
ms.date: 11/11/2020
ms.topic: overview
ms.localizationpriority: high
---
Expand Down Expand Up @@ -44,10 +44,6 @@ Visit the [Command line arguments page](./command-line-arguments.md) to learn ho

Visit the [Command line arguments page](./command-line-arguments.md) to learn how command-line arguments operate in WSL.

## Hyperlinks don't work

As of Windows Terminal 1.4, [embedded hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) inside the text buffer are clickable and will open in your default browser. If a link is not a hyperlink, this means it is not an embedded hyperlink and it is simply plain text. Support for automatically detecting plain text links will arrive in a future release.

## Problem setting `startingDirectory`

If the `startingDirectory` is being ignored in your profile, first check to make sure your settings.json's syntax is correct. To help you check this syntax, `"$schema": "https://aka.ms/terminal-profiles-schema"` is automatically injected. Some applications, like [Visual Studio Code](https://code.visualstudio.com/download), can use that injected schema to validate your json file as you make edits.
Expand Down Expand Up @@ -95,7 +91,11 @@ To update to the newest version of PSReadline, please run the following command:
Update-Module PSReadline
```

### Technical Notes
## Why are my emojis not appearing as icons in the jumplist?

Only images linked from a file location can be rendered as profile icons in the jumplist. Emojis are not supported for jumplist icons.

## Technical Notes

Applications that use the [`GetConsoleScreenBufferInfo` family of APIs](https://docs.microsoft.com/windows/console/getconsolescreenbufferinfoex) to retrieve the active console colors in Win32 format and then attempt to transform them into cross-platform VT sequences (for example, by transforming `BACKGROUND_RED` to `\x1b[41m`) may interfere with Terminal's ability to detect what background color the application is attempting to use.

Expand Down Expand Up @@ -123,7 +123,3 @@ Starting in Windows Terminal 1.5, the Terminal will display a warning if the "To
5. Hit "Ok", and restart the PC.

After restarting the machine, the service should auto-start, and the dialog should no longer appear.

## Why are my emoji not appearing in the jumplist?

Only images linked from a file location can be rendered in the jumplist. Emoji are not supported for jumplist.
Loading

0 comments on commit 9508aee

Please sign in to comment.