Gedetailleerde Help-informatie verkrijgenGetting Detailed Help Information

Windows PowerShell bevat gedetailleerde Help-onderwerpen waarin wordt uitgelegd concepten voor Windows PowerShell en de Windows PowerShell-taal.Windows PowerShell includes detailed Help topics that explain Windows PowerShell concepts and the Windows PowerShell language. Er zijn ook Help-onderwerpen voor elke cmdlet en de provider en Help-onderwerpen voor veel functies en scripts.There are also Help topics for each cmdlet and provider and Help topics for many functions and scripts.

U kunt de meest recente versies van de volgende onderwerpen in de Microsoft TechNet Library weergeven of deze Help-onderwerpen bij de opdrachtprompt weer.You can display these Help topics at the command prompt or view the most recently updated versions of these topics in the Microsoft TechNet Library. Veel programma's die als host fungeren van Windows PowerShell, zoals Windows PowerShell Integrated Scripting Environment, bieden extra hulp-functies, zoals contextgevoelige Help en gecompileerde Help-bestand (.chm).Many programs that host Windows PowerShell, such as Windows PowerShell Integrated Scripting Environment, provide additional Help features, such as context-sensitive Help and compiled Help file (.chm).

Help bij Cmdlets voor ophalenGetting Help for Cmdlets

Als u Help-informatie over Windows PowerShell-cmdlets, gebruikt de Get-Help [m2] cmdlet.To get Help about Windows PowerShell cmdlets, use the Get-Help [m2] cmdlet. Als u bijvoorbeeld ondersteuning voor de Get-ChildItem [m2] cmdlet, type:For example, to get Help for the Get-ChildItem [m2] cmdlet, type:

get-help get-childitem

ofor

get-childitem -?

U kunt zelfs Help-informatie ophalen over de cmdlet Get-Help.You can even get Help about the Get-Help cmdlet. Bijvoorbeeld:For example:

get-help get-help

Als u een lijst met de cmdlet Help-onderwerpen in uw sessie, typt u:To get a list of all the cmdlet Help topics in your session, type:

get-help -category cmdlet

Gebruiken om een pagina te openen van elke Help-onderwerp op een tijdstip, de help functie of de alias man.To display one page of each Help topic at a time, use the help function or its alias man. Typ bijvoorbeeld als Help wilt weergeven voor de cmdlet Get-ChildItem,For example, to display Help for the Get-ChildItem cmdlet, type

man get-childitem

ofor

help get-childitem

Gedetailleerde informatie over een cmdlet, een functie of een script, met inbegrip van beschrijvingen van de parameters en voorbeelden van het gebruik ervan, gebruiken de gedetailleerd parameter van de cmdlet Get-Help.To display detailed information about a cmdlet, function, or script, including descriptions of its parameters and examples of its use, use the Detailed parameter of the Get-Help cmdlet. Bijvoorbeeld, als u gedetailleerde informatie over de cmdlet Get-ChildItem, typt u:For example, to get detailed information about the Get-ChildItem cmdlet, type:

get-help get-childitem -detailed

U kunt alle inhoud weergeven in het Help-onderwerp gebruiken de volledige parameter van de cmdlet Get-Help.To display all content in the Help topic, use the Full parameter of the Get-Help cmdlet. Bijvoorbeeld, als u wilt weergeven van alle inhoud in de Help-onderwerp voor de cmdlet Get-ChildItem, typt u:For example, to display all content in the Help topic for the Get-ChildItem cmdlet, type:

get-help get-childitem -full

Gedetailleerde ophalen Help-informatie over de parameters van een cmdlet, gebruik de Parameter parameter van de cmdlet Get-Help.To get detailed Help about the parameters of a cmdlet, use the Parameter parameter of the Get-Help cmdlet. Bijvoorbeeld, om op te halen gedetailleerde Help voor alle parameters van de cmdlet Get-ChildItem, type:For example, to get detailed Help for all of the parameters of the Get-ChildItem cmdlet, type:

get-help get-childitem -parameter *

Gebruikt u alleen de voorbeelden in een Help-onderwerp weergeven door de voorbeeld parameter van de Get-Help.To display only the examples in a Help topic, use the Example parameter of the Get-Help. Typ bijvoorbeeld het volgende zodat alleen de voorbeelden in het Help-onderwerp voor de cmdlet Get-ChildItem:For example, to display only the examples in the Help topic for the Get-ChildItem cmdlet, type:

get-help get-childitem -examples

Zie voor meer informatie over het schrijven van Help-onderwerpen voor de cmdlets die u schrijft schrijven Cmdlet helpen in de MSDN-bibliotheek.For information about how to write Help topics for the cmdlets that you write, see How to Write Cmdlet Help in the MSDN library.

Conceptuele Help opvragenGetting Conceptual Help

De cmdlet Get-Help bevat ook informatie over conceptuele onderwerpen in Windows PowerShell, met inbegrip van onderwerpen over de Windows PowerShell-taal.The Get-Help cmdlet also displays information about conceptual topics in Windows PowerShell, including topics about the Windows PowerShell language. Conceptuele Help-onderwerpen beginnen met het voorvoegsel 'about_', zoals about_line_editing.Conceptual Help topics begin with the "about_" prefix, such as about_line_editing. (De naam van het conceptuele onderwerp moet worden ingevoerd in het Engels zelfs op niet-Engelse versies van Windows PowerShell.)(The name of the conceptual topic must be entered in English even on non-English versions of Windows PowerShell.)

Als een lijst met algemene onderwerpen weergeven, typt u:To display a list of conceptual topics, type:

get-help about_*

Als u wilt een bepaalde Help-onderwerp weergeven, typt u bijvoorbeeld de naam van het onderwerp:To display a particular Help topic, type the topic name, for example:

get-help about_command_syntax

De parameters van Get-Help, zoals gedetailleerd, Parameter, en voorbeelden, hebben geen effect op de weergave van de conceptuele Help-onderwerpen.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of conceptual Help topics.

Help-informatie over ProvidersGetting Help About Providers

De cmdlet Get-Help bevat informatie over Windows PowerShell-providers.The Get-Help cmdlet displays information about Windows PowerShell providers. Als u de Help voor een provider, typ 'Get-Help"gevolgd door de naam van de provider.To get Help for a provider, type "Get-Help" followed by the provider name. Bijvoorbeeld, als u de Help voor de Register-provider, typt u:For example, to get Help for the Registry provider, type:

get-help registry

Als u een lijst van alle provider Help-onderwerpen in uw sessie, typt u het volgende:To get a list of all the provider Help topics in your session, type

get-help -category provider

De parameters van Get-Help, zoals gedetailleerd, Parameter, en voorbeelden, hebben geen effect op de weergave van de provider Help-onderwerpen.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of provider Help topics.

Help opvragen over Scripts en functiesGetting Help About Scripts and Functions

Veel scripts en functies in Windows PowerShell beschikken over de Help-onderwerpen.Many scripts and functions in Windows PowerShell have Help topics. Gebruik de cmdlet Get-Help om Help-onderwerpen voor scripts en functies weer te geven.Use the Get-Help cmdlet to display the Help topics for scripts and functions.

Als u de Help voor een functie, typt u 'get-help"gevolgd door de naam van de functie.To display the Help for a function, type "get-help" followed by the function name. Bijvoorbeeld, als u de Help voor de functie Disable-PSRemoting, typt u:For example, to get Help for the Disable-PSRemoting function, type:

get-help disable-psremoting

Typ de volledig gekwalificeerde pad naar het scriptbestand de Help-informatie voor een script.To display the Help for a script, type the fully qualified path to the script file. Als het script in een pad dat wordt vermeld in de omgevingsvariabele Path is, kunt u het pad van de opdracht weglaten.If the script is in a path that is listed in the Path environment variable, you can omit the path from the command.

Bijvoorbeeld, als er een script met de naam 'TestScript.ps1' in uw C:\PS-Test directory, zodat het Help-onderwerp voor het script, type:For example, if you have a script called "TestScript.ps1" in your C:\PS-Test directory, to display the Help topic for the script, type:

get-help c:\ps-test\TestScript.ps1

De parameters die zijn ontworpen voor het weergeven van de cmdlet Help zoals gedetailleerd, volledige, voorbeelden, en Parameter, voor script Help-informatie en hulp nodig hebt, te werken.The parameters that were designed for displaying cmdlet Help, such as Detailed, Full, Examples, and Parameter, work for script Help and function Help, too. Echter, wanneer u alle Help weergeven door in te voeren ' get-help *', Help voor functies en scripts niet wordt weergegeven.However, when you display all Help, by typing "get-help *", Help for functions and scripts does not appear.

Zie voor meer informatie over het schrijven van Help-onderwerpen voor de functies en scripts about_Functions [m2], about_Scripts, en about_Comment_Based_Help.For information about writing Help topics for your functions and scripts, see about_Functions [m2], about_Scripts, and about_Comment_Based_Help.

Help-informatie OnlineGetting Help Online

Als u met het Internet verbonden bent, is een van de aanbevolen manieren om hulp te krijgen om de Help-onderwerpen online weer te geven.If you are connected to the Internet, one of the best ways to get Help is to view the Help topics online. Omdat online-onderwerpen gemakkelijk om bij te werken, zijn ze waarschijnlijk de meest actuele informatie bieden.Because online topics are easy to update, they are likely to provide the most current content.

Als u online Help, probeert de Online parameter van de cmdlet Get-Help.To get Help online, try the Online parameter of the Get-Help cmdlet. De Online parameter van de Get-Help cmdlet werkt alleen voor cmdlet Help Help functioneren en Help script.The Online parameter of the Get-Help cmdlet works only for cmdlet Help, function Help, and script Help. U kunt geen gebruiken de Online parameter met de conceptuele (over) onderwerpen of provider Help-onderwerpen.You cannot use the Online parameter with conceptual (About) topics or provider Help topics. Bovendien omdat deze functie optioneel is, werkt het niet voor elke cmdlet, een functie of een script Help-onderwerp.Also, because this feature is optional, it does not work for every cmdlet, function, or script Help topic.

Echter alle Help-onderwerpen die worden geleverd met Windows PowerShell, met inbegrip van provider Help en conceptuele (over) Help-onderwerpen zijn online beschikbaar de Windows PowerShell sectie van de Microsoft TechNet Library.However, all the Help topics that come with Windows PowerShell, including provider Help and conceptual (About) Help topics, are available online in the Windows PowerShell section of the Microsoft TechNet Library.

Gebruik de Online parameter van de cmdlet Get-Help, gebruik de volgende notatie voor de opdracht.To use the Online parameter of the Get-Help cmdlet, use the following command format.

get-help <command-name> -online

Bijvoorbeeld, als u de online versie van het Help-onderwerp over de cmdlet Get-ChildItem, typt u:For example, to get the online version of the Help topic about the Get-ChildItem cmdlet, type:

get-help get-childitem -online

Als een onlineversie van het Help-onderwerp beschikbaar is, wordt deze in de standaardbrowser geopend.If an online version of the Help topic is available, it will open in your default browser.

Als de online-Help wordt ondersteund voor een Help-onderwerp, kunt u ook het internetadres (URL) van het Help-onderwerp weergeven.If online Help is supported for a Help topic, you can also view the Internet address (URL) of the Help topic. Het internetadres wordt weergegeven in de sectie Verwante koppelingen van een Help-onderwerp.The Internet address appears in the Related Links section of a Help topic.

Bijvoorbeeld, als u wilt zien van de URL voor de online versie van de cmdlet Add-Computer, typt u:For example, to see the URL for the online version of the Add-Computer cmdlet, type:

get-help add-computer

De eerste regel in het gedeelte Verwante koppelingen van het onderwerp worden hieronder weergegeven.The first line in the Related Links section of the topic is shown below.

Online version: http://go.microsoft.com/fwlink/?LinkID=135194

Zie voor meer informatie over het online ondersteuning bieden voor uw Help-onderwerpen about_Comment_Based_Help, en zien schrijven Cmdlet helpen in de MSDN-bibliotheek.For information about how to provide online support for your Help topics, see about_Comment_Based_Help, and see How to Write Cmdlet Help in the MSDN library.

Zie ookSee Also