A PowerShell help file documents a cmdlet and provides the information needed to use it effectively. Its conventions help you read syntax, parameters, behavior, aliases, remarks, and examples. section 3.5 section 3.2
Use help files to:
- Check a cmdlet's syntax and available parameters before running it. section 3.5 section 3.2
- Read examples rather than searching elsewhere first; every displayed detail may clarify how a command works. section 9.4
- Update local documentation with Update-Help, or save it with Save-Help for computers without internet access. section 3.2
- Compare local information with Microsoft Docs by adding -Online when online help is available. section 3.7
Open online help
Run `Help Get-Item -Online` to open the web-based help in a browser. For a fuller local topic, run `Update-Help` first, then inspect the command's syntax and examples. section 3.7 section 3.2
PS /User/travisp> help Get-Process NAME Get-Process SYNTAX Get-Process [[-Name] <string[]>] [-Module] [-FileVersionInfo] [<CommonParameters>] Get-Process [[-Name] <string[]>] -IncludeUserName [<CommonParameters>] Get-Process -Id <int[]> -IncludeUserName [<CommonParameters>] Get-Process -Id <int[]> [-Module] [-FileVersionInfo] [<CommonParameters>] Get-Process -InputObject <Process[]> [-Module] [-FileVersionInfo] [<CommonParameters>] Get-Process -InputObject <Process[]> -IncludeUserName [<CommonParameters>] ALIASES gps 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 https://go.microsoft.com/fwlink/?LinkID=113324.
A sample Get-Process topic shows the compact format of a help file, including syntax, aliases, and remarks about missing local content. section 3.2
