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

Added initial docs for customizing windows terminal #2374

Closed
wants to merge 1 commit into from

Conversation

joandrsn
Copy link

@joandrsn joandrsn commented Aug 9, 2019

Summary of the Pull Request

Add some initial docs for customizing the users experience in Windows Terminal.
I've seen you have been flooded with these questions, so I decided to write some docs. I know bash is missing, but I've yet to master it. Feel free to come with feedback.

References

Depending on the mind of @zadjii-msft in #2373, this might need to be updated very soon.

PR Checklist

change. If you notice an error in the docs, please raise an issue. Or better yet, please file a PR with an appropriate update!

## Title of tab
When Windows Terminal launches, the shell has a special variable to determine the window title. This title is used to set the name of the tab inside Windows Terminal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text is a little misleading and likely not necessary considering the subsequent text & bullets.

2. Set the title within the shell (varies by shell)

#### 1. Set the title from the settings of Windows Terminal
In the `settings.json` file from Windows Terminal, you can overrule the title of the tab by specifying the property `tabTitle`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/settings.json/profiles.json/g ;)


#### 1. Set the title from the settings of Windows Terminal
In the `settings.json` file from Windows Terminal, you can overrule the title of the tab by specifying the property `tabTitle`.
The `tabTitle` overrules the title from the individual shell. Please note that the `tabTitle` is static.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does static mean in this context?

###### Documentation: [title - Microsoft Docs][cmdtitle]

## Customizing the prompt
The prompt is the part of the terminal shown before where your cursor is placed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest something like:

"The prompt is the text that is displayed at the start of each command-line, to the left of the cursor. For example, in Cmd, the default prompt is C:\>

Copy link
Contributor

@bitcrazed bitcrazed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few comments / suggestions.

@carlos-zamora carlos-zamora removed their assignment Aug 19, 2019
@miniksa miniksa added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 29, 2019
@ghost ghost added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Aug 29, 2019
@ghost
Copy link

ghost commented Aug 29, 2019

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.


##### CMD
```
prompt my new prompt

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to mention about the prompt and title being environment variables. And that defaults can be set by editing the environment variables in windows.

I like the example:
set PROMPT=$e]0;$p$e$p$g

Might be good to show a screen shot of an environment variables window.

image

@ghost ghost removed the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Sep 5, 2019
@ghost ghost added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Sep 12, 2019
@ghost
Copy link

ghost commented Sep 12, 2019

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

@ghost ghost closed this Sep 19, 2019
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a guide for setting the title in your shell
6 participants