PowerShell v3 help files

Overview

On upgrading to PowerShell v3, it became apparent that the help side of the utility was not as it should be and help information was incomplete. This could be a side-effect of using software that is a pre-release version. To get around the problem, I used information from Richard Siddaway’s Blog to sort things out.

Steps

Start PowerShell as an administrator and execute the following commands.

PS> Save-Help -DestinationPath <Help Files DestinationPath> -UICulture en-US -Force –Verbose

PS> Update-Help -SourcePath <Help Files DestinationPath> -UICulture en-US -Force –Verbose

where <Help Files DestinationPath> is the folder where I placed my help files. In my case, I used the destination of:

C:\Windows\System32\WindowsPowerShell\v1.0\helpfiles

The folder has to exist before you execute these commands.

And that’s it.

Summary

Prior to this, obtaining help such as:

PS> Get-Help Get-ChildItem

would give help information which looked like:

REMARKS 
    Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help. 
        -- To download and install Help files for the module that includes this cmdlet, use Update-Help. 
        -- To view the Help topic for this cmdlet online, type: "Get-Help Get-Process -Online" or 
           go to http://go.microsoft.com/fwlink/?LinkID=113324.

With thanks to Richard Siddaway’s Blog.

See also

Windows Management Framework 3.0 Includes PowerShell 3.0, WMI & WinRM. PowerShell 3.0 can be downloaded from here.

Powershell V3 New Cmdlets These are the new Cmdlets added with the release of V3.

PowerShell V3 Tips and Tricks (What’s New in V3) Some  hints and tricks for version 3.

PowerShell V3 Guide PowerShell V3 is the latest version of PowerShell. Currently, PowerShell V3 is at an early stage of development with the Beta recently being released (3/1/2012).

PowerShell V3 New Features Many of the articles in the PowerShell V3 Featured Articles cover the new features so check those out as well as this page is populated.

Reference

Richard Siddaway’s Blog

Save-Help The Save-Help cmdlet downloads the newest help files for Windows PowerShell modules and saves them to a directory that you specify.

Update-Help The Update-Help cmdlet downloads the newest help files for Windows PowerShell modules and installs them on your computer. This feature enables you to install help files for modules that do not include them and to update your local help files so that they never become obsolete.

Advertisements
This entry was posted in powershell and tagged , . Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s