Megosztás a következőn keresztül:

frissíthető_súgóról

Rövid leírás

A PowerShell frissíthető súgórendszerét ismerteti.

Hosszú leírás

A PowerShell számos különböző módszert kínál a PowerShell-parancsmagok és -fogalmak up-to-date súgótémaköreinek eléréséhez.

A PowerShell 3.0-ban bevezetett Frissíthető súgórendszert úgy tervezték, hogy biztosítsa, hogy mindig a legújabb súgótémakörök legyenek a helyi számítógépen, így a parancssorban olvashatja őket. Így egyszerűen letöltheti és telepítheti a súgófájlokat, és frissítheti őket, amikor újabb súgófájlok válnak elérhetővé.

Ha egy vállalat több számítógépéhez és az internethez nem hozzáférő számítógépekhez szeretne frissített segítséget nyújtani, az Frissíthető súgó segítségével letöltheti a súgófájlokat egy fájlrendszerkönyvtárba vagy fájlmegosztásba, majd telepítheti a súgófájlokat a fájlmegosztásból.

A PowerShell 4.0-ban a HelpInfoUri tulajdonság windowsos PowerShell-újratelepítéssel marad meg, amely lehetővé teszi, hogy Save-Help a távoli számítógépre telepített, de nem feltétlenül a helyi számítógépre telepített modulokhoz működjenek. Egy PSModuleInfo objektumot lemezre vagy cserélhető adathordozóra (például USB-meghajtóra) menthet, ha Export-Clixml futtat egy olyan számítógépen, amely nem rendelkezik internet-hozzáféréssel, importálja a PSModuleInfo objektumot egy olyan számítógépen, amely rendelkezik internetkapcsolattal, majd Save-Help futtat a PSModuleInfo objektumon. A mentett súgó cserélhető adathordozóval másolható a távoli, leválasztott számítógépre, majd a Update-Helpfuttatásával telepíthető. A Save-Help funkcióinak fejlesztései lehetővé teszik, hogy olyan számítógépekre telepítsen segítséget, amelyekhez nincs hálózati hozzáférése. Az új Save-Help funkció használatára vonatkozó példa: lásd az ebben a témakörben található Súgó frissítése fájlmegosztásból szakaszt.

Az frissíthető súgó emellett támogatja a legújabb súgótémakörök és a parancsmagok alapszintű súgójának online elérését is, még akkor is, ha nincsenek súgófájlok a számítógépen.

A PowerShell nem tartalmaz súgófájlokat. Az Frissíthető súgó funkcióval telepítheti a PowerShellben és az összes Windows-modulban alapértelmezés szerint megtalálható összes parancs súgófájljait.

Frissíthető súgóparancsmagok

  • Update-Help: Letölti a legújabb súgófájlokat az internetről vagy egy fájlmegosztásból, és telepíti őket a helyi számítógépre.

  • Save-Help: Letölti a legújabb súgófájlokat az internetről, és egy fájlrendszerkönyvtárba vagy fájlmegosztásba menti őket. A súgófájlok számítógépekre történő telepítéséhez használja a Update-Help.

  • Get-Help: Súgótémakörök megjelenítése a parancssorban. Segítséget kér a számítógépen található súgófájloktól. Automatikusan létrehozott súgó megjelenítése olyan parancsmagokhoz és függvényekhez, amelyek nem rendelkeznek súgófájlokkal. Megnyitja a parancsmagok, függvények, szkriptek és munkafolyamatok online súgótémaköreit az alapértelmezett internetböngészőben.

Automatikusan létrehozott súgó: Súgó súgófájlok nélkül

Ha nem rendelkezik a számítógépen található parancsmaghoz, függvényhez vagy munkafolyamathoz tartozó súgófájllal, a Get-Help parancsmag automatikusan létrehozott súgót jelenít meg, és kéri, hogy töltse le a súgófájlokat, vagy olvassa el őket online.

Az automatikusan létrehozott súgó szintaxisokat és aliasokat, valamint megjegyzéseket tartalmaz, amelyek ismertetik az Frissíthető súgó parancsmagok használatát és az online súgótémakörök elérését.

Az alábbi parancs például alapvető segítséget kap a Get-Culture parancsmaghoz. A kijelző Get-Help jelenik meg, ha a számítógépen nincsenek súgófájlok.

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.

Modulok súgófájljai

Az Frissíthető súgó legkisebb egysége egy modul súgója. A modul súgója segítséget nyújt a modulban található parancsmagokhoz, függvényekhez, munkafolyamatokhoz, szolgáltatókhoz, szkriptekhez és fogalmakhoz. A számítógépre telepített összes modul súgóját frissítheti, még akkor is, ha azokat nem importálja az aktuális munkamenetbe.

A teljes modul súgóját frissítheti, de nem frissítheti az egyes parancsmagok súgóját.

Az adott parancsmagot tartalmazó modul megkereséséhez használja a következő parancsformátumot:

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

Ha például meg szeretné keresni a Set-ExecutionPolicy parancsmagot tartalmazó modult, írja be a következőt:

(Get-Command Set-ExecutionPolicy).ModuleName

Egy adott modul súgójának frissítéséhez írja be a következőt:

Update-Help -Module <ModuleName>

Ha például frissíteni szeretné a Set-ExecutionPolicy parancsmagot tartalmazó modul súgóját, írja be a következőt:

Update-Help -Module Microsoft.PowerShell.Security

Frissíthető súgó engedélyei

A $PSHOME/Moduleskönyvtár moduljainak súgójának frissítéséhez a számítógépen a Rendszergazdák csoport tagjának kell lennie.

Ha nem tagja a Rendszergazdák csoportnak, nem frissítheti a modulok súgóját; de ha rendelkezik internet-hozzáféréssel, online is megtekintheti a súgót.

A címtár $HOME/Documents/PowerShell/Modules vagy a $HOME könyvtár más alkönyvtáraiban található modulok súgójának frissítése nem igényel különleges engedélyeket.

A Update-Help és Save-Help parancsmagok UseDefaultCredentials paraméterrel rendelkeznek, amely az aktuális felhasználó explicit hitelesítő adatait biztosítja. Ez a paraméter biztonságos internetes helyek elérésére lett tervezve.

A Update-Help és Save-Help parancsmagok is rendelkeznek egy Hitelesítő adatok paraméterrel, amely lehetővé teszi a parancs távoli számítógépen való futtatását és egy fájlmegosztás elérését egy harmadik számítógépen. A Hitelesítő adatok paraméter csak akkor érvényes, ha a SourcePath vagy Update-Help paraméterét, valamint DestinationPath vagy LiteralPath paraméterét használja Save-Help.

Súgófájlok telepítése és frissítése

A súgófájlok első letöltéséhez és telepítéséhez, illetve a számítógépen lévő súgófájlok frissítéséhez használja a Update-Help parancsmagot.

A Update-Help parancsmag minden munkát elvégez, beleértve az alábbi feladatokat is.

  • Meghatározza, hogy mely modulok támogatják az frissíthető súgót.
  • Megkeresi azt az internetes helyet, ahol az egyes modulok tárolják az frissíthető súgófájlokat.
  • Összehasonlítja a számítógép minden moduljának súgófájljait az egyes modulokhoz elérhető legújabb súgófájlokkal.
  • Letölti az új fájlokat az internetről.
  • Bontsa ki a súgófájl-csomagot.
  • Ellenőrzi, hogy a fájlok érvényes súgófájlok-e.
  • Telepíti a súgófájlokat a modulkönyvtár nyelvspecifikus alkönyvtárába.

Az új súgótémakörök eléréséhez használja a Get-Help parancsmagot. Nem kell újraindítania a PowerShellt.

Az frissíthető súgót támogató összes modul súgójának telepítéséhez vagy frissítéséhez írja be a következőt:

Update-Help

Az egyes modulok súgójának frissítéséhez adja hozzá a modul paraméterét Update-Help. A modul nevében helyettesítő karakterek használhatók.

A ServerManager modul súgójának frissítéséhez például írja be a következőt:

Update-Help -Module ServerManager

Paraméterek nélkül a Update-Help frissíti a súgót a munkamenet összes moduljához, valamint minden telepített modulhoz, amely támogatja a frissíthető súgót. Ahhoz, hogy a modulok bekerüljenek, telepíteni kell őket a PSModulePath környezeti változó értékében felsorolt könyvtárakba. Ezek olyan modulok is, amelyeket egy Get-Module -ListAvailable parancs ad vissza.

Ha a modul paraméter értéke * (mind), Update-Help megpróbálja frissíteni az összes telepített modul súgóját, beleértve azokat a modulokat is, amelyek nem támogatják az frissíthető súgót. Ez a parancs általában sok hibát okoz, mivel a parancsmag olyan modulokkal találkozik, amelyek nem támogatják az frissíthető súgót.

Súgó frissítése fájlmegosztásból

Az internetkapcsolattal nem rendelkező számítógépek támogatásához, illetve a vállalati frissítés szabályozásához vagy egyszerűsítéséhez használja a Save-Help parancsmagot. A Save-Help parancsmag letölti a súgófájlokat az internetről, és egy ön által megadott fájlrendszerkönyvtárba menti őket.

Save-Help összehasonlítja a megadott könyvtárban található súgófájlokat az egyes modulokhoz elérhető legújabb súgófájlokkal. Ha a címtárban nincsenek súgófájlok vagy újabb súgófájlok érhetők el a modulhoz, a Save-Help parancsmag letölti az új fájlokat az internetről. A súgófájlokat azonban nem bontja ki vagy telepíti.

Ha a számítógépen lévő súgófájlokat fájlrendszerkönyvtárba mentett súgófájlokból szeretné telepíteni vagy frissíteni, használja a parancsmag Update-Help paraméterét. A Update-Help parancsmag azonosítja a legújabb súgófájlokat, feloldja és ellenőrzi őket, és telepíti őket a modulkönyvtárak nyelvspecifikus alkönyvtáraiban.

Ha például az összes telepített modul súgóját a \\Server\Share könyvtárba szeretné menteni, írja be a következőt:

Save-Help -DestinationPath \\Server\Share

Ezután a \\Server\Share könyvtár súgójának frissítéséhez írja be a következőt:

Update-Help -SourcePath \\Server\Share

Az alábbi példák azt mutatják be, hogy a Save-Help segítségével mentheti a helyi számítógépen nem telepített modulok súgóját. Ebben a példában a rendszergazda Save-Help futtatva menti a DhcpServer modul súgóját egy internethez csatlakoztatott ügyfélszámítógépről anélkül, hogy a DhcpServer modult vagy a DHCP-kiszolgálói szerepkört a helyi számítógépen telepíti.

1. lehetőség: Futtassa a Invoke-Command a távoli modul PSModuleInfo objektumának lekéréséhez, mentse egy változóba, $m, majd futtassa a Save-Help a PSModuleInfo objektumon a modul neveként megadott $m változó megadásával.

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

2. lehetőség: Nyisson meg egy PSSessiont a DHCP-kiszolgáló modult futtató számítógépen, hogy lekérje a PSModuleInfo objektumot a modulhoz, mentse egy változóba $m, majd futtassa Save-Help a $m változóban mentett objektumon.

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

3. lehetőség: Nyisson meg egy CIM-munkamenetet a DHCP-kiszolgáló modult futtató számítógépen, hogy lekérje a PSModuleInfo objektumot a modulhoz, mentse egy változóba $m, majd futtassa a Save-Help a $m változóban mentett objektumon.

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

Az alábbi példában a rendszergazda telepíti a DHCP-kiszolgáló modul súgóját egy olyan számítógépre, amely nem rendelkezik hálózati hozzáféréssel.

Először futtassa a Export-Clixml a PSModuleInfo objektum exportálásához egy megosztott mappába vagy cserélhető adathordozóra.

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

Ezután vigye a cserélhető adathordozót egy internetkapcsolattal rendelkező számítógépre, majd importálja a PSModuleInfo objektumot Import-Clixml. Futtassa a(z) Save-Help-t az importált DhcpServer modul súgójának mentéséhez a(z) PSModuleInfo objektumba.

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

Végül helyezze vissza a cserélhető adathordozót a hálózati hozzáféréssel nem rendelkező számítógépre, majd telepítse a súgót a Update-Helpfuttatásával.

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

Paraméterek nélkül Save-Help letölti a munkamenet összes moduljának és az frissíthető súgót támogató összes telepített modulnak a súgóját. A modulokat a $Env:PSModulePath környezeti változó értékében felsorolt könyvtárakba kell telepíteni a helyi számítógépen vagy egy távoli számítógépen, amelyhez menteni szeretné a súgót. Ezek olyan modulok is, amelyeket egy Get-Help -ListAvailable parancs futtatásával adnak vissza.

Súgófájlok frissítése különböző nyelveken

Alapértelmezés szerint a Update-Help és Save-Help parancsmagok a helyi számítógépen a Windowshoz beállított felhasználói felületi kultúrában és nyelven töltik le a súgót. Ha a megadott modulok súgófájljai nem érhetők el a helyi felhasználói felületi kultúrában, Update-Help és Save-Help a Windows nyelvi tartalék szabályaival keresse meg a legjobban támogatott nyelvet.

Azonban a és Update-Help parancsmagok Save-Help paramétereit használva letöltheti és telepítheti a súgófájlokat minden olyan felhasználói felületi kultúrában, amelyben elérhetők.

Ha például japán (ja-JP) és francia (fr-FR) nyelven szeretné menteni a munkamenet összes moduljának legújabb súgófájljait, írja be a következőt:

Save-Help -Path \Server\Share -UICulture ja-JP, fr-FR

Ha a modulok súgófájljai nem érhetők el a megadott nyelveken, a Update-Help és Save-Help parancsmagok hibaüzenetet adnak vissza, amely felsorolja azokat a nyelveket, amelyekben az egyes modulok súgója elérhető, így kiválaszthatja az igényeinek leginkább megfelelő alternatívát.

Jegyzet

Jelenleg a frissíthető súgótartalmak csak angol nyelven (en-US) jelennek meg.

Online súgó használata

Ha nem tudja vagy nem tudja frissíteni a helyi számítógépen található súgófájlokat, akkor is online állapotba helyezheti a legújabb súgófájlokat.

A parancsmagok vagy függvények online súgótémakörének megnyitásához használja a parancsmag Get-Help paraméterét.

Az alábbi parancs például megnyitja a Get-Job parancsmag online súgótémakörét az alapértelmezett webböngészőben:

Get-Help Get-Job -Online

Ha online segítséget szeretne kapni egy szkripthez, használja az Online paramétert és a szkript teljes elérési útját.

Az Online paraméter nem működik az információs témakörökkel. A PowerShell témaköreiről, beleértve a PowerShell nyelvével kapcsolatos súgótémaköröket is, tekintse meg PowerShell Témakörökcímű témakört.

Az internetes letöltések minimalizálása vagy megakadályozása

Az internetes letöltések minimalizálása és az internethez nem csatlakozó felhasználók számára elérhető súgó biztosítása érdekében használja a Save-Help parancsmagot. Töltse le a súgót az internetről, és mentse egy hálózati megosztásba. Ezután hozzon létre egy csoportházirend-beállítást vagy ütemezett feladatot, amely Update-Help parancsot futtat az összes számítógépen. Állítsa be a parancsmag Update-Help paraméterének értékét a hálózati megosztásra.

Ha meg szeretné akadályozni, hogy az internethez hozzáférő felhasználók letöltsék a Frissíthető súgót az internetről, használja a Az Update-Help csoportházirend-beállítást az alapértelmezett forrásútvonal beállításához.

Ez a csoportházirend-beállítás implicit módon hozzáadja a SourcePath paramétert a megadott fájlrendszeri helyhez minden érintett számítógépen található Update-Help parancshoz. A felhasználók explicit módon használhatják a SourcePath paramétert, de nem zárhatják ki a SourcePath paramétert, és nem tölthetnek le súgót az internetről.

Jegyzet

A Az Update-Help csoportházirend-beállítás alapértelmezett forrásútvonalának beállítása Számítógép konfigurációs és Felhasználói konfigurációterületen jelenik meg. Azonban csak a számítógép konfigurációs alatti házirend-beállítás érvényes. A rendszer figyelmen kívül hagyja felhasználói konfigurációs alatti házirend-beállítást.

Ha további információra van szüksége, lásd: about_Group_Policy_Settings.

Nem szabványos modulok súgójának frissítése

A parancsmag Get-Module paramétere által nem visszaadott modul súgójának frissítéséhez vagy mentéséhez importálja a modult az aktuális munkamenetbe, mielőtt egy Update-Help vagy Save-Help parancsot futtat. Távoli számítógépen a Save-Help parancs futtatása előtt importálja a modult a távoli számítógéphez csatlakoztatott aktuális munkamenetbe vagy Invoke-Command szkriptblokkba.

Amikor a modul az aktuális munkamenetben van, futtassa a Update-Help vagy Save-Help parancsmagokat paraméterek nélkül, vagy használja a Modul paramétert a modul nevének megadásához.

A modul paraméterei és Update-HelpSave-Help parancsmagok csak egy modulnevet fogadnak el. Nem fogadják el a modulfájl elérési útját.

Ezzel a technikával frissíthet vagy menthet súgót az parancsmag Get-Module paramétere által nem visszaadott modulokhoz, például egy olyan modulhoz, amely a $Env:PSModulePath környezeti változóban nem szereplő helyen van telepítve, vagy egy nem megfelelően formázott modulhoz (a modulkönyvtár nem tartalmaz legalább egy olyan fájlt, amelynek alapneve megegyezik a címtár nevével).

Frissíthető súgó támogatása

Ha modult készít, az online súgót és az frissíthető súgót is támogathatja a modulokhoz. További információt a Frissíthető súgó támogatása és a Online súgó támogatásarészekben talál.

Frissíthető súgó nem érhető el PowerShell-beépülő modulokhoz vagy megjegyzésalapú súgókhoz.

Megjegyzések

A Update-Help és Save-Help parancsmagok nem támogatottak a Windows előtelepítési környezetében (Windows PE).

Lásd még

  • Last updated on