Get-Help

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 identické Get-Helps , 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í pouze základní informace o rutinách. Mezi některé moduly PowerShellu patří soubory nápovědy. Od PowerShellu 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 rutinu Update-Help .

Dokumenty nápovědy PowerShellu můžete zobrazit online. Pokud chcete získat online verzi souboru nápovědy, použijte parametr Online , například: Get-Help Get-Process -Online. Pokud chcete přečíst veškerou dokumentaci k PowerShellu, přečtěte si publikovanou dokumentaci PowerShellu.

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 titulech článku nápovědy, Get-Help zobrazí se seznam odpovídajících názvů. Pokud zadáte libovolný text, který se nezobrazuje v žádných titulech článku nápovědy, Get-Help zobrazí se seznam článků, které obsahují tento text 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-Help Nejprve hledá soubory nápovědy v národním prostředí nastaveném pro Windows, potom v nadřazené národní prostředí, například ptpro pt-BR, a potom v záložním národním prostředí. Od PowerShellu 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ů, jako jsou Povinné a Pozice, najdete v tématu about_Parameters.

Poznámka

V PowerShellu 3.0 a PowerShellu 4.0 nejde najít články o článcích v modulech, Get-Help pokud se modul nenaimportuje do aktuální relace. Jedná se o známý problém. Pokud chcete získat články o článcích v modulu, naimportujte ho buď pomocí Import-Module rutiny, nebo spuštěním rutiny, která je součástí modulu.

Příklady

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

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

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

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

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

Příklad 2: Zobrazení základních informací najednou

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

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 jednu stránku najednou.

man je alias funkce help .

Get-Help Format-Table odešle objekt do kanálu. Out-Host -Paging obdrží výstup z kanálu a zobrazí ho najednou jednu stránku. Další informace najdete 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 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ý přehled č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 efektivní pouze pro příkazy, které mají nainstalované soubory nápovědy v počítači. 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 rutiny Format-Table .

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. Nemůžete zadat příklad čísla, protože parametr Example je parametr switch.

Parametr Parametr zobrazuje pouze popisy zadaných parametrů. Pokud zadáte pouze zástupný znak hvězdičky (*), zobrazí se popisy všech parametrů. Když parametr určuje název parametru, jako je 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

V tomto příkladu se zobrazí seznam všech článků nápovědy dostupných na vašem počítači.

Get-Help *

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

V tomto příkladu se zobrazí seznam koncepčních článků, které jsou součástí nápovědy PowerShellu. Všechny tyto články začínají znaky about_. Chcete-li zobrazit konkrétní soubor nápovědy, zadejte Get-Help \<about_article-name\>Get-Help about_Signingnapříklad .

Zobrazí se jenom koncepční články, které obsahují soubory nápovědy nainstalované na vašem 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 k rutině.

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-Helppomocí úplného parametru získáte informace o nápovědě .Add-Member Objekt MamlCommandHelpInfo se odešle do kanálu. Out-String pomocí parametru Stream převede objekt na řetězec. Select-String pomocí parametru Pattern vyhledá řetězec clixml.

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

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

Když zadáte slovo, které se nezobrazí v žádném názvu článku, Get-Help zobrazí se seznam článků, 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 poskytovatele

Tento příklad ukazuje dva způsoby získání nápovědy Get-Itemspecifické pro poskytovatele . Tyto příkazy vám pomůžou vysvětlit, jak tuto rutinu Get-Item používat v uzlu DataCollection zprostředkovatele PowerShellu SQL Server.

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

Druhý příklad slouží Set-Location k přechodu na cestu poskytovatele SQL Server. V tomto umístění není parametr Path nutný k Get-Help získání nápovědy specifické pro zprostředkovatele.

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
  • Zprostředkovatel
  • Obecné
  • Časté otázky
  • Slovníček
  • Helpfile
  • ScriptCommand
  • Funkce
  • Filtrovat
  • ExternalScript
  • Vše
  • DefaultHelp
  • Pracovní postup
  • 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
Accept pipeline input:False
Accept wildcard characters:False

-Component

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

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

-Detailed

Přidá popisy parametrů a příklady do zobrazení základní nápovědy. Tento parametr je účinný 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
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Zobrazí jenom název, synopsis a příklady. Chcete-li zobrazit pouze příklady, zadejte (Get-Help \<cmdlet-name\>).Examples.

Tento parametr je účinný 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
Accept pipeline input:False
Accept wildcard characters:False

-Full

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

Tento parametr je účinný 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
Accept pipeline input:False
Accept wildcard characters:False

-Functionality

Zobrazí nápovědu k položkám se zadanými funkcemi. Zadejte funkci. Jsou povoleny zástupné znaky. Tento parametr nemá žádný vliv na zobrazení koncepční nápovědy (About_).

Type:String[]
Position:Named
Default value:None
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 skriptu a název souboru.

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 libovolný text, který neodpovídá názvům článků nápovědy, Get-Help zobrazí seznam článků, které tento text obsahují do 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
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 rutiny, funkce, pracovního postupu a skriptu. Ve vzdálené relaci nemůžete použít parametr Get-HelpOnline.

Informace o podpoře této funkce 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
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

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

Type:String[]
Position:Named
Default value:None
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 rutina funguje v zadané cestě zprostředkovatele PowerShellu. Tento parametr je účinný pouze pro nápovědu k rutině zprostředkovatele a pouze v případě, že poskytovatel obsahuje vlastní verzi článku nápovědy rutiny poskytovatele do souboru nápovědy. 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 použijte parametr Get-HelpPath k zadání cesty zprostředkovatele. Vlastní nápovědu k rutinám najdete online v části nápovědy poskytovatele článků nápovědy.

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

Type:String
Position:Named
Default value:None
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
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 pro zobrazení, včetně možností pro zobrazení pouze 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 aplikaci. Nepodporuje nápovědu poskytovatele.

Tento parametr byl znovu představen v PowerShellu 7.0.

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

Vstupy

None

Do kanálu Get-Helpnemůžete odesílat 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 se zobrazí příkaz, který obsahuje soubor nápovědy, Get-Help vrátí objekt MamlCommandHelpInfo .

Poznámky

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

Můžete si také přečíst články nápovědy o příkazech, které jsou součástí PowerShellu online, počínaje Začínáme s Windows PowerShell.

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í, Get-Help chová se, jako 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. Na Windows 10 nebo vyšších nastaveních, v jazycečasu&.

Ú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 určeném místě.

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

  • Numeric 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. Například označuje, 2 že když je název parametru vynechán, musí být parametr druhým nebo pouze nepojmenovaným parametrem v příkazu. Při použití názvu parametru se parametr může 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. Označuje, jestli můžete (true) nebo nemůžete (false) 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 (?).