Skip to main content

0202 | The Help System

Update the help system​

update-help
update-help -Force

Read the conceptual topics​

get-help about_eventlogs
# list all the topics
get-help about_*

Get all the used verbs​

get-verb
# count them
get-verb | measure

Get detailed info about a command​

# get detailed info about a command
get-help get-service -Detailed
# get only the examples
get-help get-service -Examples
# get all the info about a command - additional info about the parameters
get-help get-service -Full
# show the results in an external window
get-help get-service -ShowWindow

Use online help (example: an older version of ps is installed)​

get-help get-service -Online

Command syntax​

  • parameter sets | different sets of functionality
  • - | (dashes) are before parameters
  • [] | denotes that they are optional
  • <> | for the values
  • example 
    get-service -Name bits, bfe
    get-service -Name b*, c*
  • for <String[]> | multiple string values, comma separated (space optional)
  • [[-Name] <String[]>] | positional parameters | no need to specify the parameter, only the values
  • example 
    get-service -name bits
    # vs
    get-service bits

Example | get the newest error event logs​

get-eventlog -logname system -newest 3 -entrytype error