Получение подробных справочных сведений

Для получения справки о командлетах Windows PowerShell используйте командлет Get-Help. Например, для получения справки по командлету Get-ChildItem, введите следующую команду:

get-help get-childitem

или

get-childitem -?

Справку можно получить и по самому командлету Get-Help. Пример.

get-help get-help

Чтобы отобразить список всех разделов справки для текущего сеанса, введите следующую команду:

get-help -category cmdlet

Чтобы отображать каждый раздел справки постранично, используйте функцию help или ее псевдоним man. Например, чтобы отобразить справку по командлету Get-ChildItem, введите следующую команду:

man get-childitem

или

help get-childitem

Чтобы вывести подробную информацию о командлете, функции или скрипте, включающую описания параметров и примеры использования, используйте параметр Detailed командлета Get-Help. Например, чтобы получить подробные справочные сведения о командлете Get-ChildItem, введите следующую команду:

get-help get-childitem -detailed

Чтобы показать все содержание раздела справки, используйте параметр Full командлета Get-Help. Например, чтобы вывести все содержимое раздела справки для командлета Get-ChildItem, введите:

get-help get-childitem -full

Чтобы получить подробную справку по параметрам командлета, используйте параметр Parameter командлета Get-Help. Например, для получения подробной справки по всем параметрам командлета Get-ChildItem введите команду:

get-help get-childitem -parameter *

Чтобы вывести только примеры из раздела справки, используйте параметр Example командлета Get-Help. Например, чтобы получить примеры из раздела справки для командлета Get-ChildItem, введите следующую команду:

get-help get-childitem -examples

Дополнительные сведения о написании разделов справки для командлетов можно найти в разделе "How to Write Cmdlet Help" (Как писать справку для командлетов) в библиотеке MSDN.

Командлет Get-Help также можно использовать для вывода разделов справки, посвященных концепциям Windows PowerShell, в том числе разделов о языке Windows PowerShell. Посвященные концепциям разделы справки начинаются префиксом "about_", например about_line_editing. (Название концепции нужно вводить на английском языке, даже если используется локализованная версия Windows PowerShell.)

Для отображения списка концептуальных разделов введите:

get-help about_*

Для отображения определенного раздела справки введите имя раздела, например:

get-help about_command_syntax

Параметры командлета Get-Help, например Detailed, Parameter и Examples, не влияют на отображение концептуальных разделов справки.

Командлет Get-Help позволяет получить информацию о поставщиках Windows PowerShell. Чтобы получить справку для поставщика, введите команду Get-Help и имя поставщика. Например, чтобы получить справку для поставщика Registry, введите команду:

get-help registry

Чтобы отобразить список всех разделов справки по поставщикам для текущего сеанса, введите следующую команду:

get-help -category provider

Параметры командлета Get-Help, например Detailed, Parameter и Examples, не влияют на отображение разделов справки, посвященных поставщикам.

Многим скриптам и функциям Windows PowerShell посвящены разделы справки. Командлет Get-Help можно использовать для просмотра разделов справки, посвященных скриптам и функциям.

Чтобы получить справку для функции, введите команду get-help и имя функции. Например, для получения справки по функции Disable-PSRemoting введите следующую команду:

get-help disable-psremoting

Для вывода справки по скрипту введите полный путь к файлу скрипта. Если путь к скрипту указан в переменной среды Path, его можно не указывать в команде.

Например, если скрипт TestScript.ps1 находится в каталоге C:\PS-Test, для вывода раздела справки по этому скрипту введите команду:

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

Параметры вывода справки по командлетам, в том числе Detailed, Full, Examples и Parameter, работают для вывода справки по скриптам и функциям. Однако при выводе всех разделов справки с помощью команды "get-help *" справка по функциям и скриптам не выводится.

Информацию о написании разделов справки для функций и скриптов см. в разделах about_Functions, about_Scripts и about_Comment_Based_Help.

Если локальный компьютер подключен к Интернету, лучше всего использовать разделы справки в Интернете. Поскольку разделы справки в Интернете легко обновлять, в них обычно содержится самая актуальная информация.

Для получения справки в Интернете используйте параметр Online командлета Get-Help. Параметр Online командлета Get-Help может использоваться только для справки по командлетам, функциям и скриптам. Параметр Online нельзя использовать для вывода разделов справки о концепциях (About) и поставщиках. Поскольку эта возможность необязательна, она может не работать для некоторых разделов справки по командлетам, функциям и скриптам.

Однако все разделы справки, входящие в комплект Windows PowerShell, в том числе разделы справки по поставщикам и концептуальные (About) разделы справки, можно найти в Интернете в разделе Windows PowerShell библиотеки Microsoft TechNet.

Для использования параметра Online командлета Get-Help нужно применять следующий формат.

get-help <command-name> -online

Например, чтобы открыть сетевую версию раздела справки о командлете Get-ChildItem, введите:

get-help get-childitem -online

Если сетевая версия раздела справки доступна, она откроется в установленном по умолчанию браузере.

Если для раздела справки имеется сетевая версия, можно просмотреть и интернет-адрес (URL) раздела справки. Интернет-адрес отображается в разделе "Ссылки по теме" раздела справки.

Например, чтобы посмотреть адрес сетевой версии командлета Add-Computer, введите команду:

get-help add-computer

Первая строка в разделе "Ссылки по теме" показана ниже.

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

Информацию об организации сетевой поддержки собственных разделов справки можно найти в разделе about_Comment_Based_Help и в документе "Написание справки для командлетов" (https://go.microsoft.com/fwlink/?LinkID=123415) в библиотеке MSDN.