Search-Help

Last Update: October 3, 2012
PowerShell Version: 2.0 and 3.0

Libraries:

• PSv3.psm1

 

.SYNOPSIS
Searches PowerShell help files for specific words.

.DESCRIPTION
Searches through PowerShell help files for words and highlights those words in the actual help files. 
The default setting for this cmdlet is to search for the pattern specified in the WORDS parameter in each word of the help file.

.PARAMETER Cmdlet
The cmdlet or About file that you want to search for specific words.

.PARAMETER Words
Comma separated list of words that you want to search for.  The words can contain * and ? characters but cannot start with a * or ? character.

.PARAMETER Detailed
Searches the cmdlets detailed help file.

.PARAMETER Full
Searches the cmdlets full help file.

.PARAMETER MoreHighlight
Displays the queried words in a higher contrast color scheme which may make the output more readable to some users.

.PARAMETER ExactMatch
This will change the pattern recognition to an exact match (not case sensitive).  Wildcard characters are not accepted.

.EXAMPLE
Search-Help Get-Date -Words Date

Returns the standard help file for the cmdlet Get-Date and highlights all words that match or contains "Date".

NAME

    Get-Date

    

SYNOPSIS

    Gets the current date and time.

    

    

SYNTAX

    Get-Date [[-Date] <DateTime>] [-Day <Int32>] [-DisplayHint <DisplayHintType>] [-Format <String>] [-Hour <Int32>] 

    [-Millisecond <Int32>] [-Minute <Int32>] [-Month <Int32>] [-Second <Int32>] [-Year <Int32>] [<CommonParameters>]

    

    Get-Date [[-Date] <DateTime>] [-Day <Int32>] [-DisplayHint <DisplayHintType>] [-Hour <Int32>] [-Millisecond <Int32>] 

    [-Minute <Int32>] [-Month <Int32>] [-Second <Int32>] [-UFormat <String>] [-Year <Int32>] [<CommonParameters>]

    

    

DESCRIPTION

    The Get-Date cmdlet gets a DateTime object that represents the current date or a date that you specify. It can format the 

    date and time in several Windows and UNIX formats. You can use Get-Date to generate a date or time character string, and 

    then send the string to other cmdlets or programs.

    

 

RELATED LINKS

    Online Version: http://go.microsoft.com/fwlink/?LinkID=113313

    New-TimeSpan 

    Set-Date 

 

REMARKS

    To see the examples, type: "get-help Get-Date -examples".

    For more information, type: "get-help Get-Date -detailed".

    For technical information, type: "get-help Get-Date -full".

    For online help, type: "get-help Get-Date -online"

 

 

 

-- Search Results: -------------------------------------------------------------

Your search returned 20 matches.

Items searched for:

Date

.EXAMPLE
Search-Help Get-Process P*ess, more, t?pe -MoreHighlight

Returns the standard help file for the cmdlet Get-Date and highlights all words that match or contains "Date" as well as "P*ess" and "T?py"
The "*" character is a wild card character that allows for multiple characters to exists in its place.
The "?" character is a wild card character that allows for a single character to exists in its place.
The highlighted words will also be returned in greater contrast.

NAME

    Get-Process

    

SYNOPSIS

    Gets the processes that are running on the local computer or a remote computer.

    

    

SYNTAX

    Get-Process [[-Name] <String[]>] [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module 

    [<SwitchParameter>]] [<CommonParameters>]

    

    Get-Process [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module [<SwitchParameter>]] -Id <Int32[]> 

    [<CommonParameters>]

    

    Get-Process [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module [<SwitchParameter>]] -InputObject 

    <Process[]> [<CommonParameters>]

    

    

DESCRIPTION

    The Get-Process cmdlet gets the processes on a local or remote computer.

    

    Without parameters, Get-Process gets all of the processes on the local computer. You can also specify a particular process 

    by process name or process ID (PID) or pass a process object through the pipeline to Get-Process.

    

    By default, Get-Process returns a process object that has detailed information about the process and supports methods that 

    let you start and stop the process. You can also use the parameters of Get-Process to get file version information for the 

    program that runs in the process and to get the modules that the process loaded.

    

 

RELATED LINKS

    Online Version: http://go.microsoft.com/fwlink/?LinkID=113324

    Debug-Process 

    Get-Process 

    Start-Process 

    Stop-Process 

    Wait-Process 

 

REMARKS

    To see the examples, type: "get-help Get-Process -examples".

    For more information, type: "get-help Get-Process -detailed".

    For technical information, type: "get-help Get-Process -full".

    For online help, type: "get-help Get-Process -online"

 

 

 

-- Search Results: -------------------------------------------------------------

Your search returned 36 matches.

Items searched for:

P*ess

more

t?pe

.EXAMPLE
Search-Help About_Comparison_Operators "-Match"

Returns the help file for About_Comparison_Operators with all words matching or contains "-Match" highlighted.

.EXAMPLE
Search-Help Get-Process -detailed Process

Returns the detailed help file for the cmdlet Get-Date and highlights all words that match or contains "Date".

.EXAMPLE
Search-Help Get-Process -Words Process -ExactMatch

Returns the standard help file for Get-Process with all words that exactly match "Process" highlighted.

NAME

    Get-Process

    

SYNOPSIS

    Gets the processes that are running on the local computer or a remote computer.

    

    

SYNTAX

    Get-Process [[-Name] <String[]>] [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module 

    [<SwitchParameter>]] [<CommonParameters>]

    

    Get-Process [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module [<SwitchParameter>]] -Id <Int32[]> 

    [<CommonParameters>]

    

    Get-Process [-ComputerName <String[]>] [-FileVersionInfo [<SwitchParameter>]] [-Module [<SwitchParameter>]] -InputObject 

    <Process[]> [<CommonParameters>]

    

    

DESCRIPTION

    The Get-Process cmdlet gets the processes on a local or remote computer.

    

    Without parameters, Get-Process gets all of the processes on the local computer. You can also specify a particular process 

    by process name or process ID (PID) or pass a process object through the pipeline to Get-Process.

    

    By default, Get-Process returns a process object that has detailed information about the process and supports methods that 

    let you start and stop the process. You can also use the parameters of Get-Process to get file version information for the 

    program that runs in the process and to get the modules that the process loaded.

    

 

RELATED LINKS

    Online Version: http://go.microsoft.com/fwlink/?LinkID=113324

    Debug-Process 

    Get-Process 

    Start-Process 

    Stop-Process 

    Wait-Process 

 

REMARKS

    To see the examples, type: "get-help Get-Process -examples".

    For more information, type: "get-help Get-Process -detailed".

    For technical information, type: "get-help Get-Process -full".

    For online help, type: "get-help Get-Process -online"

 

 

 

-- Search Results: -------------------------------------------------------------

Your search returned 9 matches.

Items searched for:

Process

.NOTES
This cmdlet sends customized output to the host one line at a time.  For this reason, standard object output for PowerShell is not utilized.

.LINK
Online Version: http://get-help-jason-yoder.blogspot.com/2012/10/search-help.html
Get-Help