Get-Help

  • Reference
Modul:
Microsoft.PowerShell.Core

Zobrazí informace o příkazech a konceptech PowerShellu.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

Rutina Get-Help zobrazí informace o konceptech a příkazech PowerShellu, včetně rutin, funkcí, příkazů CIM (Common Information Model), pracovních postupů, poskytovatelů, aliasů a skriptů.

Pokud chcete získat nápovědu pro rutinu PowerShellu, zadejte Get-Help název rutiny, například: Get-Help Get-Process.

Koncepční články nápovědy v PowerShellu začínají about_, například about_Comparison_Operators. Pokud chcete zobrazit všechny about_ články, zadejte Get-Help about_*. Pokud chcete zobrazit konkrétní článek, zadejte Get-Help about_<article-name>například Get-Help about_Comparison_Operators.

Pokud chcete získat nápovědu pro zprostředkovatele PowerShellu, zadejte Get-Help název zprostředkovatele. Pokud například chcete získat nápovědu pro zprostředkovatele certifikátu, zadejte Get-Help Certificate.

Můžete také zadat help nebo man, který zobrazuje jednu obrazovku textu najednou. Nebo , <cmdlet-name> -?to je stejné Get-Helpjako , ale funguje jenom pro rutiny.

Get-Help získá obsah nápovědy, který se zobrazí ze souborů nápovědy v počítači. Bez souborů Get-Help nápovědy se zobrazí jenom základní informace o rutinách. Některé moduly PowerShellu obsahují soubory nápovědy. Počínaje PowerShellem 3.0 neobsahují moduly, které jsou součástí operačního systému Windows, soubory nápovědy. Pokud chcete stáhnout nebo aktualizovat soubory nápovědy pro modul v PowerShellu 3.0, použijte tuto rutinu Update-Help .

Dokumenty nápovědy PowerShellu můžete zobrazit také online. Pokud chcete získat online verzi souboru nápovědy, použijte parametr Online , například: Get-Help Get-Process -Online.

Pokud zadáte Get-Help přesný název článku nápovědy nebo slovo jedinečné pro článek nápovědy, Get-Help zobrazí obsah článku. Pokud zadáte přesný název aliasu příkazu, Get-Help zobrazí se nápověda pro původní příkaz. Pokud zadáte slovo nebo vzor slova, který se zobrazí v několika názvech článků nápovědy, Get-Help zobrazí se seznam odpovídajících názvů. Pokud zadáte jakýkoli text, který se nezobrazí v žádných názvech článků nápovědy, zobrazí se seznam článků, Get-Help které tento text obsahují v jejich obsahu.

Get-Help může získat články nápovědy pro všechny podporované jazyky a národní prostředí. Get-Helpnejprve hledá soubory nápovědy v národním prostředí nastaveném pro Windows, pak v nadřazené národní prostředí, například pt-BR, a potom v záložním národním prostředí. Počínaje PowerShellem 3.0, pokud Get-Help nenajde nápovědu v záložním národním prostředí, vyhledá články nápovědy v angličtině, en-US, než vrátí chybovou zprávu nebo zobrazí automaticky vygenerovanou nápovědu.

Informace o symbolech zobrazených Get-Help v diagramu syntaxe příkazů najdete v tématu about_Command_Syntax. Informace o atributech parametrů, například Povinné a Pozice, naleznete v tématu about_Parameters.

Poznámka:

V PowerShellu 3.0 a PowerShellu 4.0 nejde najít články o modulech, Get-Help pokud se modul nenaimportuje do aktuální relace. Pokud chcete získat články o modulu, importujte modul pomocí Import-Module rutiny nebo spuštěním rutiny, která je součástí modulu.

Počínaje psReadLine v2.2.2 se modul dodává se dvěma funkcemi, které poskytují rychlý přístup k nápovědě při psaní příkazu na příkazovém řádku. Nápověda se zobrazí v terminálu v alternativní vyrovnávací paměti obrazovky se stránkováním.

Když stisknete klávesu F1, funkce PSReadLineShowCommandHelp vyvolá název rutiny Get-Help -Full nejblíže nalevo od kurzoru. Když je kurzor hned nalevo od parametru, funkce přejde do popisu tohoto parametru v úplném tématu nápovědy. Když stisknutím klávesy Q ukončíte zobrazení nápovědy, vrátíte se na příkazový řádek na stejné pozici kurzoru, abyste mohli pokračovat v psaní příkazu.

Když použijete kombinaci kláves Alt+h, funkce PSReadLineShowParameterHelp zobrazí informace nápovědy pro parametr okamžitě nalevo od kurzoru. Text nápovědy se zobrazí pod příkazovým řádkem. To vám umožní zobrazit popis parametru a pokračovat v psaní příkazu.

Další informace najdete v tématu Použití dynamické nápovědy.

Příklady

Příklad 1: Zobrazení základních informací nápovědy k rutině

Tyto příklady zobrazují základní informace o rutině nápovědy Format-Table .

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> je nejjednodušší a výchozí syntaxe Get-Help rutiny. Parametr Name můžete vynechat.

Syntaxe <cmdlet-name> -? funguje jenom pro rutiny.

Příklad 2: Zobrazení základních informací po jedné stránce

Tyto příklady zobrazují základní informace nápovědy o Format-Table rutině po jedné stránce.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help je funkce, která spouští Get-Help rutinu interně a zobrazuje výsledek po jedné stránce.

man je alias funkce help .

Get-Help Format-Table odešle objekt dolů kanálu. Out-Host -Paging obdrží výstup z kanálu a zobrazí ho po jedné stránce. Další informace naleznete v tématu Out-Host.

Příklad 3: Zobrazení dalších informací pro rutinu

Tyto příklady zobrazují podrobnější informace nápovědy o této rutině Format-Table .

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Podrobný parametr zobrazí podrobné zobrazení článku nápovědy, které obsahuje popisy parametrů a příklady.

Úplný parametr zobrazí úplné zobrazení článku nápovědy, které obsahuje popisy parametrů, příklady, typy vstupních a výstupních objektů a další poznámky.

Podrobné a úplné parametry jsou platné pouze pro příkazy, které mají v počítači nainstalované soubory nápovědy. Parametry nejsou efektivní pro koncepční články nápovědy (about_).

Příklad 4: Zobrazení vybraných částí rutiny pomocí parametrů

Tyto příklady zobrazují vybrané části nápovědy Format-Table rutiny.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Parametr Příklady zobrazí oddíly NAME a SYNOPSIS souboru nápovědy a všechny příklady. Nelze zadat ukázkové číslo, protože parametr Příklady je parametr přepínače.

Parametr Parametr zobrazuje pouze popisy zadaných parametrů. Pokud zadáte pouze zástupný znak hvězdičky (*), zobrazí se popis všech parametrů. Pokud parametr určuje název parametru, například GroupBy, zobrazí se informace o tomto parametru.

Tyto parametry nejsou efektivní pro koncepční články nápovědy (about_).

Příklad 5: Zobrazení online verze nápovědy

Tento příklad zobrazí online verzi článku nápovědy pro rutinu Format-Table ve výchozím webovém prohlížeči.

Get-Help Format-Table -Online

Příklad 6: Zobrazení nápovědy k systému nápovědy

Rutina Get-Help bez parametrů zobrazí informace o systému nápovědy PowerShellu.

Get-Help

Příklad 7: Zobrazení dostupných článků nápovědy

Tento příklad zobrazí seznam všech článků nápovědy dostupných v počítači.

Get-Help *

Příklad 8: Zobrazení seznamu koncepčních článků

Tento příklad zobrazí seznam koncepčních článků zahrnutých v nápovědě k PowerShellu. Všechny tyto články začínají znaky about_. Chcete-li zobrazit určitý soubor nápovědy, zadejte Get-Help \<about_article-name\>například Get-Help about_Signing.

Zobrazí se jenom koncepční články s nainstalovanými soubory nápovědy v počítači. Informace o stahování a instalaci souborů nápovědy v PowerShellu 3.0 najdete v nápovědě k aktualizaci.

Get-Help about_*

Příklad 9: Hledání slova v nápovědě k rutině

Tento příklad ukazuje, jak vyhledat slovo v článku nápovědy rutiny.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Helpk získání informací nápovědy pro Add-Member. Objekt MamlCommandHelpInfo je odeslán v kanálu. Out-String pomocí parametru Stream převede objekt na řetězec. Select-String pomocí parametru Pattern vyhledá řetězec pro clixml.

Příklad 10: Zobrazení seznamu článků, které obsahují slovo

V tomto příkladu se zobrazí seznam článků, které obsahují slovo vzdálené komunikace.

Když zadáte slovo, které se nezobrazí v žádném názvu článku, zobrazí se seznam článků, Get-Help které toto slovo obsahují.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Příklad 11: Zobrazení nápovědy specifické pro zprostředkovatele

Tento příklad ukazuje dva způsoby získání nápovědy specifické pro poskytovatele pro Get-Item. Tyto příkazy získají nápovědu, která vysvětluje, jak tuto rutinu Get-Item použít v uzlu DataCollection zprostředkovatele SQL Serveru PowerShellu.

První příklad používá Get-Helpparametr Path k určení cesty zprostředkovatele SQL Serveru. Vzhledem k tomu, že je zadaná cesta zprostředkovatele, můžete příkaz spustit z libovolného umístění cesty.

Druhý příklad používá Set-Location k přechodu na cestu zprostředkovatele SQL Serveru. Z daného umístění není k získání nápovědy specifického pro zprostředkovatele potřeba Get-Help parametr Path.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Příklad 12: Zobrazení nápovědy pro skript

Tento příklad získá nápovědu MyScript.ps1 scriptpro . Informace o tom, jak psát nápovědu pro funkce a skripty, najdete v tématu about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parametry

-Category

Zobrazí nápovědu pouze pro položky v zadané kategorii a jejich aliasy. Koncepční články jsou v kategorii HelpFile .

Přijatelné hodnoty pro tento parametr jsou následující:

  • Alias
  • Rutina
  • Poskytovatel
  • OBECNÉ
  • Často kladené dotazy
  • Slovník pojmů
  • Helpfile
  • ScriptCommand
  • Function
  • Filtrovat
  • ExternalScript
  • Vše
  • DefaultHelp
  • Workflow
  • DscResource
  • Třída
  • Konfigurace
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Zobrazí příkazy se zadanou hodnotou součásti, například Exchange. Zadejte název komponenty. Jsou povoleny zástupné znaky. Tento parametr nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Detailed

Přidá popisy parametrů a příklady do základního zobrazení nápovědy. Tento parametr je efektivní pouze v případě, že jsou v počítači nainstalovány soubory nápovědy. Nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Zobrazí pouze název, synopzi a příklady. Tento parametr je efektivní pouze v případě, že jsou v počítači nainstalovány soubory nápovědy. Nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Full

Zobrazí celý článek nápovědy pro rutinu. Úplné zahrnuje popisy a atributy parametrů, příklady, typy vstupních a výstupních objektů a další poznámky.

Tento parametr je efektivní pouze v případě, že jsou v počítači nainstalovány soubory nápovědy. Nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

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

-Functionality

Zobrazí nápovědu k položkám se zadanou funkcí. Zadejte funkci. Jsou povoleny zástupné znaky. Tento parametr nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Získá nápovědu k zadanému příkazu nebo konceptu. Zadejte název rutiny, funkce, zprostředkovatele, skriptu nebo pracovního postupu, například Get-Member, koncepční název článku, například about_Objectsnebo alias, například ls. Zástupné znaky jsou povoleny v názvech rutin a zprostředkovatelů, ale nemůžete použít zástupné znaky k vyhledání názvů nápovědy k funkcím a článků nápovědy ke skriptům.

Pokud chcete získat nápovědu pro skript, který není umístěný v cestě uvedené v $env:Path proměnné prostředí, zadejte cestu a název souboru skriptu.

Pokud zadáte přesný název článku nápovědy, Get-Help zobrazí se obsah článku.

Pokud zadáte slovo nebo vzor slova, který se zobrazí v několika názvech článků nápovědy, Get-Help zobrazí se seznam odpovídajících názvů.

Pokud zadáte jakýkoli text, který neodpovídá názvům článků nápovědy, zobrazí se seznam článků, Get-Help které tento text obsahují v jejich obsahu.

Názvy koncepčních článků, například about_Objects, musí být zadány v angličtině, a to i v neanglických verzích PowerShellu.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Online

Zobrazí online verzi článku nápovědy ve výchozím prohlížeči. Tento parametr je platný jenom pro články nápovědy pro rutiny, funkce, pracovní postup a skripty. Ve vzdálené relaci nemůžete použít parametr Get-Help Online.

Informace o podpoře této funkce najdete v článcích nápovědy, které píšete, najdete v tématu about_Comment_Based_Help a podpora online nápovědy a psaní nápovědy pro rutiny PowerShellu.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Zobrazí pouze podrobné popisy zadaných parametrů. Jsou povoleny zástupné cardy. Tento parametr nemá žádný vliv na zobrazení konceptuální nápovědy (About_).

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Path

Získá nápovědu, která vysvětluje, jak rutina funguje v zadané cestě zprostředkovatele. Zadejte cestu zprostředkovatele PowerShellu.

Tento parametr získá přizpůsobenou verzi článku nápovědy rutiny, který vysvětluje, jak tato rutina funguje v zadané cestě zprostředkovatele PowerShellu. Tento parametr je efektivní pouze pro nápovědu k rutině zprostředkovatele a pouze v případě, že poskytovatel do souboru nápovědy obsahuje vlastní verzi článku nápovědy k rutině zprostředkovatele. Pokud chcete tento parametr použít, nainstalujte soubor nápovědy pro modul, který obsahuje zprostředkovatele.

Pokud chcete zobrazit nápovědu k vlastní rutině pro cestu zprostředkovatele, přejděte do umístění cesty zprostředkovatele a zadejte Get-Help příkaz nebo z libovolného umístění cesty zadejte cestu poskytovatele pomocí parametru Get-Help Path. Vlastní nápovědu k rutinám najdete online v části nápovědy poskytovatele v článcích nápovědy.

Další informace o poskytovateli PowerShellu najdete v tématu about_Providers.

Poznámka:

Zprostředkovatel pro zadanou cestu musí mít nainstalovaný soubor nápovědy zprostředkovatele PowerShellu. Pokud není k dispozici žádný soubor nápovědy zprostředkovatele, nevrátí se žádné informace o nápovědě. Pro poskytovatele, kteří jsou součástí této verze PowerShellu, nejsou k dispozici žádné soubory nápovědy zprostředkovatele.

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

-Role

Zobrazí nápovědu přizpůsobenou pro zadanou roli uživatele. Zadejte roli. Jsou povoleny zástupné znaky.

Zadejte roli, kterou uživatel hraje v organizaci. Některé rutiny zobrazují v souborech nápovědy jiný text na základě hodnoty tohoto parametru. Tento parametr nemá žádný vliv na nápovědu pro základní rutiny.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowWindow

Zobrazí téma nápovědy v okně pro snadnější čtení. Okno obsahuje funkci Hledání a pole Nastavení, které umožňuje nastavit možnosti zobrazení, včetně možností pro zobrazení jenom vybraných oddílů tématu nápovědy.

Parametr ShowWindow podporuje témata nápovědy pro příkazy (rutiny, funkce, příkazy CIM, skripty) a koncepční články o produktu. Nepodporuje pomoc poskytovatele.

Tento parametr byl znovu vyvolána v PowerShellu 7.0. Tento parametr je k dispozici pouze ve Windows.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

None

Do této rutiny nemůžete roušit objekty.

Výstupy

ExtendedCmdletHelpInfo

Pokud spustíte Get-Help příkaz, který nemá soubor nápovědy, Get-Help vrátí ExtendedCmdletHelpInfo objekt, který představuje automaticky vygenerovanou nápovědu.

String

Pokud získáte koncepční článek nápovědy, Get-Help vrátí ho jako řetězec.

MamlCommandHelpInfo

Pokud získáte příkaz, který obsahuje soubor nápovědy, Get-Help vrátí objekt MamlCommandHelpInfo .

Poznámky

PowerShell 3.0 neobsahuje soubory nápovědy. Ke stažení a instalaci souborů nápovědy, které Get-Help se čtou, použijte rutinu Update-Help . Pomocí této rutiny Update-Help můžete stáhnout a nainstalovat soubory nápovědy pro základní příkazy, které jsou součástí PowerShellu, a pro všechny moduly, které instalujete. Můžete ho také použít k aktualizaci souborů nápovědy tak, aby byla nápověda na vašem počítači nikdy zastaralá.

Můžete si také přečíst články nápovědy o příkazech, které jsou součástí PowerShellu online, a to od začínáme s Windows PowerShellem.

Get-Help zobrazí nápovědu v národním prostředí nastaveném pro operační systém Windows nebo v náhradním jazyce pro dané národní prostředí. Pokud nemáte soubory nápovědy pro primární nebo záložní národní prostředí, chová se jako Get-Help by v počítači nebyly žádné soubory nápovědy. Pokud chcete získat nápovědu pro jiné národní prostředí, změňte nastavení pomocí oblasti a jazyka v Ovládací panely. Ve Windows 10 nebo novějším Nastavení, Time &Language.

Úplné zobrazení nápovědy obsahuje tabulku informací o parametrech. Tabulka obsahuje následující pole:

  • Povinný: Určuje, jestli je parametr povinný (true) nebo nepovinný (false).

  • Pozice. Určuje, zda je parametr pojmenovaný nebo poziční (číselný). Poziční parametry se musí v příkazu objevit na zadaném místě.

  • Název označuje, že je požadován název parametru, ale že se parametr může objevit kdekoli v příkazu.

  • Číselná hodnota označuje, že název parametru je nepovinný, ale pokud je název vynechán, musí být parametr na místě určeném číslem. Označuje například, 2 že pokud je název parametru vynechán, musí být parametr druhým nebo pouze nepojmenovaným parametrem v příkazu. Když se použije název parametru, může se parametr objevit kdekoli v příkazu.

  • Výchozí hodnota. Hodnota parametru nebo výchozí chování, které PowerShell používá, pokud parametr nezahrnete do příkazu.

  • Přijímá vstup kanálu. Určuje, jestli můžete (true) nebo nemůžete (nepravda) odesílat objekty do parametru prostřednictvím kanálu. Podle názvu vlastnosti znamená, že objekt kanálu musí mít vlastnost, která má stejný název jako název parametru.

  • Přijímá zástupné znaky. Určuje, jestli hodnota parametru může obsahovat zástupné znaky, například hvězdičku (*) nebo otazník (?).