Share via

Get-Help

  • Reference
Modul:
Microsoft.PowerShell.Core

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

Syntax

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

Description

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

Pokud chcete získat nápovědu k rutině PowerShellu, zadejte Get-Help za ním 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 a za ním název poskytovatele. Pokud například chcete získat nápovědu pro poskytovatele certifikátu, zadejte Get-Help Certificate.

Můžete také zadat help nebo man, který zobrazuje jednu obrazovku s textem najednou. <cmdlet-name> -?Nebo , který je shodný s Get-Help, ale funguje pouze pro rutiny.

Get-Help získá obsah nápovědy, který zobrazí ze souborů nápovědy v počítači. Bez souborů nápovědy Get-Help se zobrazí jenom základní informace o rutinách. Některé moduly PowerShellu obsahují soubory nápovědy. Počínaje PowerShellem 3.0 moduly, které jsou součástí operačního systému Windows, neobsahují 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 k PowerShellu můžete také zobrazit online v Microsoft Docs. Pokud chcete získat online verzi souboru nápovědy, použijte parametr Online, například: Get-Help Get-Process -Online. Pokud si chcete přečíst veškerou dokumentaci k PowerShellu, přečtěte si Microsoft Docs dokumentaci k PowerShellu.

Pokud zadáte Get-Help text následovaný přesným názvem článku nápovědy nebo slovem, které je pro daný článek nápovědy jedinečné, Get-Help zobrazí se obsah článku. Pokud zadáte vzorek slova, který se zobrazuje v několika názvech článků nápovědy, Get-Help zobrazí se seznam odpovídajících názvů. Pokud zadáte slovo, které se nezobrazuje v žádných názvech článků nápovědy, Get-Help zobrazí seznam článků, které obsahují toto slovo ve svém obsahu.

Get-Help můžete získat články nápovědy pro všechny podporované jazyky a národní prostředí. Get-Help Nejprve vyhledá 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-BR, a pak v záložním národním prostředí. Počínaje PowerShellem 3.0 platí, že 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ě a en-US, než vrátí chybovou zprávu nebo zobrazí automaticky vygenerovanou nápovědu.

Informace o symbolech, které Get-Help se zobrazují v diagramu syntaxe příkazů, najdete v tématu about_Command_Syntax. Informace o atributech parametru, například Povinné a Pozice, najdete v tématu about_Parameters.

Poznámka

V PowerShellu 3.0 a PowerShellu 4.0 nelze najít články o aplikaci v modulech, Get-Help pokud se modul neimportuje do aktuální relace. Jedná se o známý problém. Pokud chcete získat články O aplikaci v modulu, importujte modul pomocí rutiny Import-Module nebo spuštěním rutiny, která je součástí modulu.

Příklady

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

Tyto příklady zobrazují základní informace nápovědy k 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í po jedné stránce

Tyto příklady zobrazují základní informace nápovědy k rutině Format-Table 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 do kanálu. Out-Host -Paging přijímá výstup z kanálu a zobrazuje ho po stránkách. Další informace najdete v tématu Out-Host.

Příklad 3: Zobrazení dalších informací o rutině

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

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

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

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

Parametry Detailed a Full 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 k rutinám Format-Table .

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

Parametr Examples zobrazí oddíly NÁZEV a SYNOPSIS souboru nápovědy a všechny příklady. Číslo příkladu nemůžete zadat, protože parametr Examples je přepínací parametr.

Parametr Parameter zobrazí pouze popisy zadaných parametrů. Pokud zadáte pouze zástupný znak hvězdička (*), 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 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 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 k PowerShellu. Všechny tyto články začínají znaky about_. Pokud chcete 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, které mají v počítači nainstalované soubory nápovědy. Informace o stahování a instalaci souborů nápovědy v PowerShellu 3.0 najdete v tématu Update-Help.

Get-Help about_*

Příklad 9: Search 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-Helppoužívá k získání informací nápovědy k parametru Full .Add-Member MamlCommandHelpInfo Objekt je odeslán kanálem. Out-Stringpoužívá parametr Stream k převodu objektu na řetězec. Select-String pomocí parametru Pattern vyhledá v řetězci clixml.

Příklad 10: Zobrazení seznamu článků obsahujících slovo

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

Když zadáte slovo, které se nezobrazuje 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 zprostředkovatele

Tento příklad ukazuje dva způsoby získání nápovědy pro konkrétního poskytovatele pro Get-Item. Tyto příkazy získáte nápovědu, která vysvětluje, jak používat rutinu Get-Item v uzlu DataCollection zprostředkovatele PowerShellu SQL Server.

První příklad používá Get-Help parametr Path k určení cesty zprostředkovatele 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 používá Set-Location k přechodu na cestu poskytovatele SQL Server. Z této lokality není parametr Path potřeba k Get-Help získání nápovědy pro konkrétního poskytovatele.

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 ke skriptu

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 jenom 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é
  • Časté otázky
  • Glosář
  • 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Zobrazí příkazy se zadanou hodnotou komponenty, například Exchange. Zadejte název komponenty. Zástupné znaky jsou povolené. 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 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í koncepční nápovědy (About_).

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

-Examples

Zobrazí jenom název, synopsi a příklady. Pokud chcete zobrazit jenom 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í koncepční 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 k rutině. Full obsahuje popisy a atributy parametrů, 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í koncepční 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. Zástupné znaky jsou povolené. 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ího názvu článku, například about_Objects, nebo aliasu, například ls. Zástupné znaky jsou povolené 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ý se nenachází v cestě uvedené v $env:Path proměnné prostředí, zadejte cestu ke 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 vzorek slova nebo 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 slovo, které neodpovídá názvům článků nápovědy, zobrazí seznam článků, Get-Help které toto slovo obsahují ve svém obsahu.

Názvy koncepčních článků, jako about_Objectsje , 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ý pouze pro články nápovědy k rutině, funkci, pracovním postupům a skriptů. Ve vzdálené relaci nemůžete použít parametr Online s Get-Help .

Informace o podpoře této funkce v článcích nápovědy, které píšete, najdete v tématech 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é y. 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 k poskytovateli PowerShellu.

Tento parametr získá přizpůsobenou verzi článku nápovědy k rutinám, 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 zahrne do souboru nápovědy vlastní verzi článku nápovědy k rutinám zprostředkovatele. Chcete-li použít tento parametr, 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 k poskytovateli a zadejte Get-Help příkaz nebo z libovolného umístění cesty zadejte cestu k poskytovateli pomocí parametru Get-HelpPath. Nápovědu k vlastním rutinám najdete také online v části nápovědy pro poskytovatele v článcích nápovědy.

Další informace o zprostředkovatelů PowerShellu najdete v tématu about_Providers.

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. Zástupné znaky jsou povolené.

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í. Toto okno obsahuje funkci Najít 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, pracovní postupy, skripty) a koncepční články o aplikaci . Nepodporuje nápovědu poskytovatele.

Tento parametr byl zaveden v PowerShellu 3.0.

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

Vstupy

None

Objekty se nedají posílat do kanálu Get-Help.

Výstupy

ExtendedCmdletHelpInfo

Pokud spustíte Get-Help příkaz, který nemá soubor nápovědy, Get-Help vrátí objekt ExtendedCmdletHelpInfo , 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í 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é nainstalujete. Můžete ho také použít k aktualizaci souborů nápovědy, aby nápověda v počítači nikdy nebyla zastaralá.

Můžete si také přečíst články nápovědy o příkazech, které jsou součástí PowerShellu online od 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 záložní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, Get-Help jako by v počítači nebyly žádné soubory nápovědy. Pokud chcete získat nápovědu k jinému národnímu prostředí, změňte nastavení pomocí možnosti Oblast a jazyk v Ovládací panely. Na Windows 10, Nastavení, Čas & Jazyk.

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

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

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

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

  • Číselný označuje, že název parametru je volitelný, ale pokud je název vynechán, musí být parametr na místě určeném číslem. Například označuje, 2 že pokud je název parametru vynechán, musí být parametr v příkazu druhým nebo pouze nepojmenovaným parametrem. Při použití názvu parametru se parametr může zobrazit 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 ne (false) posílat objekty do parametru prostřednictvím kanálu. Název vlastnosti znamená, že objekt v 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 (?).