Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.8 KB

Open-PSProjectStatusHelp.md

File metadata and controls

76 lines (48 loc) · 1.8 KB
external help file Module Name online version schema
PSProjectStatus-help.xml
PSProjectStatus
2.0.0

Open-PSProjectStatusHelp

SYNOPSIS

Open the PSProjectStatus help document

SYNTAX

Open-PSProjectStatusHelp [-AsMarkdown] [<CommonParameters>]

DESCRIPTION

Use this command to open the PDF help document for the PSProjectStatus module with the associated application for PDF files. If you are running PowerShell 7, as an alternative you can view the documentation as a markdown document with the -AsMarkdown parameter. This is a dynamic parameter that does not exist in Windows PowerShell.

EXAMPLES

Example 1

PS C:\> Open-PSProjectStatusHelp

The file should open in the default application for PDF files.

Example 2

PS C:\> Open-PSProjectStatusHelp -AsMarkdown | more

View the help file a markdown document if running PowerShell 7.

PARAMETERS

-AsMarkdown

If you are running PowerShell 7, as an alternative you can view the documentation as a markdown document with the -AsMarkdown parameter. This is a dynamic parameter that does not exist in Windows PowerShell.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: md

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

None

NOTES

RELATED LINKS

PSProjectStatus GitHub Repository: