GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add help strings in PowerShell banner by iSazonov · Pull Request #5275 · PowerShell/PowerShell

Conversation

@iSazonov

@iSazonov Ilya (iSazonov) commented Oct 30, 2017

Copy link
Copy Markdown
Collaborator

Related #4986.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@iSazonov
Add help strings in PowerShell banner
1f9f12f
@iSazonov Ilya (iSazonov) assigned Dongbo Wang (daxian-dbw) Oct 30, 2017
@iSazonov
Ilya (iSazonov) requested a review from Steve Lee (SteveL-MSFT) October 30, 2017 12:27
@iSazonov
Ilya (iSazonov) requested review from Andrew (anmenaga), Dongbo Wang (daxian-dbw) and Jason Shirk (lzybkr) as code owners October 30, 2017 12:27
@iSazonov Ilya (iSazonov) mentioned this pull request Oct 30, 2017
Enhance PowerShell full command line help #4986
Closed
3 of 4 tasks
markekraus
Mark Kraus (markekraus) reviewed Oct 30, 2017
View reviewed changes
Comment thread src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx Outdated
Copyright (c) Microsoft Corporation. All rights reserved.</value>
Copyright (c) Microsoft Corporation. All rights reserved.

To get help type Help or Help followed by a command name, such as: Help Get-Process

@markekraus Mark Kraus (markekraus) Oct 30, 2017

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Perhaps instead of giving an example just recommend typing Help. the default help topic is about using the help system.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@SteveL-MSFT Steve Lee (SteveL-MSFT) Oct 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I agree that we can simply say:

Type `help` to get help.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
markekraus
Mark Kraus (markekraus) reviewed Oct 30, 2017
View reviewed changes
Comment thread src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx Outdated
Copyright (c) Microsoft Corporation. All rights reserved.

To get help type Help or Help followed by a command name, such as: Help Get-Process
To get PowerShell Online Help open the link: https://aka.ms/pscore6-docs</value>

@markekraus Mark Kraus (markekraus) Oct 30, 2017

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

As much as I hate to add another new line, I very much would like to have URLs on their own line. That makes them easier to grab and for limited width consoles it reduces the risk of it being line wrapped.

For PowerShell Help online, visit:
https://aka.ms/pscore6-docs

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@SteveL-MSFT Steve Lee (SteveL-MSFT) Oct 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I would prefer this link to be in the help text since the link isn't clickable

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Oct 31, 2017 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Previously we already added Online Help link in pwsh command line help - the idea was that today we always is in Web and Azure. The link can be easily copy-pasted.
What about:

Type 'Help' to get help.
Type 'Start-Process https://aka.ms/pscore6-docs' to get Online Help. 

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@markekraus Mark Kraus (markekraus) Oct 31, 2017

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Start-Process makes no sense on linux with a URL.
The link is clickable in KiTTY, so that kind of depends on the console app.
I see benefit in the link being displayed in the banner, but only if the URL is on a line by itself. Though, having it in the default help topic is a good alternative. As a user, I am not a fan of apps with long wordy banners.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Oct 31, 2017

Copy link
Copy Markdown
Collaborator Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I don't like long banners too but the idea is to follow Bash-style and to be web/Azure-friendly.
I expect Start-Process works on Linux by mean of XDS. I don't know about MacOs.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@markekraus Mark Kraus (markekraus) Oct 31, 2017

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I expect Start-Process works on Linux

Assuming you are in a Linux GUI, maybe. it most certainly doesn't work in any of the ~20 Linux VMs I have pwsh installed on. It definitely wont work raspberry pi. It is better to assume a user is not in a GUI with Core, IMO.

Providing just the link in an easy to read, select, copy and with the least risk of line-wrapping is the best bet if we are to provide it in the banner at all, IMO. Might not even need an explanation as the URL is decently self-explanatory:

Copyright (c) Microsoft Corporation. All rights reserved.

https://aka.ms/pscore6-docs
Type 'Help' to get help.

Bash doesn't have any enforced banners from bash itself, I don't think. If we follow bash style, it will show nothing unless the user/system admin deems it necessary. So I'm not sure what you mean by bash-style. Can you provide an example? (and lets not go by python's REPL, that thing is painful)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Oct 31, 2017

Copy link
Copy Markdown
Collaborator Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Sorry, skip my comment about Bash banner - I means whole original Issue in wrong context.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@rkeithhill Keith Hill (rkeithhill) Oct 31, 2017

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Why upcase the H i.e. why not Type 'help' to get help.? That feels more *nixy. :-)

Also, someone should consider updating the Get-Help topic because when you execute help (or man on Windows) and get this topic that talks all about Get-Help, it can be a bit confusing. I think the LONG DESCRIPTION should mention the fact that:

help exists as a function wrapper to the Get-Help command that pages the output to the console. On Windows, man is an alias for the help function. On Windows, the default pager is more.com. On other systems, it is less. You can select a different pager utility with the $env:PAGER environment variable. For example, if you have less on your Windows system you
can set $env:PAGER to the path to less and the help function will use less to page Get-Help output.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
SteveL-MSFT
Steve Lee (SteveL-MSFT) requested changes Oct 31, 2017
View reviewed changes
Comment thread src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx Outdated
Copyright (c) Microsoft Corporation. All rights reserved.</value>
Copyright (c) Microsoft Corporation. All rights reserved.

To get help type Help or Help followed by a command name, such as: Help Get-Process

@SteveL-MSFT Steve Lee (SteveL-MSFT) Oct 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I agree that we can simply say:

Type `help` to get help.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx Outdated
Copyright (c) Microsoft Corporation. All rights reserved.

To get help type Help or Help followed by a command name, such as: Help Get-Process
To get PowerShell Online Help open the link: https://aka.ms/pscore6-docs</value>

@SteveL-MSFT Steve Lee (SteveL-MSFT) Oct 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I would prefer this link to be in the help text since the link isn't clickable

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@SteveL-MSFT
Steve Lee (SteveL-MSFT) requested a review from Joey Aiello (joeyaiello) October 31, 2017 00:50
@iSazonov
Change banner
ceafe75
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Oct 31, 2017

Copy link
Copy Markdown
Member

I would be fine with just:

Copyright (c) Microsoft Corporation. All rights reserved.

https://aka.ms/pscore6-docs
Type 'help' to get help.

with the lowercase h

cc Joey Aiello (@joeyaiello) Hemant Mahawar (@HemantMahawar)

markekraus reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov
Change banner 2
fac6c76
markekraus
Mark Kraus (markekraus) approved these changes Nov 2, 2017
View reviewed changes
SteveL-MSFT
Steve Lee (SteveL-MSFT) approved these changes Nov 3, 2017
View reviewed changes
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit 819f9a3 into PowerShell:master Nov 3, 2017
@iSazonov
Ilya (iSazonov) deleted the add-help-in-banner branch November 3, 2017 18:03
@markekraus Mark Kraus (markekraus) mentioned this pull request Nov 4, 2017
Request / Discussion: Select-Object with one property causes many problems for beginners and has few legitimate use cases for anyone. Can that experience be improved for beginners? #5237
Closed
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@iSazonov @daxian-dbw
Add help strings in PowerShell banner (PowerShell#5275)
fe5313a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SteveL-MSFT Steve Lee (SteveL-MSFT) SteveL-MSFT approved these changes
@anmenaga Andrew (anmenaga) Awaiting requested review from anmenaga
@daxian-dbw Dongbo Wang (daxian-dbw) Awaiting requested review from daxian-dbw
@lzybkr Jason Shirk (lzybkr) Awaiting requested review from lzybkr
@joeyaiello Joey Aiello (joeyaiello) Awaiting requested review from joeyaiello
+2 more reviewers
@rkeithhill Keith Hill (rkeithhill) rkeithhill left review comments
@markekraus Mark Kraus (markekraus) markekraus approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@daxian-dbw Dongbo Wang (daxian-dbw)

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@iSazonov @SteveL-MSFT @rkeithhill @markekraus @daxian-dbw
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.