From 3a641b7f3ea7750b04750a16c15adbc774b65a8e Mon Sep 17 00:00:00 2001 From: Matt Wojciakowski Date: Mon, 2 Aug 2021 12:31:44 -0700 Subject: [PATCH] Merge video update on overview pg (#376) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * command-line-arguments.md: Tag the Command Prompt code blocks For some reason they were tagged as bash, which broke highlighting in at least one of them. * fixed typo (#220) in line 98 it's `C:\\path\\to\\icon.png` while in line 115 it was `C:\\path\\to\\icon` so I've added the missing `.png` * Add note about escaping characters with backslash (#230) Originally filed by Andrewery https://github.com/MicrosoftDocs/terminal/pull/134/files * Add icon example and folder location (#231) From https://github.com/MicrosoftDocs/terminal/pull/135 * Add icon example and folder location As originally submitted by @aloneguid in https://github.com/MicrosoftDocs/terminal/pull/135 * Remove code brackets for readability * Add spacing * Fix default value by escaping characters (#232) Original submission: https://github.com/MicrosoftDocs/terminal/pull/134/files * Add info about the command palette (#180) * Add info about the command palette 1. Add info about the command palette. 2. Typo fixes (e.g. "quick-start guide" instead of "quickstart") 3. Style fix, e.g. we don't have a keyboard key whose full name is "alt+shift+plus". * revert description Co-authored-by: Matt Wojciakowski * Add backslash escape note (#233) ...from PR https://github.com/MicrosoftDocs/terminal/pull/181 * Add a note about hiding dynamic profiles (#186) * Add a note about hiding dynamic profiles * Minor writing updates Co-authored-by: Matt Wojciakowski * Clarify adding profile in ssh tutorial. Fixes #183 (#193) * Clarify adding profile in ssh tutorial. Fixes: #183 * Remove from docs link * Add guid command for powershell (#234) migrated from PR https://github.com/MicrosoftDocs/terminal/pull/199/files * Change "i.e." to "e.g." (#207) This seems to be the intended meaning: There are Linux distributions that are not Ubuntu, but Ubuntu is an example of a Linux distribution for which the behavior is the given. * Old Ubuntu: Use up-to-date version of golang (#216) Currently, the install recommends using an out-of-date version of golang, which in turn causes issues while installing powerline-go. * Add startingDirectory example (#237) * Add startingDirectory example * Format startingDirectory entry * remove icon file type Co-authored-by: Kayla Cinnamon * Change icon description to example * Change false to true Co-authored-by: Kayla Cinnamon * Remove unnecessary sentence Co-authored-by: Kayla Cinnamon * Typo fixes Co-authored-by: Kayla Cinnamon * link fix Co-authored-by: Kayla Cinnamon * Capitalization fixes Co-authored-by: Kayla Cinnamon * shortcut fixes Co-authored-by: Kayla Cinnamon * page_title_updates_terminal (#243) * Add docs for `newWindow` action (#259) * refactor(powerline): update for oh-my-posh V3 (#263) * Improved title setting procedure on bash/Ubuntu so that it doesn't destroy `PS1` (#123) Improved title setting procedure on bash/Ubuntu so that it doesn't destroy `PS1` * Update powerline-setup.md (#240) * Update powerline-setup.md * Update powerline-setup.md * Update powerline-setup.md * fix typo * Merge release 1.7 into master (#264) Co-authored-by: Mike Griese Co-authored-by: Don-Vito * Update powerline-setup.md (#175) * Update powerline-setup.md Updated Tips to include setting the Integrated terminal within Visual Studio to use the Cascadia Code Powerlines font. Also added an additional resource which shows step by step how to do this * Combine VS Code & VS tips for setting up powerline * Remove external blog link Co-authored-by: Matt Wojciakowski * Fix a monor typo with the default keybinding for new tab (#287) closes #270 * Add a note that --window is only available in 1.7+ (#288) * Add a note that --window is only available in 1.7+ closes #282 * Whoops, those can't go on one line * Fix a typo in this doc (#289) * Fix a typo in this doc Closes #280 * I bet the docs build is gonna complain about this one * Add a FAQ entry for folks who are confused when Settings does nothing (#290) * Add a note that you can't set the tab color from the commandline (#291) Closes #249 * Add UUID generator option * Add online guid generator * Add instructions to open defaults.json file * Update panes.md * Add note about using settings.json... ..not defaults.json for applying color schemes across profiles. * fix link * Merge release-1.8 into master (#309) Co-authored-by: Kayla Cinnamon Co-authored-by: Don-Vito Co-authored-by: Mike Griese * Fix placement of unfocused appearance section (#312) * Update TerminalDocs/command-line-arguments.md * Update TerminalDocs/command-line-arguments.md * Add mouse interaction section (#297) Addresses issue https://github.com/MicrosoftDocs/terminal/issues/6 * document how to start windows terminal and have it execute a command (#298) * document how to start windows terminal and have it execute a command #296 * Separated the argument examples and included explanations of what they accomplish * fix typo * remove version from url Co-authored-by: Mark Iannucci Co-authored-by: Matt Wojciakowski * FIX syntax error in json configuration example (#308) FIX syntax error in json configuration example * Document trimBlockSelection setting (#313) * Document trimBlockSelection setting * Add preview disclaimer * Minor edit + note re how to select rectangular txt * Add preview to h2 Co-authored-by: Matt Wojciakowski * Updated openSettings default bindings. (#317) * Updated openSettings default bindings. * Updated the openSettings description. * minor edits Co-authored-by: Matt Wojciakowski * Update powerline-setup.md (#319) Fix a typo 'optonal' replaced by 'optional' * Updates for 1.9 release (#328) * Fix links * Typo "Windows terminal"→"Windows Terminal" (#326) https://docs.microsoft.com/en-us/windows/terminal/custom-terminal-gallery/custom-schemes #PingMSFTDocs * Add link to alternative install options (#321) Resolves https://github.com/MicrosoftDocs/terminal/pull/286 * Update `cursorHeight` minimum value (#278) Documentation update for microsoft/terminal#9386 * Add link to install preview (#342) * Add link to install preview * Update wording Co-authored-by: Kayla Cinnamon * Update default settings, add UI screenshots (#343) * Update default settings, add UI screenshots * update screenshot * fix numbering * Fix screenshot steps * Correct title verbage, update screenshot * Add preview tags * Fix typos Co-authored-by: Kayla Cinnamon * Add required version for OMP2 Oh-my-posh has updated to version 3, so adding a note to designate version 2 on this uninstall until we can return to this tutorial and update to version 3. In the meantime, there are other tutorials available on the web that walkthrough how to install OMP v3 and set it up with git status, etc. * Update quakemode monitor setting Based on https://github.com/MicrosoftDocs/terminal/issues/333 * Added link to Cascadia Code font * Add troubleshooting section on git bash flashing (#356) * font struct (#355) Co-authored-by: Pankaj Bhojwani * documentation for minimzeToTray (#352) * Add documentation for closing tabs by index (#347) As implemented in microsoft/terminal#10447 * Update configuration section of get-start (#345) Select Settings in the dropdown menu will open the Settings UI instead of open file since the release version v1.6.10571.0 But this page is not up to date, so I edit it. * Add note about opening command palette via dropdown menu (#335) * Make link relative * Add updates for 1.10 release (#361) * Add reset settings to troubleshooting section Resolves https://github.com/MicrosoftDocs/terminal/issues/91 * Add 3rd party examples to dynamic profiles (#366) * Add experimental.input.forceVT setting to the interaction page (#367) * Add input.forceVT setting * Update wording * Replace screenshot with overview video * Add note about json vs UI settings for WSL starting directory Resolves https://github.com/MicrosoftDocs/terminal/issues/373 Co-authored-by: Samuel Bronson Co-authored-by: LSC Co-authored-by: skycommand Co-authored-by: Mike Griese Co-authored-by: Cameron Durham Co-authored-by: Søren Fuglede Jørgensen Co-authored-by: Janne Mareike Koschinski Co-authored-by: Kayla Cinnamon Co-authored-by: Meenal Patel <42360097+v-mepa@users.noreply.github.com> Co-authored-by: Jan De Dobbeleer <2492783+JanDeDobbeleer@users.noreply.github.com> Co-authored-by: Dakkaron Co-authored-by: Ibrahim Rouis <73853380+rouisibra@users.noreply.github.com> Co-authored-by: Don-Vito Co-authored-by: Michael James Co-authored-by: Mark Iannucci Co-authored-by: Mark Iannucci Co-authored-by: lpotherat Co-authored-by: Sean Jacobs Co-authored-by: superfaz <16510828+superfaz@users.noreply.github.com> Co-authored-by: Hiroshi Yoshioka <40815708+hyoshioka0128@users.noreply.github.com> Co-authored-by: Eugene Samoylov Co-authored-by: PankajBhojwani Co-authored-by: Pankaj Bhojwani Co-authored-by: Leon Liang Co-authored-by: Ian O'Neill Co-authored-by: Gaein_nidb <36162655+nidbCN@users.noreply.github.com> Co-authored-by: Casper Verhaar --- .../customize-settings/interaction.md | 16 +++ .../customize-settings/profile-general.md | 2 +- TerminalDocs/dynamic-profiles.md | 114 ++++++++++++++++++ TerminalDocs/index.md | 2 +- TerminalDocs/troubleshooting.md | 4 + 5 files changed, 136 insertions(+), 2 deletions(-) diff --git a/TerminalDocs/customize-settings/interaction.md b/TerminalDocs/customize-settings/interaction.md index d0f2e5e3..67904542 100644 --- a/TerminalDocs/customize-settings/interaction.md +++ b/TerminalDocs/customize-settings/interaction.md @@ -248,3 +248,19 @@ When this is set to `true`, trying to paste text with multiple lines will displa **Accepts:** `true`, `false` **Default value:** `true` + +
+ +___ + +## Legacy input encoding + +Force the terminal to use the legacy input encoding. Specific keys in some applications may stop working when enabling this setting, but it can be useful for advanced-level scenarios when debugging input issues, especially with the [debug tap](https://github.com/microsoft/terminal/wiki/Enabling-the-debug-tap). + +**Property name:** `experimental.input.forceVT` + +**Necessity:** Optional + +**Accepts:** `true`, `false` + +**Default value:** `false` diff --git a/TerminalDocs/customize-settings/profile-general.md b/TerminalDocs/customize-settings/profile-general.md index ab7a33ae..11d77bb9 100644 --- a/TerminalDocs/customize-settings/profile-general.md +++ b/TerminalDocs/customize-settings/profile-general.md @@ -67,7 +67,7 @@ This is the directory the shell starts in when it is loaded. **Example:** Start the PowerShell profile in the *GitHubRepos* folder of your *Documents* directory by finding the powershell.exe profile and adding `"startingDirectory": "%USERPROFILE%/Documents/GitHubRepos",` -**Example with WSL:** When setting the starting directory for a [Linux distribution installed via WSL](https://docs.microsoft.com/windows/wsl/install-win10), use the format: `"startingDirectory": "\\\\wsl$\\DISTRO NAME\\home\\USERNAME"`, replacing with the placeholders with the proper names of your distribution. For example, `"startingDirectory": "\\\\wsl$\\Ubuntu-20.04\\home\\user1"`. +**Example with WSL:** When setting the starting directory for a [Linux distribution installed via WSL](https://docs.microsoft.com/windows/wsl/install-win10), use the format: `"startingDirectory": "\\\\wsl$\\DISTRO NAME\\home\\USERNAME"`, replacing with the placeholders with the proper names of your distribution. For example, `"startingDirectory": "\\\\wsl$\\Ubuntu-20.04\\home\\user1"`. If you are using the Windows Terminal Settings UI, rather than the settings.json file, to declare this path, you can use the **Browse...** button to select your starting directory or enter the WSL path as: `//wsl.localhost/DISTRO NAME/home/USERNAME`. For example, `//wsl.localhost/Ubuntu-20.04/home/user1`. **Default behavior:** When the startingDirectory value is not specified, you will get different results depending on where you launch Terminal: - If you run Windows Terminal from the Start menu: C:\windows\system32 diff --git a/TerminalDocs/dynamic-profiles.md b/TerminalDocs/dynamic-profiles.md index 565239bb..a03488ff 100644 --- a/TerminalDocs/dynamic-profiles.md +++ b/TerminalDocs/dynamic-profiles.md @@ -37,3 +37,117 @@ To prevent a dynamic profile from being generated, you can add the profile gener ```json "disabledProfileSources": ["Windows.Terminal.Wsl", "Windows.Terminal.Azure", "Windows.Terminal.PowershellCore"] ``` + +## Add a third party profile + +If a 3rd party command line tool does not have a profile auto-generated into your settings.json file, you can add it manually. Below are profiles for a few common 3rd party tools for your reference. + +### Anaconda + +Assuming that you've installed Anaconda into `%USERPROFILE%\Anaconda3`: + +```json +{ + "commandline": "cmd.exe /k \"%USERPROFILE%\\Anaconda3\\Scripts\\activate.bat %USERPROFILE%\\Anaconda3\"", + "icon": "%USERPROFILE%\\Anaconda3\\Menu\\anaconda-navigator.ico", + "name": "Anaconda3", + "startingDirectory": "%USERPROFILE%" +} +``` + +### cmder + +Assuming that you've installed cmder into `%CMDER_ROOT%`: + +```json +{ + "commandline": "cmd.exe /k \"%CMDER_ROOT%\\vendor\\init.bat\"", + "name": "cmder", + "icon": "%CMDER_ROOT%\\icons\\cmder.ico", + "startingDirectory": "%USERPROFILE%" +} +``` + +### Cygwin + +Assuming that you've installed Cygwin into `C:\Cygwin`: + +```json +{ + "name": "Cygwin", + "commandline": "C:\\Cygwin\\bin\\bash --login -i", + "icon": "C:\\Cygwin\\Cygwin.ico", + "startingDirectory": "C:\\Cygwin\\bin" +} +``` + +> ![NOTE] +> The starting directory of Cygwin is set in order for the path +to work. The default directory opened when starting Cygwin will be `$HOME` because +of the `--login` flag. + +### Far Manager + +Assuming that you've installed Far into `c:\Program Files\Far Manager`: + +```json +{ + "name": "Far", + "commandline": "\"c:\\program files\\far manager\\far.exe\"", + "startingDirectory": "%USERPROFILE%", + "useAcrylic": false +}, +``` + +### Git Bash + +Assuming that you've installed Git Bash into `C:\\Program Files\\Git`: + +```json +{ + "name": "Git Bash", + "commandline": "C:\\Program Files\\Git\\bin\\bash.exe -li", + "icon": "C:\\Program Files\\Git\\mingw64\\share\\git\\git-for-windows.ico", + "startingDirectory": "%USERPROFILE%" +} +```` + +### Git Bash (WOW64) + +Assuming that you've installed Git Bash into `C:\\Program Files (x86)\\Git`: + +```json +{ + "name": "Git Bash", + "commandline": "%ProgramFiles(x86)%\\Git\\bin\\bash.exe -li", + "icon": "%ProgramFiles(x86)%\\Git\\mingw32\\share\\git\\git-for-windows.ico", + "startingDirectory": "%USERPROFILE%" +} +``` + +### MSYS2 + +Assuming that you've installed MSYS2 into `C:\\msys64`: + +```json +{ + "name": "MSYS2", + "commandline": "C:\\msys64\\msys2_shell.cmd -defterm -no-start -mingw64", + "icon": "C:\\msys64\\msys2.ico", + "startingDirectory": "C:\\msys64\\home\\user" +} +``` + +For more details, see the Terminals section of the [MSYS2 documentation](https://www.msys2.org/docs/terminals/#windows-terminal). + +### Developer Command Prompt for Visual Studio + +Assuming that you've installed [Visual Studio 2019 Professional](https://visualstudio.microsoft.com/downloads/): + +```json +{ + "name": "Developer Command Prompt for VS 2019", + "commandline": "cmd.exe /k \"C:/Program Files (x86)/Microsoft Visual Studio/2019/Professional/Common7/Tools/VsDevCmd.bat\"", + "startingDirectory": "%USERPROFILE%" +} +``` diff --git a/TerminalDocs/index.md b/TerminalDocs/index.md index bf8a1948..4fe5a2d6 100644 --- a/TerminalDocs/index.md +++ b/TerminalDocs/index.md @@ -12,7 +12,7 @@ ms.localizationpriority: high Windows Terminal is a modern terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and Windows Subsystem for Linux (WSL). Its main features include multiple tabs, panes, Unicode and UTF-8 character support, a GPU accelerated text rendering engine, and the ability to create your own themes and customize text, colors, backgrounds, and shortcuts. -![Windows Terminal screenshot](./images/overview.png) +> [!VIDEO https://www.microsoft.com/en-us/videoplayer/embed/RWHAdS] > [!NOTE] > [What's the difference between a console, a terminal, and a shell?](https://www.hanselman.com/blog/WhatsTheDifferenceBetweenAConsoleATerminalAndAShell.aspx) Read Scott Hanselman's explanation. diff --git a/TerminalDocs/troubleshooting.md b/TerminalDocs/troubleshooting.md index dacd5324..5d1b909f 100644 --- a/TerminalDocs/troubleshooting.md +++ b/TerminalDocs/troubleshooting.md @@ -157,3 +157,7 @@ set bell-style none ``` Press Ctrl + O and Ctrl + X to Save and Exit. + +## How do I reset my settings in Windows Terminal back to the default settings? + +To reset your settings back to the original default settings, delete your settings.json file. This will cause Windows Terminal to regenerate a settings.json file with the original default settings.