Online help

Its been a long day today so I’m going to skip the next part of the COM series and show a useful bit of functionality from a PowerShell cmdlet.


Anyone who has been around PowerShell for any length of time is aware of the get-help cmdlet e.g.


Get-Help Set-Content


get-help about_for


 


It is so fundamental to getting to know your way around PowerShell that I referred to it as one of your four best friends in PowerShell when I was writing PowerShell in Practice http://www.manning.com/siddaway/


What you might not be aware of is the –online parameter. This opens the help as posted on TechNet in your browser.


Get-Help Set-Content –Online


If you try this notice the date the online help was last updated  - April 21, 2010 at the time of writing. The PowerShell team will update the online content as documentation bugs are filed. If you see something in the help file that you don’t think is right try the online version to see if it has been changed.


What about our other example?


get-help about_for –Online


This generates an error


Get-Help : The online version of this Help topic cannot be displayed because there is no Uri for online Help in the "Related Links" section of the cmdlet Help topic.
At line:1 char:9
+ get-help <<<<  about_for -Online
    + CategoryInfo          : InvalidOperation: (:) [Get-Help], PSInvalidOperationException
    + FullyQualifiedErrorId : InvalidOperation,Microsoft.PowerShell.Commands.GetHelpCommand


 


I’ve checked a random selection of about files and none of them had a URI. You can find them online at http://technet.microsoft.com/en-us/library/dd347616.aspx

Leave a Reply