Skip to content

Format Syntax

Nate Ferrell edited this page Aug 19, 2019 · 3 revisions

Format-Syntax

SYNOPSIS

Formats a command's syntax in an easy-to-read view.

SYNTAX

Format-Syntax [[-Command] <Object>] [<CommonParameters>]

DESCRIPTION

Formats a command's syntax in an easy-to-read view.

EXAMPLES

EXAMPLE 1

Format-Syntax Get-Process

Gets the formatted syntax by parameter set for Get-Process

EXAMPLE 2

syntax Get-Process

Same as Example 1, but uses the alias 'syntax' instead.

PARAMETERS

-Command

The command to get the syntax of.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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

OUTPUTS

NOTES

RELATED LINKS

PSProfile

Concepts

Function Help

Command Aliases

Configuration

Helpers

Init Scripts

Meta

Modules to Import

Modules to Install

Path Aliases

Plugin Paths

Plugins

Power Tools

Project Paths

Prompts

Script Paths

Secrets

Symbolic Links

Variables

Badges

Azure Pipelines      Discord - Chat      Slack - Chat      Codacy PowerShell Gallery      GitHub Releases      GitHub Releases

Clone this wiki locally