Get-Help

A PowerShell-parancsokkal és -fogalmakkal kapcsolatos információkat jeleníti meg.

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

A Get-Help parancsmag információkat jelenít meg a PowerShell-fogalmakról és -parancsokról, beleértve a parancsmagokat, függvényeket, common information model (CIM) parancsokat, munkafolyamatokat, szolgáltatókat, aliasokat és szkripteket.

Ha segítségre van szüksége egy PowerShell-parancsmaghoz, írja be Get-Help a parancsmag nevét, például: Get-Help Get-Process.

A PowerShell fogalmi súgócikkek about_, például about_Comparison_Operators. Az összes about_ cikk megtekintéséhez írja be a következőt Get-Help about_*: Egy adott cikk megtekintéséhez írja be Get-Help about_<article-name>Get-Help about_Comparison_Operatorspéldául a következőt:

A PowerShell-szolgáltatóval kapcsolatos segítségért írja be Get-Help a szolgáltató nevét. Ha például a tanúsítványszolgáltatóhoz szeretne segítséget kérni, írja be a következőt Get-Help Certificate: .

Beírhatja vagy manbeírhatja azt ishelp, amely egyszerre csak egy képernyőnyi szöveget jelenít meg. Vagy, <cmdlet-name> -?ez megegyezik Get-Helpa parancsmagokkal, de csak parancsmagok esetében működik.

Get-Help A lekéri a számítógép súgófájljaiból megjelenített súgótartalmat. A súgófájlok Get-Help nélkül csak a parancsmagokkal kapcsolatos alapvető információkat jeleníti meg. Egyes PowerShell-modulok súgófájlokat tartalmaznak. A PowerShell 3.0-tól kezdődően a Windows operációs rendszerhez készült modulok nem tartalmaznak súgófájlokat. A PowerShell 3.0-s verziójában található modul súgófájljainak letöltéséhez vagy frissítéséhez használja a Update-Help parancsmagot.

A PowerShell súgódokumentumait online is megtekintheti a Microsoft Docs. A súgófájl online verziójának lekéréséhez használja az Online paramétert, például: Get-Help Get-Process -Online. Az összes PowerShell-dokumentációt a Microsoft Docs PowerShell-dokumentációban olvashatja el.

Ha egy súgócikk pontos nevét vagy egy súgócikkre egyedi szót ír Get-Help be, Get-Help akkor a cikk tartalma jelenik meg. Ha megadja egy parancsalias pontos nevét, Get-Help megjeleníti az eredeti parancs súgóját. Ha olyan szó- vagy szómintát ad meg, amely több súgócikk címében is megjelenik, Get-Help megjeleníti az egyező címek listáját. Ha olyan szöveget ad meg, amely nem jelenik meg a súgócikkek címében, megjeleníti azoknak a cikkeknek a listáját, Get-Help amelyek tartalmazzák az adott szöveget a tartalmukban.

Get-Help A súgócikkeket tud lekérni az összes támogatott nyelvhez és területi beállításhoz. Get-Helpelőször a Windows területi beállításkészletében, majd a szülő területi beállításban (például pt-BR esetén pt), majd egy tartalék területi beállításban keresi a súgófájlokat. A PowerShell 3.0-tól kezdve, ha Get-Help nem talál segítséget a tartalék területi beállításban, angol nyelvű súgócikkeket keres, mielőtt hibaüzenetet ad vissza, vagy automatikusan létrehozott súgót jelenít meg.

A parancsszintaxis-diagramban megjelenő szimbólumokról Get-Help további információt a about_Command_Syntax című témakörben talál. A paraméterattribútumokról (például a Kötelező és a Pozíció) a about_Parameters című témakörben olvashat.

Megjegyzés

A PowerShell 3.0-ban és a PowerShell 4.0-ban nem találhatók a modulokban található About cikkek, Get-Help hacsak a modult nem importálja az aktuális munkamenetbe. Ez egy ismert probléma. A modulban található About cikkek beszerzéséhez importálja a modult a Import-Module parancsmag használatával vagy a modulban található parancsmag futtatásával.

Példák

1. példa: A parancsmagokkal kapcsolatos alapvető súgóinformációk megjelenítése

Ezek a példák a parancsmag alapvető súgóinformációit Format-Table jelenítik meg.

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

Get-Help <cmdlet-name> A a parancsmagok legegyszerűbb és alapértelmezett szintaxisa Get-Help . Kihagyhatja a Name paramétert.

A szintaxis <cmdlet-name> -? csak parancsmagok esetében működik.

2. példa: Alapvető információk megjelenítése egyszerre egy oldalon

Ezek a példák a parancsmag alapvető súgóinformációit Format-Table jelenítik meg egyszerre egy oldalon.

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

help A egy olyan függvény, amely belsőleg futtatja Get-Help a parancsmagot, és egyszerre egy oldalon jeleníti meg az eredményt.

man A a függvény aliasa help .

Get-Help Format-Table A a folyamaton lefelé küldi az objektumot. Out-Host -Paging A fogadja a kimenetet a folyamatból, és egyszerre csak egy oldalt jelenít meg. További információ: Házon kívül.

3. példa: Parancsmag további információinak megjelenítése

Ezek a példák részletesebb súgóinformációkat jelenítenek meg a Format-Table parancsmagról.

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

A Részletes paraméter megjeleníti a súgócikk részletes nézetét, amely paraméterek leírását és példákat tartalmaz.

A Teljes paraméter megjeleníti a súgócikk teljes nézetét, amely paraméterek leírását, példákat, bemeneti és kimeneti objektumtípusokat, valamint további megjegyzéseket tartalmaz.

A Részletes és a Teljes paraméterek csak azokra a parancsokra érvényesek, amelyeken telepítve vannak a számítógépre telepített súgófájlok. A paraméterek nem hatékonyak a fogalmi (about_) súgócikkekben.

4. példa: Parancsmag kijelölt részeinek megjelenítése paraméterek használatával

Ezek a példák a Format-Table parancsmag súgójának kijelölt részeit jelenítik meg.

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

A Példák paraméter megjeleníti a súgófájl NAME és SYNOPSIS szakaszait, valamint az összes példát. Nem adhat meg példaszámot, mert a Examples paraméter egy kapcsolóparaméter.

A Paraméter paraméter csak a megadott paraméterek leírását jeleníti meg. Ha csak a csillag (*) helyettesítő karaktert adja meg, az megjeleníti az összes paraméter leírását. Amikor a Paraméter paraméternevet ad meg, például a GroupBy, megjelenik az adott paraméterre vonatkozó információ.

Ezek a paraméterek nem hatékonyak a fogalmi (about_) súgócikkekben.

5. példa: A súgó online verziójának megjelenítése

Ez a példa a parancsmaghoz tartozó Format-Table súgócikk online verzióját jeleníti meg az alapértelmezett webböngészőben.

Get-Help Format-Table -Online

6. példa: Súgó megjelenítése a súgórendszerről

A Get-Help paraméterek nélküli parancsmag információkat jelenít meg a PowerShell súgórendszerről.

Get-Help

7. példa: Elérhető súgócikkek megjelenítése

Ez a példa a számítógépen elérhető összes súgócikk listáját jeleníti meg.

Get-Help *

8. példa: Fogalmi cikkek listájának megjelenítése

Ez a példa a PowerShell súgójában található fogalmi cikkek listáját jeleníti meg. Ezek a cikkek a about_ karakterekkel kezdődnek. Egy adott súgófájl megjelenítéséhez írja be Get-Help \<about_article-name\>például a Get-Help about_Signingkövetkezőt: .

Csak azok az elméleti cikkek jelennek meg, amelyeken telepítve vannak a számítógépre telepített súgófájlok. A súgófájlok PowerShell 3.0-s verzióban való letöltéséről és telepítéséről az Update-Help című témakörben olvashat bővebben.

Get-Help about_*

9. példa: Szó keresése a parancsmag súgójában

Ez a példa bemutatja, hogyan kereshet szavakat egy parancsmag súgócikkében.

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 uses the Full parameter to get help information for Add-Member. A MamlCommandHelpInfo objektum a folyamaton belül lesz elküldve. Out-String uses the Stream parameter to convert the object into a string. Select-String uses the Pattern parameter to search the string for Clixml.

10. példa: Szavakat tartalmazó cikkek listájának megjelenítése

Ebben a példában azoknak a cikkeknek a listája látható, amelyek tartalmazzák az átnevezés szót.

Ha olyan szót ír be, amely nem jelenik meg a cikk címében, Get-Help megjelenik az adott szót tartalmazó cikkek listája.

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

11. példa: Szolgáltatóspecifikus súgó megjelenítése

Ez a példa két módszert mutat be a szolgáltatóspecifikus súgó lekérésére.Get-Item Ezek a parancsok segítséget nyújtanak a Get-Item powershell-SQL Server szolgáltató DataCollection csomópontjának parancsmagjának használatához.

Az első példa a Path paramétert használja a Get-Help SQL Server szolgáltató elérési útjának megadásához. Mivel a szolgáltató elérési útja meg van adva, a parancsot bármilyen elérési út helyről futtathatja.

A második példa a SQL Server szolgáltató elérési útját használjaSet-Location. Erről a helyről a Path paraméterre nincs szükség a szolgáltatóspecifikus segítségkéréshez 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.
    ...

12. példa: Súgó megjelenítése szkripthez

Ez a példa segítséget kér a MyScript.ps1 script. A függvények és szkriptek súgójának megírásáról további információt a about_Comment_Based_Help című témakörben talál.

Get-Help -Name C:\PS-Test\MyScript.ps1

Paraméterek

-Category

Csak a megadott kategóriába tartozó elemek és aliasaik súgóját jeleníti meg. A fogalmi cikkek a Súgófájl kategóriába tartoznak.

A paraméter elfogadható értékei a következők:

  • Alias
  • Parancsmag
  • Szolgáltató
  • Általános kérdések
  • GYIK
  • Szószedet
  • Súgófájl
  • ScriptCommand
  • Függvény
  • Szűrő
  • ExternalScript
  • Mind
  • DefaultHelp
  • Munkafolyamat
  • DscResource
  • Osztály
  • Konfiguráció
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

A megadott összetevőértékkel (például Exchange) rendelkező parancsokat jeleníti meg. Adja meg az összetevő nevét. Helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Detailed

Paraméterleírásokat és példákat ad hozzá az alapszintű súgó megjelenítéséhez. Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépre. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Examples

Csak a nevet, a szinopszist és a példákat jeleníti meg. Ha csak a példákat szeretné megjeleníteni, írja be a következőt (Get-Help \<cmdlet-name\>).Examples:

Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépre. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Full

Megjeleníti egy parancsmag teljes súgócikkét. Teljes körűen tartalmaz paraméterleírásokat és attribútumokat, példákat, bemeneti és kimeneti objektumtípusokat, valamint további megjegyzéseket.

Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépre. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Functionality

A megadott funkcióval rendelkező elemek súgóját jeleníti meg. Adja meg a funkciót. Helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Name

Segítséget kér a megadott parancsról vagy fogalomról. Adja meg egy parancsmag, függvény, szolgáltató, szkript vagy munkafolyamat nevét, például Get-Memberegy fogalmi cikk nevét, például about_Objects: , vagy aliast, például ls. A parancsmagok és a szolgáltatónevek helyettesítő karaktereket tartalmazhatnak, helyettesítő karaktereket azonban nem használhat a függvény súgójának és a szkript súgócikkeinek nevének megkereséséhez.

Ha olyan parancsfájlhoz szeretne segítséget kérni, amely nem a $env:Path környezeti változóban felsorolt elérési úton található, írja be a szkript elérési útját és fájlnevét.

Ha megadja egy súgócikk pontos nevét, Get-Help megjeleníti a cikk tartalmát.

Ha olyan szó- vagy szómintát ad meg, amely több súgócikk címében is megjelenik, Get-Help megjeleníti az egyező címek listáját.

Ha olyan szöveget ad meg, amely nem egyezik meg a súgócikk címével, megjeleníti azoknak a cikkeknek a listáját, Get-Help amelyek tartalmazzák az adott szöveget a tartalmukban.

A fogalmi cikkek nevét, például about_Objectsa PowerShell nem angol nyelvű verzióiban is angolul kell megadni.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:True

-Online

Megjeleníti egy súgócikk online verzióját az alapértelmezett böngészőben. Ez a paraméter csak parancsmagok, függvények, munkafolyamatok és parancsfájlok súgócikkeihez érvényes. Távoli munkamenetben nem használhatja az Online paramétert Get-Help .

A funkciónak az ön által írt súgócikkekben való támogatásáról további információt a about_Comment_Based_Help és az Online súgó támogatása, valamint a PowerShell-parancsmagok súgójának írása című témakörben talál.

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

-Parameter

Csak a megadott paraméterek részletes leírását jeleníti meg. Helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

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

-Path

Segítséget kér, amely elmagyarázza, hogyan működik a parancsmag a megadott szolgáltatói útvonalon. Adjon meg egy PowerShell-szolgáltató elérési útját.

Ez a paraméter egy parancsmag súgócikkének egy testreszabott verzióját kapja meg, amely elmagyarázza, hogyan működik a parancsmag a megadott PowerShell-szolgáltató elérési útján. Ez a paraméter csak a szolgáltatói parancsmagokkal kapcsolatos segítségért használható, és csak akkor, ha a szolgáltató a szolgáltatói parancsmag súgócikkének egyéni verzióját tartalmazza a súgófájlban. A paraméter használatához telepítse a szolgáltatót tartalmazó modul súgófájlját.

Ha meg szeretné tekinteni a szolgáltatói elérési út egyéni parancsmagjának Get-Help súgóját, lépjen a szolgáltató elérési útjának helyére, és adjon meg egy Get-Help parancsot, vagy bármely elérési út helyéről a szolgáltató elérési útjának megadásához használja az Elérési út paramétert. Az egyéni parancsmagok online súgóját a súgócikkek szolgáltatói súgó szakaszában is megtalálhatja.

További információ a PowerShell-szolgáltatókról: about_Providers.

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

-Role

A megadott felhasználói szerepkörhöz testre szabott súgó megjelenítése. Adjon meg egy szerepkört. Helyettesítő karakterek használata engedélyezett.

Adja meg azt a szerepkört, amelyet a felhasználó játszik egy szervezetben. Egyes parancsmagok a paraméter értéke alapján különböző szöveget jelenítenek meg a súgófájljaikban. Ez a paraméter nincs hatással a fő parancsmagok súgójára.

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

-ShowWindow

A könnyebb olvashatóság érdekében megjeleníti a súgótémakört egy ablakban. Az ablak tartalmaz egy Keresés keresési funkciót és egy Beállítások mezőt, amely lehetővé teszi a megjelenítési beállítások megadását, beleértve a súgótémakör kijelölt szakaszainak megjelenítését is.

A ShowWindow paraméter támogatja a parancsok (parancsmagok, függvények, CIM-parancsok, szkriptek) súgótémaköröket és a cikkekről szóló fogalmi témaköröket . Nem támogatja a szolgáltatói segítséget.

Ezt a paramétert újra bevezették a PowerShell 7.0-ban.

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

Bevitelek

None

Nem küldhet objektumokat a folyamaton Get-Helplefelé.

Kimenetek

ExtendedCmdletHelpInfo

Ha olyan parancson futGet-Help, amely nem rendelkezik súgófájllal, egy ExtendedCmdletHelpInfo objektumot ad vissza, Get-Help amely az automatikusan létrehozott súgót jelöli.

String

Ha egy fogalmi súgócikket kap, Get-Help sztringként adja vissza.

MamlCommandHelpInfo

Ha egy súgófájllal rendelkező parancsot kap, Get-Help egy MamlCommandHelpInfo objektumot ad vissza.

Jegyzetek

A PowerShell 3.0 nem tartalmaz súgófájlokat. Az olvasható súgófájlok Get-Help letöltéséhez és telepítéséhez használja a Update-Help parancsmagot. A Update-Help parancsmaggal letöltheti és telepítheti a PowerShell alapvető parancsaihoz és a telepített modulokhoz tartozó súgófájlokat. Azt is használhatja, hogy frissítse a súgófájlokat, hogy a számítógép súgója soha ne legyen elavult.

A PowerShell online elérhető parancsairól szóló súgócikkeket is elolvashatja a Windows PowerShell Első lépések kezdve.

Get-Help A a Windows operációs rendszer területi beállításkészletében vagy az adott területi beállításhoz tartozó tartalék nyelven jeleníti meg a súgót. Ha nem rendelkezik súgófájlokkal az elsődleges vagy tartalék területi beállításhoz, úgy viselkedik, Get-Help mintha nincsenek súgófájlok a számítógépen. Ha segítségre van szüksége egy másik területi beállításhoz, a beállítások módosításához használja a Régió és nyelv lehetőséget Vezérlőpult. Windows 10 vagy újabb beállítások,időnyelv&.

A súgó teljes nézete tartalmazza a paraméterekkel kapcsolatos információkat tartalmazó táblázatot. A táblázat a következő mezőket tartalmazza:

  • Kötelező megadni. Azt jelzi, hogy a paraméter kötelező-e (igaz) vagy nem kötelező (hamis).

  • Pozíció. Azt jelzi, hogy a paraméter neve vagy pozíciója (numerikus). A pozicionálási paramétereknek a parancs egy megadott helyén kell megjelennie.

  • A név azt jelzi, hogy a paraméter neve kötelező, de a paraméter bárhol megjelenhet a parancsban.

  • A numerikus érték azt jelzi, hogy a paraméter neve nem kötelező, de ha a nevet nem adja meg, a paraméternek a szám által megadott helyen kell lennie. Például azt jelzi, 2 hogy a paraméternév kihagyásakor a paraméternek a parancs második vagy csak névtelen paraméterének kell lennie. A paraméternév használatakor a paraméter bárhol megjelenhet a parancsban.

  • Alapértelmezett érték. A PowerShell által használt paraméterérték vagy alapértelmezett viselkedés, ha nem adja meg a paramétert a parancsban.

  • Folyamatbemenet elfogadása. Azt jelzi, hogy küldhet-e (igaz) vagy nem (hamis) objektumokat a paraméternek egy folyamaton keresztül. A tulajdonságnév azt jelenti, hogy a folyamathoz tartozó objektumnak olyan tulajdonságmal kell rendelkeznie, amelynek neve megegyezik a paraméter nevével.

  • Helyettesítő karaktereket fogad el. Azt jelzi, hogy egy paraméter értéke tartalmazhat-e helyettesítő karaktereket, például csillagot (*) vagy kérdőjelet (?).