Командлет Get-Help — полезное средство изучения Windows PowerShell. Читая описания командлетов, изучая концепции оболочки Windows PowerShell и возможности ее языка, можно научиться работать с ней.
Скорее всего, пользователя, ранее не работавшего с Windows PowerShell, в первую очередь заинтересует справочная система. Чтобы получить сведения о справочной системе оболочки Windows PowerShell, введите следующую команду:
get-help
После этого можно изучить несколько базовых командлетов, таких как Get-Help, Get-Command, Get-Process, Get-Service и Get-Eventlog.
Чтобы получить простейшую справку о командлете, введите get-help и имя командлета. Например, для получения справки по командлету Get-Command введите следующую команду:
get-help get-command
Если справочные сведения о командлете отформатированы некорректно, т. е. начинаются с тегов XMLNS, это может быть связано с тем, что действующая политика выполнения Windows PowerShell не позволила системе загрузить конфигурационный файл, нужный для форматирования справочных сведений о командлете. Чтобы получить сведения о политиках выполнения, введите следующую команду:
get-help about_execution_policies
Чтобы получить подробную справку о командлете, включающую описания параметров и примеры, запустите командлет Get-Help с параметром Detailed. Например, чтобы получить подробную справку о командлете Get-Command, введите следующую команду:
get-help get-command -detailed
Чтобы отобразить все доступные справочные сведения о командлете, в том числе техническую информацию о самом командлете и его параметрах, нужно использовать параметр Full. Например, чтобы получить полную справку о командлете Get-Command, введите следующую команду:
get-help get-command -full
Кроме того, можно отобразить отдельные фрагменты файла справки. Чтобы просмотреть только примеры, нужно использовать параметр Examples. Например, чтобы отобразить примеры использования командлета Get-Command, введите следующую команду:
get-help get-command -examples
Чтобы просмотреть только подробные описания параметров, воспользуйтесь командлетом Get-Help с параметром Parameter. При этом можно указать имя интересующего параметра или ввести подстановочный знак (*) для получения сведений обо всех параметрах. Например, чтобы отобразить описание параметра TotalCount командлета Get-Command, введите следующую команду:
get-help get-command -parameter totalcount
Чтобы просмотреть сведения обо всех параметрах командлета Get-Command, введите следующую команду:
get-help get-command -parameter *
Справку по Windows PowerShell также можно найти в Интернете в библиотеке Microsoft TechNet в разделе Windows PowerShell. Сетевую версию справки намного удобнее читать, и она обновляется чаще, чем справка, которая выводится в командной строке.
В Windows PowerShell 2 для отображения сетевой версии справки по командлету нужно использовать параметр Online командлета Get-Help. По умолчанию параметр Online дает ссылку на справочные разделы в библиотеке TechNet.
Например, чтобы открыть сетевую версию раздела справки для командлета Get-Process, введите:
get-help get-process -online
Кроме того, для получения справочных сведений можно использовать функции Windows PowerShell, вызывающие командлет Get-Help. Функция Help отображает справочные сведения постранично. Функция Man отображает справочные сведения в стиле страниц Man системы Unix. Для отображения справки о командлете Get-Command с помощью функции Help или Man введите одну из следующих команд:
man get-command
или
help get-command
При запросе определенного раздела справки командлет Get-Help выводит содержимое этого раздела, а при использовании подстановочных символов для запроса нескольких разделов справки командлет Get-Help выводит список разделов. Например, чтобы просмотреть список разделов справки по командлетам Get, введите следующую команду:
get-help get-*
Разделы справки, объясняющие основные концепции Windows PowerShell, начинаются с префикса about_. Для получения справки о концепции Windows PowerShell введите команду get-help и имя концепции. (Имя концепции введите на английском языке, даже если используется локализованная версия Windows PowerShell.)
Например, чтобы получить справку о подстановочных знаках, введите следующую команду:
get-help about_wildcards
Чтобы отобразить список всех разделов справки, посвященных концепциям Windows PowerShell, введите следующую команду:
get-help about_*
Читая разделы справки и изучая примеры, можно научиться работать с оболочкой Windows PowerShell.