Sdílet prostřednictvím

Get-Help

  • Reference
Modul:
Microsoft.PowerShell.Core

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

Syntaxe

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 zobrazuje 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ásledovaný názvem rutiny, například: Get-Help Get-Process.

Koncepční nápovědní články v PowerShellu začínají textem about_, například jako 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ásledovaný názvem 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> -?je shodná s Get-Help, ale funguje jenom pro cmdlety.

Get-Help získá obsah nápovědy, který zobrazuje, ze souborů nápovědy na vašem počítači. Bez souborů nápovědy Get-Help zobrazí jen základní informace o cmdletech. 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 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 následovaný přesným názvem článku nápovědy nebo slovem jedinečným 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í nápovědu 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í seznam odpovídajících názvů. Pokud zadáte jakýkoliv text, který se nezobrazí v žádných názvech článků nápovědy, Get-Help zobrazí seznam článků, které tento text obsahují v jejich obsahu.

Get-Help může získat články nápovědy pro všechny podporované jazyky a regiony. Get-Help nejprve 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 pro pt-BRa 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, které Get-Help zobrazí v diagramu syntaxe příkazů, najdete v tématu about_Command_Syntax. Informace o atributech parametrů, například Požadováno a Pozice, viz about_Parameters.

Poznámka

V PowerShellu 3.0 a PowerShellu 4.0 Get-Help nemůže najít články o v modulech, pokud se modul nenaimportuje do aktuální relace. Pokud chcete získat články o v modulu, importujte modul pomocí rutiny Import-Module 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ím bufferu obrazovky se stránkováním.

Když stisknete klávesu F1, funkce PSReadLineShowCommandHelp vyvolá Get-Help -Full pro název rutiny 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ž 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.

Při použití kombinace kláves Alt+h, funkce PSReadLineShowParameterHelp zobrazí informace nápovědy pro parametr bezprostředně vlevo 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 naleznete v tématu Použití dynamické nápovědy.

Příklady

Příklad 1: Zobrazení základní nápovědy k příkazu

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

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 cmdlety.

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

Tyto příklady zobrazují základní informace nápovědy o příkazovém modulu Format-Table jednu stránku po druhé.

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

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

man je alias pro funkci help.

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

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

Tyto příklady zobrazují podrobnější informace o nápovědě k rutině Format-Table.

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

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

Parametr Full zobrazuje ú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.

Parametry Podrobné a Úplné jsou platné pouze pro příkazy, které mají nainstalované soubory nápovědy na počítači. Parametry nefungují účinně pro konceptuální články nápovědy (about_).

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

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

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

Parametr Příklady zobrazuje oddíly NAME a SYNOPSIS souboru nápovědy, stejně jako všechny příklady. Nelze zadat číslo příkladu, 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 popisy všech parametrů. Když 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 v našem 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ů zobrazuje 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 konkrétní 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 update-help .

Get-Help about_*

Příklad 9: Hledání slova v nápovědě ke cmdletu

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

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-Help k získání informací o nápovědě pro Add-Memberpoužívá parametr Full . Objekt MamlCommandHelpInfo se odešle do potrubí. Out-String používá parametr Stream k převodu objektu na řetězec. Select-String používá parametr vzoru k vyhledání řetězce pro Clixml.

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

Tento příklad zobrazí seznam článků, které obsahují slovo vzdálený přístup.

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

Tento příklad ukazuje dva způsoby, jak získat poskytovatelskou specifickou nápovědu pro Get-Item. Tyto příkazy získají nápovědu, která vysvětluje, jak používat rutinu Get-Item v uzlu poskytovatele SQL Serveru PowerShellu DataCollection.

První příklad používá parametr Get-HelpPath 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í.

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

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 pro MyScript.ps1 script. Informace o tom, jak psát nápovědu pro funkce a skripty, naleznete 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
  • Příkaz Cmdlet
  • Poskytovatel
  • Obecné
  • FAQ
  • Glosář
  • HelpFile
  • Příkaz skriptu
  • Funkce
  • Filtr
  • ExternalScript
  • Všichni
  • DefaultHelp
  • Pracovní postup
  • DscResource
  • Třída
  • Konfigurace
Typ:String[]
Přípustné hodnoty:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í konceptuální nápovědy (About_).

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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_).

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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_).

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Full

Zobrazí celý článek nápovědy pro cmdlet. Úplný obsahuje 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_).

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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_).

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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 proměnné prostředí $env:Path, zadejte cestu a název souboru skriptu.

Pokud zadáte přesný název článku nápovědy, Get-Help zobrazí 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í seznam odpovídajících názvů.

Pokud zadáte jakýkoli text, který neodpovídá názvům článků nápovědy, Get-Help zobrazí seznam článků, 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.

Typ:String
Position:0
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky: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 funkce, pracovní postupy, skripty a rutiny. Ve vzdálené relaci nemůžete použít parametr Online s Get-Help.

Informace o tom, jak podporovat tuto funkci v článcích nápovědy, které píšete, najdete v tématech about_Comment_Based_Help, Podpora online nápovědya Psaní nápovědy pro rutiny PowerShellu.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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_).

Typ:String[]
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-Path

Získá nápovědu, která vysvětluje, jak cmdlet funguje ve specifikované cestě poskytovatele. Zadejte cestu zprostředkovatele PowerShellu.

Tento parametr získá přizpůsobenou verzi článku nápovědy cmdletu, která vysvětluje, jak cmdlet funguje v určené cestě poskytovatele 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 na umístění cesty zprostředkovatele a zadejte příkaz Get-Help nebo z libovolného umístění použijte parametr PathGet-Help k určení cesty zprostředkovatele. Vlastní nápovědu k cmdletům najdete online v sekci 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.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í cmdlety.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-ShowWindow

Zobrazí téma nápovědy v okně pro snadnější čtení. Toto okno obsahuje funkci hledání Najít 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. Nepodporuje podporu poskytovatele.

Tento parametr byl znovu zaveden v PowerShellu 7.0. Tento parametr je k dispozici pouze ve Windows.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Do této rutiny nemůžete předávat objekty.

Výstupy

ExtendedCmdletHelpInfo

Pokud spustíte Get-Help na příkazu, 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 ho vrátí jako řetězec.

MamlCommandHelpInfo

Pokud obdrží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. Pokud chcete stáhnout a nainstalovat soubory nápovědy, které Get-Help čte, použijte cmdlet Update-Help. Pomocí 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, počínaje 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í, Get-Help se chová, 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ích panelech. Ve Windows 10 nebo novějším Nastavení, času & jazyka.

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

  • Požadované. 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ě.

  • 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 2 označuje, ž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 (false) odesílat objekty do parametru prostřednictvím roury. Podle názvu vlastnosti znamená, že zpracovávaný objekt v potrubí musí mít vlastnost se stejným názvem 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 (?).