O aktualizovatelné nápovědě

  • Článek

KRÁTKÝ POPIS

Popisuje aktualizovatelný systém Help v prostředí PowerShell.

DLOUHÝ POPIS

Prostředí PowerShell poskytuje několik různých způsobů, jak získat přístup k nejaktuálnějším tématům nápovědy pro rutiny a koncepty prostředí PowerShell.

Aktualizovatelný systém nápovědy, představený v PowerShellu 3,0, je navržený tak, aby se zajistilo, že budete mít vždy k dispozici nejnovější témata nápovědy na místním počítači, abyste je mohli přečíst na příkazovém řádku. Usnadňuje stažení a instalaci souborů Help a jejich aktualizaci, kdykoli budou k dispozici novější soubory.

Chcete-li poskytnout aktualizovanou nápovědu pro více počítačů v podniku a pro počítače, které nemají přístup k Internetu, umožňuje aktualizovatelné možnosti stahovat soubory aplikace Help do adresáře systému souborů nebo sdílené složky a následně nainstalovat soubory aplikace Help ze sdílené složky.

V PowerShellu 4,0 se vlastnost HelpInfoUri zachovává přes vzdálenou komunikaci Windows PowerShellu, která umožňuje, aby fungovala možnost Save-Help pro moduly nainstalované na vzdáleném počítači, ale nemusí být nutně nainstalovaná na místním počítači. Objekt PSModuleInfo můžete uložit na disk nebo vyměnitelné médium (například jednotky USB) spuštěním exportu-CLIXML na počítači, který nemá přístup k Internetu, a importem objektu PSModuleInfo v počítači, který má přístup k Internetu, a následným spuštěním Save-Help u objektu PSModuleInfo. Uloženou aplikaci můžete zkopírovat do vzdáleného, odpojeného počítače pomocí vyměnitelného média a potom nainstalovat spuštěním aktualizace-help. Tato vylepšení funkcí Save-Help umožňují nainstalovat podporu do počítačů, které nemají žádný druh přístupu k síti. Příklad toho, jak používat novou funkci Save-Help, najdete v části jak aktualizovat NÁPOVĚDU ze sdílené složky: Uložit-Nápověda v tomto tématu.

Aktualizovatelná podpora také podporuje online přístup k nejnovějším tématům nápovědy a základní nápovědě k rutinám, i když v počítači nejsou žádné soubory nápovědy.

PowerShell 3,0 není součástí souborů help. Pomocí funkce aktualizovat nápovědu můžete nainstalovat soubory aplikace Help pro všechny příkazy, které jsou ve výchozím nastavení zahrnuty v prostředí PowerShell a pro všechny moduly systému Windows.

AKTUALIZOVATELNÉ RUTINY HELP

  • Aktualizace-Help: stáhne nejnovější soubory s podporou z Internetu nebo sdílené složky a nainstaluje je do místního počítače.

  • Uložit-Help: stáhne nejnovější soubory s podporou z Internetu a uloží je do adresáře systému souborů nebo sdílené složky. Chcete-li nainstalovat soubory aplikace Help do počítačů, použijte příkaz Update-Help.

  • Get-Help: zobrazí témata nápovědy na příkazovém řádku. Načte z souborů s příponou Help v počítači. Zobrazí automaticky generovanou nápovědu k rutinám a funkcím, které nemají soubory s nápovědu. Otevře online témata nápovědy pro rutiny, funkce, skripty a pracovní postupy ve výchozím internetovém prohlížeči.

AKTUALIZACE HELPu v prostředí PowerShell ISE

V nabídce Help v integrovaném skriptovacím prostředí (ISE) prostředí PowerShell můžete také aktualizovat aplikaci Help pomocí položky "aktualizovat PowerShell Help".

Položka "aktualizovat PowerShell Help" spustí příkaz Update-Help bez parametrů.

AUTOMATICKY VYGENEROVANÁ HELP: HELP BEZ SOUBORŮ HELP

Pokud v počítači nemáte soubor nápovědy pro rutinu, funkci nebo pracovní postup, rutina Get-Help zobrazí automaticky vygenerovanou nápovědu a zobrazí výzvu ke stažení souborů nápovědy nebo jejich čtení online.

Automaticky generovaná nápovědu obsahuje syntaxi a aliasy a poznámky, které vysvětlují použití aktualizovatelných rutin nápovědy a přístup k tématům nápovědy online.

Například následující příkaz Získá základní nápovědu pro rutinu Get-culture. Výstup zobrazuje zobrazení Get-Help, když počítač neobsahuje žádné soubory s nápovědami.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

SOUBORY S NÁPOVĚDU PRO MODULY

Nejmenší jednotka aktualizovatelného pomocníka je nápovědu pro modul. Pomocník pro modul obsahuje nápovědu ke všem rutinám, funkcím, pracovním postupům, poskytovatelům, skriptům a konceptům v modulu. Můžete aktualizovat nápovědu pro všechny moduly, které jsou nainstalovány v počítači, a to i v případě, že nejsou importovány do aktuální relace.

Můžete aktualizovat nápovědu pro celý modul, ale nelze aktualizovat nápovědu pro jednotlivé rutiny.

Chcete-li najít modul, který obsahuje konkrétní rutinu, použijte následující formát příkazu:

(Get-Command <cmdlet-name>).ModuleName

Chcete-li například najít modul obsahující rutinu Set-ExecutionPolicy, zadejte:

(Get-Command Set-ExecutionPolicy).ModuleName

Chcete-li aktualizovat nápovědu pro určitý modul, zadejte:

Update-Help -Module <ModuleName>

Například chcete-li aktualizovat nápovědu pro modul, který obsahuje rutinu Set-ExecutionPolicy, zadejte:

Update-Help -Module Microsoft.PowerShell.Security

OPRÁVNĚNÍ PRO AKTUALIZOVATELNOU NÁPOVĚDU

Chcete-li aktualizovat nápovědu pro moduly v $ \ adresáři modulů pshome, musíte být členem skupiny Administrators v počítači.

Pokud nejste členem skupiny Administrators, nemůžete pro tyto moduly aktualizovat nápovědu. Pokud ale máte přístup k Internetu, můžete si v knihovně TechNet Zobrazit online Help.

Aktualizace nápovědu pro moduly v $ domovském \ \ \ adresáři nebo modulech v jiných podadresářích $ domovského adresáře nevyžadují zvláštní oprávnění.

Rutiny Update-Help a Save-Help mají parametr UseDefaultCredentials, který poskytuje explicitní přihlašovací údaje aktuálního uživatele. Tento parametr je určený pro přístup k zabezpečeným internetovým umístěním.

Rutiny Update-Help a Save-Help mají také parametr přihlašovací údaje, který umožňuje spustit příkaz na vzdáleném počítači a přistupovat ke sdílené složce na třetím počítači. Parametr Credential je platný jenom v případě, že použijete parametry SourcePath nebo LiteralPath parametru Update-Help a parametry DestinationPath nebo LiteralPath v části Save-help.

POSTUP INSTALACE A AKTUALIZACE SOUBORŮ HELP

Chcete-li stáhnout a nainstalovat soubory aplikace Help poprvé nebo aktualizovat soubory aplikace Help v počítači, použijte rutinu Update-Help.

Rutina Update-Help provádí veškerou práci za vás, včetně následujících úkolů.

  • Určuje, které moduly podporují aktualizovatelnou pomoc.
  • Najde umístění v Internetu, kde každý modul ukládá své aktualizovatelné soubory help.
  • Porovná soubory s nápovědu pro každý modul v počítači s nejnovějšími soubory s nápovědu, které jsou k dispozici pro každý modul.
  • Stáhne nové soubory z Internetu.
  • Rozbalí balíček souboru Help.
  • Ověřuje, zda jsou soubory platnými soubory help.
  • Nainstaluje soubory s nápovědě do podadresáře pro konkrétní jazyk adresáře modulu.

Chcete-li získat přístup k novým tématům nápovědy, použijte rutinu Get-Help. Nemusíte restartovat PowerShell.

Chcete-li nainstalovat nebo aktualizovat nápovědu pro všechny moduly v počítači, který podporuje aktualizovatelnou nápovědu, zadejte:

Update-Help

Chcete-li aktualizovat nápovědu pro konkrétní moduly, přidejte parametr modulu Update-Help. V názvu modulu jsou povoleny zástupné znaky.

Chcete-li například aktualizovat nápovědu pro modul ServerManager, zadejte:

Update-Help -Module ServerManager

Bez parametrů aktualizují aktualizace-Help nápovědu pro všechny moduly v relaci a pro všechny nainstalované moduly, které podporují aktualizovatelnou nápovědu. Aby bylo možné je zahrnout, musí být moduly nainstalovány v adresářích, které jsou uvedeny v hodnotě proměnné prostředí PSModulePath. Jsou to také moduly, které jsou vráceny příkazem Get-Help-ListAvailable.

Pokud je hodnota parametru Module * (All), aktualizace-Help se pokusí aktualizovat nápovědu pro všechny nainstalované moduly, včetně modulů, které nepodporují aktualizovatelnou nápovědu. Tento příkaz obvykle generuje mnoho chyb, protože rutina zjistí moduly, které nepodporují aktualizovatelnou pomoc.

POSTUP AKTUALIZACE SADY HELP ZE SDÍLENÉ SLOŽKY: SAVE-HELP

K podpoře počítačů, které nejsou připojené k Internetu, nebo pro kontrolu a zjednodušení aktualizace v podniku, použijte rutinu Save-help. Rutina Save-Help stahuje soubory Help z Internetu a ukládá je do adresáře systému souborů, který zadáte.

Uložit – Help porovná soubory s podporou v zadaném adresáři s nejnovějšími soubory, které jsou k dispozici pro každý modul. Pokud pro modul nejsou k dispozici žádné soubory Help nebo novější soubory Help, rutina Save-Help stáhne nové soubory z Internetu. Ale neprovádí rozbalení nebo instalaci souborů s příponou help.

Chcete-li nainstalovat nebo aktualizovat soubory aplikace Help v počítači z souborů s podporou, které byly uloženy do adresáře systému souborů, použijte parametr zdrojová_cesta rutiny Update-Help. Rutina Update-Help identifikuje nejnovější soubory s podporou, rozbalí a ověří je a nainstaluje je do podadresáře pro konkrétní jazyk v adresářích modulu.

Pokud například chcete uložit nápovědu pro všechny nainstalované moduly do \ \ \ sdíleného adresáře serveru, zadejte:

Save-Help -DestinationPath \\Server\Share

Pak pokud chcete aktualizovat pomocníka v \ \ \ adresáři pro sdílení serveru, zadejte:

Update-Help -SourcePath \\Server\Share

Následující příklady ukazují použití možností Save-Help k uložení nápovědu pro moduly, které nejsou nainstalované na místním počítači. V tomto příkladu správce spustí příkaz Save-Help, aby uložil nápovědu modulu DhcpServer z klientského počítače připojeného k Internetu, aniž by bylo potřeba instalovat modul DhcpServer nebo roli serveru DHCP do místního počítače.

Možnost 1: Spusťte Invoke-Command pro získání objektu PSModuleInfo pro vzdálený modul, uložte ho do proměnné, $m a potom spusťte Save-Help u objektu PSModuleInfo zadáním proměnné $m jako názvu modulu.

$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath C:\SavedHelp

Možnost 2: Otevřete PSSession, který je zaměřený na počítač, na kterém je spuštěný modul DHCP Server. Pokud chcete získat objekt PSModuleInfo pro modul, uložte ho do proměnné $m a pak pro objekt, který je uložený v proměnné $m, spusťte Save-help.

$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Možnost 3: otevřete relaci CIM, která je zaměřená na počítač, na kterém je spuštěný modul DHCP Server, a získejte objekt PSModuleInfo pro modul, uložte ho do proměnné $m a pak pro objekt, který je uložený v $m proměnné, spusťte příkaz Save-help.

$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

V následujícím příkladu správce nainstaluje nápovědu pro modul DHCP Server na počítači, který nemá přístup k síti.

Nejdřív pomocí rutiny Export-CLIXML exportujte objekt PSModuleInfo do sdílené složky nebo na vyměnitelné médium.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbFlashDrive\DhcpModule.xml -InputObject $m

Dále přenese vyměnitelné médium do počítače, který má přístup k Internetu, a pak importujte objekt PSModuleInfo pomocí Import-CLIXML. Spuštěním Save-Help uložte nápovědu pro importovaný objekt PSModuleInfo modulu DhcpServer.

$deserialized_m = Import-Clixml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath `
E:\UsbFlashDrive\SavedHelp

Nakonec přenesete vyměnitelné médium zpátky na počítač, který nemá přístup k síti, a pak nainstalujte tuto podporu spuštěním příkazu Update-Help.

Update-Help -Module DhcpServer -SourcePath E:\UsbFlashDrive\SavedHelp

Bez parametrů příkaz Save-Help stáhne nápovědu pro všechny moduly v relaci a pro všechny nainstalované moduly, které podporují aktualizovatelnou nápovědu. Aby bylo možné je zahrnout, musí být moduly nainstalovány v adresářích, které jsou uvedeny v hodnotě proměnné prostředí PSModulePath, v místním počítači nebo ve vzdáleném počítači, pro který chcete uložit nápovědu. Jsou to také moduly, které jsou vráceny spuštěním příkazu Get-Help-ListAvailable.

POSTUP AKTUALIZACE SOUBORŮ APLIKACE HELP V RŮZNÝCH JAZYCÍCH

Ve výchozím nastavení stáhnou rutiny Update-Help a Save-Help nápovědu k jazykové verzi uživatelského rozhraní a jazyku nastavenému pro systém Windows v místním počítači. Pokud soubory s nápovědu pro zadané moduly nejsou k dispozici v místní jazykové verzi uživatelského rozhraní, aktualizujte-Help a Save-Help použijte pravidla pro základní jazyk pro Windows k nalezení nejlepšího podporovaného jazyka.

Můžete však použít parametry UICulture rutiny Update-Help a Save-Help ke stažení a instalaci souborů Help v libovolných jazykových verzích uživatelského rozhraní, ve kterých jsou k dispozici.

Pokud například chcete uložit nejnovější soubory s nápovědu pro všechny moduly v relaci v japonštině (Japonsko-JP) a francouzština (fr-FR), zadejte:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Pokud soubory pro tyto moduly nejsou k dispozici v jazycích, které jste zadali, rutiny Update-Help a Save-Help vrátí chybovou zprávu se seznamem jazyků, ve kterých je k dispozici nápovědu pro každý modul, abyste si mohli vybrat alternativu, která nejlépe vyhovuje vašim potřebám.

AUTOMATICKÉ AKTUALIZACE POMOCNÍKA

Chcete-li zajistit, že budete mít vždy k dispozici nejnovější soubory, můžete do svého profilu PowerShellu přidat příkaz Update-Help.

Interní kvóta zabrání spuštění příkazu aktualizace-Help v každém dni. Chcete-li přepsat maximum jednou za den, použijte parametr Force.

Ve vašem profilu použijte příkaz podobný následujícímu. Tento příkaz aktualizuje nápovědu pro všechny nainstalované moduly v úloze na pozadí, aby nenarušila vaši práci. Pomocí příkazu out-null potlačí vrácenou úlohu a všechny chybové zprávy, které by se jinak zobrazovaly při použití příkazu více než jednou denně.

Start-Job {Update-Help} | Out-Null

Můžete také vytvořit naplánovanou úlohu, která v libovolném intervalu spustí rutinu Update-Help nebo Save-help.

Například následující příkaz vytvoří naplánovanou úlohu, která spustí příkaz s nápovědu aktualizace – každý pátek v 5:00. Pokud chcete spustit tento příkaz, spusťte PowerShell pomocí možnosti Spustit jako správce.

Register-ScheduledJob -Name UpdateHelpJob -ScriptBlock {Update-Help} `
-Trigger (New-JobTrigger -Weekly -DaysOfWeek Friday -At "5:00 AM")

POUŽITÍ ONLINE NÁPOVĚDĚ

Pokud nemůžete nebo nechcete aktualizovat soubory Nápověda v místním počítači, můžete získat nejnovější soubory Nápověda online.

Chcete-li otevřít téma online nápovědy pro libovolnou rutinu nebo funkci, použijte parametr online rutiny Get-Help.

Následující příkaz například otevře téma online nápovědy pro rutinu Get-Job ve výchozím internetovém prohlížeči:

Get-Help Get-Job -Online

Chcete-li získat online nápovědu ke skriptu, použijte parametr online a úplnou cestu ke skriptu.

Parametr online nepracuje s tématy. Informace o tématech týkajících se prostředí PowerShell Core, včetně témat nápovědy o jazyce PowerShell, najdete v modulu PowerShell Core o tématech.

MINIMALIZACE NEBO PREVENCE STAHOVÁNÍ INTERNETOVÝCH SOUBORŮ

K minimalizaci stahování z Internetu a poskytnutí aktualizovatelné nápovědě uživatelům, kteří nejsou připojeni k Internetu, použijte rutinu Save-help. Stáhněte si pomocníka z Internetu a uložte ho do sdílené síťové složky. Pak vytvořte nastavení Zásady skupiny nebo naplánovanou úlohu, která spustí příkaz Update-Help na všech počítačích. Nastavte hodnotu parametru zdrojová_cesta rutiny Update-Help na sdílenou síťovou složku.

Chcete-li uživatelům, kteří mají přístup k Internetu, stahovat aktualizovatelnou nápovědu z Internetu, použijte nastavení Zásady skupiny nastavit výchozí cestu ke zdroji pro Update-Help.

Toto nastavení Zásady skupiny implicitně přidá parametr zdrojová_cesta s umístěním systému souborů, které zadáte, do každého příkazu Update-Help v každém dotčeném počítači. Uživatelé můžou parametr SourcePath použít explicitně k určení jiného umístění systému souborů, ale nemůžou vyloučit parametr zdrojová_cesta a stáhnout si z Internetu technickou podporu.

Poznámka: nastavení zásad skupiny nastavit výchozí cestu ke zdroji pro aktualizaci – nápovědu se zobrazí v části Konfigurace počítače a konfigurace uživatele. Nastavení zásad v části Konfigurace počítače je však účinné. Nastavení zásad v části Konfigurace uživatele se ignoruje.

Další informace najdete v tématu about_Group_Policy_Settings.

JAK AKTUALIZOVAT NÁPOVĚDU PRO NESTANDARDNÍ MODULY

Chcete-li aktualizovat nebo uložit nápovědu pro modul, který není vrácen parametrem ListAvailable rutiny Get-Module, importujte modul do aktuální relace před spuštěním příkazu Update-Help nebo Save-help. Na vzdáleném počítači před spuštěním příkazu Save-Help Importujte modul do současného bloku skriptu CIM nebo PSSession--nebo Invoke-Command-Command--, který je připojen ke vzdálenému počítači.

Když je modul v aktuální relaci, spusťte rutiny Update-Help nebo Save-Help bez parametrů nebo použijte parametr Module a zadejte název modulu.

Parametry modulu rutiny Update-Help a Save-Help přijímají pouze název modulu. Neakceptují cestu k souboru modulu.

Pomocí této techniky můžete aktualizovat nebo uložit nápovědu pro libovolný modul, který není vrácen parametrem ListAvailable rutiny Get-Module, jako je například modul nainstalovaný v umístění, které není uvedeno v proměnné prostředí PSModulePath, nebo modul, který není ve správném formátu (adresář modulu neobsahuje alespoň jeden soubor, jehož základní název je stejný jako název adresáře).

PODPORA AKTUALIZOVATELNÉ POMOCI

Pokud vytváříte modul, můžete podporovat online nápovědu a aktualizovatelné nápovědu pro vaše moduly. Další informace najdete v tématu "podpora aktualizovatelných pomoc" a Podpora online pomoc v Microsoft docs.

Aktualizovatelná aktualizace není k dispozici pro moduly snap-in prostředí PowerShell nebo nápovědu založenou na komentářích.

Mark

Rutiny Update-Help a Save-Help nejsou podporované v Windows Preinstallation Environment (Windows PE).

VIZ TAKÉ

Získat nápovědu

Uložit – Help

Aktualizace – Help