Skip to content
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.

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

The start of some User docs #1577

Merged
merged 45 commits into from
Jul 8, 2019
Merged
Changes from 11 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
aadcadd
Start User docs
alecthegeek Jun 25, 2019
ab28ebd
Fix typos
alecthegeek Jun 25, 2019
c503546
Addded some more TODO
alecthegeek Jun 25, 2019
316aa41
Update doc/user-docs/index.md
alecthegeek Jun 25, 2019
9f84ed9
Update doc/user-docs/index.md
alecthegeek Jun 25, 2019
41ef3d3
Update doc/user-docs/index.md
alecthegeek Jun 25, 2019
415ba7e
Update doc/user-docs/index.md
alecthegeek Jun 25, 2019
7160ab0
Updated from suggestions in the PR
alecthegeek Jun 25, 2019
da9dcae
Merge branch 'master' of github.com:microsoft/terminal into user-docs
alecthegeek Jun 25, 2019
c46fcde
Merge branch 'user-docs' of github.com:alecthegeek/terminal into user…
alecthegeek Jun 25, 2019
e94a1ba
Improve path to profiles.json
alecthegeek Jun 25, 2019
d169eb8
Added some details about Json settings
alecthegeek Jun 26, 2019
802c1db
Example Json settings, and a #TODO
alecthegeek Jun 26, 2019
ddfbc8c
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jun 26, 2019
a58398e
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jun 26, 2019
7500105
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jun 26, 2019
09ce9d7
Update doc/user-docs/index.md
alecthegeek Jun 26, 2019
986f2cf
Update doc/user-docs/index.md
alecthegeek Jun 26, 2019
c698601
Update doc/user-docs/index.md
alecthegeek Jun 26, 2019
dc6e56f
Update doc/user-docs/index.md
alecthegeek Jun 26, 2019
64b3ba9
Update doc/user-docs/index.md
alecthegeek Jun 26, 2019
f1f9937
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jun 27, 2019
4e13376
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
ee6afab
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
0f5e4be
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
3780578
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
ed736f7
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
4378c22
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
07a400e
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
a30edaf
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
0041ccd
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
0ad4986
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
08a72a7
Update doc/user-docs/UsingJsonSettings.md
alecthegeek Jul 1, 2019
de0358c
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
7513bb4
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
1c60012
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
a3151dc
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
4cd2f7e
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
9b063c5
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
9965483
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
a140a6a
Update doc/user-docs/index.md
alecthegeek Jul 1, 2019
85f7b7c
After review and make colour US.
alecthegeek Jul 1, 2019
f63c58b
Added more detais about background images
alecthegeek Jul 1, 2019
fefc024
Remove some TODO comments and minot tidy up
alecthegeek Jul 1, 2019
a107a39
Get rid of TODO
alecthegeek Jul 2, 2019
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
76 changes: 76 additions & 0 deletions doc/user-docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Windows Terminal User Documentation

NOTE: At the time of writing Windows Terminal is still under active development and many things will
change. If you notice an error in the docs, please raise an issue. Or better yet, please file a PR with an appropriate update!

## Installing Windows Terminal

### From Source Code

Follow the instructions in this repo's [README](/README.md#developer-guidance)
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

### From the Microsoft Store

1. Make sure you have upgraded to the current Windows 10 release (at least 1903)
2. Search for Windows Terminal in the Store
3. Install in the normal fashion

## Starting Windows Terminal

From the Windows Start menu, select Windows Terminal and run the application.

Note: You can right click on the application item and run with administrator privilege if required.

The default shell is Powershell.
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

## Multiple Tabs

Additional shells can be started by hitting the `+` button from the top bar -- a new instance of the
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved
default shell is displayed (default shortcut `ctrl-shift-1`)
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

## Running a different shell
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

Note: The following text assumes you have WSL installed
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

To choose a different shell (e.g. `cmd.exe` or WSL `bash`) then

1. Select the `down` button next to the `+` in the top bar
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved
2. Choose your new shell from the list (more on how to extend the list in the config section)

## Starting a new tab Powershell with admin privilege

#TODO

## Using cut and paste in the Terminal window

#TODO For Powershell and Bash (and cmd.exe?)

## Add a "Open Windows Terminal Here" to File Explorer

#TODO

## Configuring Windows Terminal

At the time of writing all Windows Terminal settings are managed via a Json file.
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

From the `down` button in the top bar select settings (default shortcut `ctrl-,`)
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

Your default json editor will open up the Terminal settings file. The file can found
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved
at `$env:LocalAppData\Packages\Microsoft.WindowsTerminal_<randomString>/RoamingState`

#TODO -- is this path correct for **users** ?

The list of valid settings can be found in the [Profiles.json Documentation](../cascadia/SettingsSchema.md) doc
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

#TODO Add new page with detailed information on settings. E.g Adding new shells, keybindings, background Gif etc.

## Tips and Tricks:

1. In Powershell you can discover if the Windows Terminal is being used by checking for the existence of the environment variable `WT_SESSION`.
alecthegeek marked this conversation as resolved.
Show resolved Hide resolved

Under pwsh you can also use
`(Get-Process -Id $pid).Parent.Parent.ProcessName -eq 'WindowsTerminal'`

(ref https://twitter.com/r_keith_hill/status/1142871145852440576)
cinnamon-msft marked this conversation as resolved.
Show resolved Hide resolved

2. #TODO More Tips and Tricks