Segítség! (Get-Help)

A PowerShell kiterjedt belső súgórendszerrel rendelkezik, a súgótémák teljes listáját a get‑help  paranccsal kérhetjük le (itt most helytakarékosságból csak az ’a’ betűvel kezdődő témákat):

[5] PS C:\> get-help a*

 

Name                              Category  Synopsis

----                              --------  --------

ac                                Alias     Add-Content

asnp                              Alias     Add-PSSnapin

Add-History                       Cmdlet    Appends entries to the session ...

Add-PSSnapin                      Cmdlet    Adds one or more Windows PowerS...

Add-Member                        Cmdlet    Adds a user-defined custom memb...

Add-Type                          Cmdlet    Adds a Microsoft .NET Framework...

Add-Content                       Cmdlet    Adds content to the specified i...

Add-Computer                      Cmdlet    Add the local computer to a dom...

Alias                             Provider  Provides access to the Windows ...

PowerShell 3.0 után már nincs alaphelyzetben súgó telepítve. Használhatjuk az online súgót az -Online kapcsoló használatával (lásd később), vagy töltsük le és telepítsük a help súgókat! Ehhez helyi rendszergazda jogosultsággal kell rendelkezni, és a PowerShell-t emelt szintű jogosultsággal (Run as Administrator) kell futtatni, mert a súgóállományok a c:\Windows\System32\WindowsPowerShell könyvtár alá kerülnek:

PS C:\> Update-Help

Ha van telepített súgónk, akkor a megjelenő listában szerepel valamennyi alias, cmdlet, provider és számos olyan súgótéma, amely nem konkrét utasításhoz, hanem valamely PowerShellbeli fogalomhoz köthető. A lista egyes elemeihez tartozó súgótéma a következő paranccsal kérhető le:

get-help –name <alias, cmdlet, provider, helpfile>

Például:

[7] PS C:\> get-help Add-Content

 

NAME

    Add-Content

 

SYNOPSIS

    Adds content to the specified items, such as adding words to a file.

 

 

SYNTAX

    Add-Content [-LiteralPath] <string[]> [-Value] <Object[]> [-Credential <PS

    Credential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <

    string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonPara

    meters>]

 

    Add-Content [-Path] <string[]> [-Value] <Object[]> [-Credential <PSCredent

Ha a Get-Help helyett a help függvény t használjuk, akkor a szöveget oldalakra tördelve láthatjuk.

Ha nem tudjuk a keresett funkcióhoz tartozó cmdlet teljes nevét, megtippelhetjük a kéttagú kifejezés egyik felét, vagy bármilyen töredékét, és ez alapján is kérhetünk segítséget. Az alábbi utasítás például kilistázza valamennyi Service végződésű parancsot:

[8] PS C:\> get-help *-service

 

Name                              Category  Synopsis

----                              --------  --------

Get-Service                       Cmdlet    Gets the services on a local or...

Stop-Service                      Cmdlet    Stops one or more running servi...

Start-Service                     Cmdlet    Starts one or more stopped serv...

Suspend-Service                   Cmdlet    Suspends (pauses) one or more r...

Resume-Service                    Cmdlet    Resumes one or more suspended (...

Restart-Service                   Cmdlet    Stops and then starts one or mo...

Set-Service                       Cmdlet    Starts, stops, and suspends a s...

New-Service                       Cmdlet    Creates a new Windows service.

A megjelenő listából a pontos név és a rövid leírás alapján már könnyen kiválaszthatjuk a megfelelőt. Az egyes cmdletek súgóoldalai négy különböző nézetben is megjeleníthetők. A nézetet a Get-Help paramétereivel választhatjuk ki. Alapértelmezés szerint egy rövidített, gyors áttekintésre alkalmas változat jelenik meg. A -detailed paraméter használatával egy bővebb változat, az ‑example paraméter hatására csak a mintapéldák (ezek nagyon hasznosak lehetnek), a -full paraméter segítségével pedig teljes súgótéma jeleníthető meg.

A PowerShellben nagyon sok fogalom is van, szerencsére ezekre is van súgó-téma. Ezeket about_ előtaggal látták el:

[9] PS C:\> get-help about_*

 

Name                              Category  Synopsis

----                              --------  --------

about_aliases                     HelpFile  Describes how to use alternate ...

about_Arithmetic_Operators        HelpFile  Describes the operators that pe...

about_arrays                      HelpFile  Describes a compact data struct...

about_Assignment_Operators        HelpFile  Describes how to use operators ...

about_Automatic_Variables         HelpFile  Describes variables that store ...

about_Break                       HelpFile  Describes a statement you can u...

about_command_precedence          HelpFile  Describes how Windows PowerShel...

about_Command_Syntax              HelpFile  Describes the notation used for...

about_Comment_Based_Help          HelpFile  Describes how to write comment-...

Érdemes ezeket is elolvasni, mert gyakran olyan referenciainformációk is fellelhetők bennük, amelyek ilyen „tanító” jellegű könyvekben nem szerepelnek.



Word To HTML Converter