Uzyskiwanie szczegółowych informacji pomocyGetting detailed help information

Program PowerShell zawiera szczegółowe artykuły pomocy pojęcia programu PowerShell i języka programu PowerShell.PowerShell includes detailed Help articles that explain PowerShell concepts and the PowerShell language. Dostępne są także artykuły pomocy dla każdego polecenia cmdlet i dostawcy i wiele funkcji i skryptów.There are also Help articles for each cmdlet and provider and for many functions and scripts.

Można wyświetlić tych artykułów pomocy, w wierszu polecenia lub Wyświetl ostatnio zaktualizowane wersje tych artykułów w PowerShell dokumentacji online.You can display these Help articles at the command prompt or view the most recently updated versions of these articles in the PowerShell documentation online.

Uzyskiwanie pomocy dla poleceń cmdletGetting help for cmdlets

Aby uzyskać pomoc dotyczącą poleceń cmdlet programu PowerShell, należy użyć Get-Help polecenia cmdlet.To get Help about PowerShell cmdlets, use the Get-Help cmdlet. Na przykład, aby uzyskać pomoc dotyczącą Get-ChildItem polecenia cmdlet, wpisz:For example, to get Help for the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem

lubor

Get-ChildItem -?

Można nawet uzyskać pomoc dotyczącą polecenia cmdlet Get-Help.You can even get Help about the Get-Help cmdlet. Przykład:For example:

Get-Help Get-Help

Aby uzyskać listę polecenia cmdlet artykułów pomocy, w sesji, wpisz:To get a list of all the cmdlet Help articles in your session, type:

Get-Help -Category Cmdlet

Aby wyświetlić jedną stronę części każdego artykułu pomocy w czasie, użyj help funkcji lub jego alias man.To display one page of each Help article at a time, use the help function or its alias man. Na przykład, aby wyświetlić Pomoc dla Get-ChildItem polecenia cmdlet, typFor example, to display Help for the Get-ChildItem cmdlet, type

man Get-ChildItem

lubor

help Get-ChildItem

Aby wyświetlić szczegółowe informacje, należy użyć szczegółowe parametru Get-Help polecenia cmdlet.To display detailed information, use the Detailed parameter of the Get-Help cmdlet. Na przykład, aby uzyskać szczegółowe informacje na Get-ChildItem polecenia cmdlet, wpisz:For example, to get detailed information about the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Detailed

Aby wyświetlić całą zawartość w artykule pomocy, użyj pełne parametru Get-Help polecenia cmdlet.To display all content in the Help article, use the Full parameter of the Get-Help cmdlet. Na przykład, aby wyświetlić całą zawartość w artykule pomocy, aby Get-ChildItem polecenia cmdlet, wpisz:For example, to display all content in the Help article for the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Full

Aby uzyskać szczegółową pomoc dotyczącą parametry polecenia cmdlet, użyj parametru parametru Get-Help polecenia cmdlet.To get detailed Help about the parameters of a cmdlet, use the Parameter parameter of the Get-Help cmdlet. Na przykład, aby uzyskać szczegółowe pomocy dla wszystkich parametrów Get-ChildItem polecenia cmdlet, wpisz:For example, to get detailed Help for all of the parameters of the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Parameter *

Aby wyświetlić tylko w przykładach w artykule pomocy, użyj przykłady parametru Get-Help.To display only the examples in a Help article, use the Examples parameter of the Get-Help. Na przykład, aby wyświetlić tylko w przykładach w artykule pomocy, aby Get-ChildItempolecenia cmdlet, wpisz:For example, to display only the examples in the Help article for the Get-ChildItemcmdlet, type:

Get-Help Get-ChildItem -Examples

Aby uzyskać informacji na temat sposobu pisania artykułów pomocy dla poleceń cmdlet, które piszesz, zobacz sposobu pisania pomoc dotyczącą polecenia Cmdlet.For information about how to write Help articles for the cmdlets that you write, see How to Write Cmdlet Help.

Uzyskiwanie pomocy koncepcyjneGetting conceptual help

Get-Help Polecenie cmdlet wyświetla również informacji na temat artykułów koncepcyjnych w programie PowerShell, w tym artykuły na temat języka programu PowerShell.The Get-Help cmdlet also displays information about conceptual articles in PowerShell, including articles about the PowerShell language. Koncepcyjny pomocy artykuły zaczynają się od prefiksu "about_", takich jak about_line_editing.Conceptual Help articles begin with the "about_" prefix, such as about_line_editing. (Nazwa artykuł koncepcyjny należy podać w języku angielskim nawet w przypadku wersji innej niż angielska programu PowerShell.)(The name of the conceptual article must be entered in English even on non-English versions of PowerShell.)

Aby wyświetlić listę artykułów koncepcyjnych, wpisz:To display a list of conceptual articles, type:

Get-Help about_*

Aby wyświetlić określonego artykułu pomocy, wpisz nazwę artykułu, na przykład:To display a particular Help article, type the article name, for example:

Get-Help about_command_syntax

Parametry Get-Help, takich jak szczegółowe, parametru, i przykłady, nie mają wpływu na wyświetlanie artykuły koncepcyjne pomocy.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of conceptual Help articles.

Uzyskiwanie pomocy na temat dostawcówGetting help about providers

Get-Help Polecenie cmdlet wyświetla informacje dotyczące dostawcy programu PowerShell.The Get-Help cmdlet displays information about PowerShell providers. Aby uzyskać pomoc dotyczącą dostawcę, należy wpisać Get-Help następuje nazwa dostawcy.To get Help for a provider, type Get-Help followed by the provider name. Na przykład aby uzyskać pomoc dotyczącą dostawcy rejestru, wpisz:For example, to get Help for the Registry provider, type:

Get-Help registry

Aby uzyskać listę wszystkich dostawca artykułów pomocy w sesji, wpiszTo get a list of all the provider Help articles in your session, type

Get-Help -Category provider

Parametry Get-Help, takich jak szczegółowe, parametru, i przykłady, nie mają wpływu na wyświetlanie dostawca artykułów pomocy.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of provider Help articles.

Uzyskiwanie pomocy na temat skryptów i funkcjiGetting help about scripts and functions

Wiele skryptów i funkcji w programie PowerShell ma artykułów pomocy.Many scripts and functions in PowerShell have Help articles. Użyj Get-Help polecenia cmdlet, aby wyświetlić artykułów pomocy, skryptach i funkcjach.Use the Get-Help cmdlet to display the Help articles for scripts and functions.

Aby wyświetlić Pomoc dla funkcji, wpisz Get-Help przed nazwą funkcji.To display the Help for a function, type Get-Help followed by the function name. Na przykład, aby uzyskać pomoc dotyczącą Disable-PSRemoting funkcji, wpisz:For example, to get Help for the Disable-PSRemoting function, type:

Get-Help Disable-PSRemoting

Aby wyświetlić Pomoc, aby uzyskać skrypt, wpisz ścieżkę do pliku skryptu.To display the Help for a script, type the path to the script file. Jeśli skrypt nie jest w ścieżce wymienione w zmiennej środowiskowej Path, musisz podać pełną ścieżkę.If the script is not in a path listed in the Path environment variable, you must use the fully qualified path.

Na przykład, jeśli masz skrypt o nazwie "TestScript.ps1" c:\katalogu PS testów do wyświetlenia artykułu pomocy, aby skrypt, wpisz:For example, if you have a script called "TestScript.ps1" in your C:\PS-Test directory, to display the Help article for the script, type:

Get-Help c:\ps-test\TestScript.ps1

Parametry, które są przeznaczone do wyświetlania pracy pomocy polecenia cmdlet dla skryptów i funkcję Pomoc zbyt.The parameters that are designed for displaying cmdlet Help work for script and function Help, too. Jednak Pomoc dla funkcji i skryptów nie jest wyświetlany po uruchomieniu Get-Help *.However, help for functions and scripts is not shown when you run Get-Help *.

Informacje na temat pisania artykułów pomocy dla funkcji i skryptów zobacz następujące artykuły:For information about writing Help articles for your functions and scripts, see the following articles:

Uzyskiwanie pomocy onlineGetting help online

Przeglądanie artykułów pomocy online jest jednym z najlepszych sposobów uzyskania pomocy.Viewing the Help articles online is one of the best ways to get help. Artykuły w trybie online są łatwiejsze do aktualizacji i zapewnia najbardziej aktualną zawartość.Online articles are easier to update and provide the most current content.

Aby uzyskać pomoc w trybie online, należy użyć Online parametru Get-Help polecenia cmdlet.To get Help online, use the Online parameter of the Get-Help cmdlet. Wszystkich artykułów pomocy, które przy użyciu programu PowerShell, włącznie z dostawcą pomocy i pojęciach (artykułów pomocy informacje) są dostępne w trybie online w PowerShell dokumentacji.All the Help articles that come with PowerShell, including provider Help and conceptual (About) Help articles, are available online in the PowerShell documentation.

Uwaga

Nie można użyć Online parametrem koncepcyjnej (about_*) lub dostawca artykułów pomocy.You can't use the Online parameter with conceptual (about_*) or provider Help articles. Pomoc online jest opcjonalne, więc nie działa dla każdego polecenia cmdlet, funkcji lub skryptu.Online help is optional, so it does not work for every cmdlet, function, or script.

Na przykład, aby uzyskać wersję online artykułu pomocy na temat Get-ChildItem polecenia cmdlet, wpisz:For example, to get the online version of the Help article about the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Online

Program PowerShell spowoduje otwarcie tego artykułu w domyślnej przeglądarce.PowerShell opens the article in your default browser. Pomoc online jest przeznaczony do artykułu pomocy, można również wyświetlić adres URL artykułu pomocy.If online Help is supported for a Help article, you can also view the URL of the Help article. Adres URL pojawia się w sekcji linki powiązane artykułu pomocy.The URL appears in the Related Links section of a Help article.

Na przykład aby zobaczyć adres URL dla wersji online polecenia cmdlet Add-Computer, wpisz:For example, to see the URL for the online version of the Add-Computer cmdlet, type:

Get-Help Add-Computer

Poniżej przedstawiono pierwszy wiersz w sekcji linki powiązane tego artykułu.The first line in the Related Links section of the article is shown below.

Online version: http://go.microsoft.com/fwlink/?LinkId=821564

Aby uzyskać informacje o tym, jak zapewnienie wsparcia online dla artykułów pomocy, zobacz about_Comment_Based_Help.For information about how to provide online support for your Help articles, see about_Comment_Based_Help.

Zobacz teżSee also