Отображает сведения о командах и концепциях Windows PowerShell.
Синтаксис
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>] Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>] Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>] Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Описание
Командлет Get-Help выводит сведения о командах и концепциях Windows PowerShell, в том числе командлетах, поставщиках, функциях и скриптах. Чтобы просмотреть полный список разделов справки по командлетам, введите команду "get-help *".
Если команда "Get-Help" введена с указанием точного имени раздела справки или слова, являющегося уникальным признаком раздела справки, команда Get-Help отобразит содержимое указанного раздела справки. Если введено слово или шаблон слова, которому соответствуют несколько заголовков разделов справки, Get-Help отобразит список соответствующих заголовков. Если введено слово, которое не используется ни в одном из заголовков разделов справки, Get-Help отобразит список соответствующих разделов, в содержимом которых встречается это слово.
Кроме команды "get-help", можно вводить команды "help" или "man", позволяющие просматривать справку по экранам, или команду "<cmdlet-name> -?", которая полностью соответствует команде Get-Help, но распространяется только на командлеты.
Можно отобразить весь файл справки или некоторые его разделы, например синтаксис, параметры или примеры. Для отображения интернет-версии файла справки по командлету в браузере можно использовать параметр Online. Эти параметры не влияют на отображение разделов справки по основным понятиям.
Разделы справки по основным понятиям Windows PowerShell начинаются с префикса "about_", например " about_Comparison_Operators". Чтобы просмотреть список всех разделов "about_", введите команду "get-help about_*". Чтобы просмотреть определенный раздел, введите команду "get-help about_<имя_раздела>", например "get-help about_Comparison_Operators".
Параметры
-Category <string[]>
Отображает справку по элементам в указанной категории. Допустимые значения: Alias, Cmdlet, Provider и HelpFile. Разделы основных сведений принадлежат к категории HelpFile.
Категория является свойством объекта MamlCommandHelpInfo, возвращаемого командлетом Get-Help. Этот параметр не влияет на отображение справки по основным понятиям ("about_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Component <string[]>
Отображает список средств с заданным значением компонента, таким как "Exchange". Введите имя компонента. Подстановочные знаки разрешены.
Компонент является свойством объекта MamlCommandHelpInfo, возвращаемого командлетом Get-Help. Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Detailed
Добавляет описания параметров и примеры к отображаемой базовой справке.
Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Examples
Отображает только имя, краткое описание и примеры. Чтобы отобразить только примеры, введите команду "(get-help <имя_командлета>).examples".
Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Full
Отображает весь файл справки по командлету, включая описания параметров и атрибуты, примеры, сведения о типах входных и выходных объектов, а также дополнительные примечания.
Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Functionality <string[]>
Отображает справку для элементов с указанной функциональностью. Введите функциональность. Подстановочные знаки разрешены.
Функциональность является свойством объекта MamlCommandHelpInfo, возвращаемого командлетом Get-Help. Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Name <string>
Запрашивает справку по указанному средству или раздел основных сведений.
Введите имя командлета, поставщика, скрипта или функции, например Get-Member, имя раздела основных сведений, например "about_Objects", или псевдоним, например "ls". Подстановочные знаки можно использовать в именах командлетов и поставщиков, но их нельзя использовать при поиске разделов справки для функций и скриптов.
Чтобы получить справку для скрипта, который не расположен в папке, указанной в переменной среды Path, введите путь и имя файла скрипта.
Если введено точное название раздела справки, Get-Help отобразит содержимое раздела. Если введено слово или шаблон слова, которому соответствуют несколько заголовков разделов справки, Get-Help отобразит список соответствующих заголовков. Если введено слово, которое не соответствует ни одному из заголовков разделов справки, Get-Help отобразит список соответствующих разделов, в содержимом которых встречается это слово.
Имена разделов основных сведений, например about_Objects, должны указываться на английском языке даже в версиях Windows PowerShell, отличных от английской.
Обязательно? |
false |
Позиция? |
1 |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
true (ByPropertyName) |
Принимать подстановочные знаки? |
false |
-Online
Отображает интернет-версию раздела справки в браузере по умолчанию. Этот параметр допустим только для разделов справки, посвященных командлетам, функциям и скриптам.
Get-Help использует адрес в Интернете (URI), который указан в первом элементе раздела "Ссылки по теме" описания командлета, функции или скрипта в справочной системе. Этот параметр работает, только если раздел справки включает URI, начинающийся на "Http" или "Https", и в системе установлен браузер.
Сведения о поддержке этой функции в собственных разделах справки см. в разделе about_Comment_Based_Help и в документе "Написание справки для командлетов" (http://go.microsoft.com/fwlink/?LinkID=123415) в библиотеке MSDN.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
нет |
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Parameter <string>
Отображает только подробные описания указанных параметров. Подстановочные знаки разрешены.
Этот параметр не влияет на отображение справки по основным понятиям ("About_").
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Path <string>
Получает справку, в которой поясняется работа командлета по заданному пути поставщика. Введите путь к поставщику Windows PowerShell.
Этот параметр получает адаптированную версию раздела справки по командлету, в котором описано, как этот командлет работает по указанному пути поставщика Windows PowerShell. Этот параметр можно использовать только для получения справки о командлете поставщика, и только если поставщик включил пользовательскую версию раздела справки по командлету поставщика.
Чтобы открыть справку по пользовательскому командлету для пути поставщика, перейдите по пути поставщика и введите команду Get-Help, или в любом расположении воспользуйтесь параметром Path команды Get-Help, чтобы задать путь поставщика. Дополнительные сведения см. в разделе About_Providers.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Role <string[]>
Отображает специальную справку по указанной роли пользователя. Введите роль. Подстановочные знаки разрешены.
Введите роль, которую пользователь выполняет в организации. Некоторые командлеты отображают различный текст в файлах справки в зависимости от значения этого параметра. Этот параметр не влияет на справку по основным командлетам.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
<CommonParameters>
Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.
Ввод и вывод
Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.
Входные данные |
None Передать объекты этому командлету по конвейеру невозможно. |
Выходные данные |
System.String или MamlCommandHelpInfo Команда Get-Help возвращает раздел основных сведений в форме строки. Если задано имя командлета, функции или скрипта, она возвращает объект MamlCommandHelpInfo. В противном случае команда Get-Help возвращает форматированные представления, заданные в файле Help.Format.ps1xml каталога $pshome. |
Примечания
При вызове без параметров команда "Get-Help" отображает сведения о справочной системе оболочки Windows PowerShell.
Полное представление справки (-full) включает таблицу со сведениями о параметрах. В таблице содержатся следующие поля.
-- Необходимый. Показывает, является ли параметр необходимым (да) или необязательным (нет).
-- Позиция. Показывает, используется ли параметр как именованный или позиционный (под номером). Позиционные параметры должны появляться в указанном месте команды.
-- "Именованный" означает, что параметру необходимо имя, но такой параметр может появляться в любом месте команды.
-- <Число> означает, что имя параметра необязательно, но при его отсутствии параметр должен располагаться в месте, определяемом этим числом. Например, "2" означает, что при отсутствии имени параметра этот параметр должен быть вторым (2) или единственным неименованным параметром команды. Если используется имя параметра, параметр может располагаться в любом месте команды.
-- Значение по умолчанию. Значение параметра, используемое оболочкой Windows PowerShell, если параметр не включен в команду.
-- Принимает вход с конвейера. Показывает, можно ли (да) или нельзя (нет) посылать объекты в этот параметр по конвейеру. "По имени свойства" означает, что конвейеризованный объект должен иметь свойство с тем же именем, что и имя данного параметра.
-- Принимает подстановочные знаки. Показывает, может ли значение параметра включать подстановочные знаки, такие как "*" и "?".
Пример 1
C:\PS>get-help Description ----------- Эта команда отображает справку по справочной системе оболочки Windows PowerShell.
Пример 2
C:\PS>get-help * Description ----------- Эта команда отображает список всех файлов справки в справочной системе оболочки Windows PowerShell.
Пример 3
C:\PS>get-help get-alias C:\PS>help get-alias C:\PS>get-alias -? Description ----------- Эта команда отображает базовые сведения о командлете get-alias. Команды "Get-Help" и "-?" выводят сведения на одной странице. Команда "Help" отображает сведения постранично.
Пример 4
C:\PS>get-help about_* Description ----------- Эта команда выводит список разделов основных сведений, содержащихся в справке для оболочки Windows PowerShell. Все эти разделы начинаются со строки "about_". Для вывода конкретного файла справки введите команду "get-help <имя_раздела>, например "get-help about_signing".
Пример 5
C:\PS>get-help ls -detailed Description ----------- Эта команда выводит подробную справку по командлету Get-ChildItem, заданному одним из своих псевдонимов "ls". Параметр Detailed требует подробного представления файла справки, включая описания параметров и примеры. Для просмотра полного файла справки по командлету воспользуйтесь параметром Full.
Пример 6
C:\PS>get-help format-string -full Description ----------- Эта команда выводит полное представление справки по командлету Format-String. Полное представление справки включает описание параметров, примеры и таблицу технических сведений о параметрах.
Пример 7
C:\PS>get-help start-service -examples Description ----------- Эта команда выводит примеры использования командлета start-service в командах Windows PowerShell.
Пример 8
C:\PS>get-help get-childitem -parameter f* Description ----------- Эта команда выводит описания параметров командлета Get-ChildItem, которые начинаются с буквы "f" (filter и force). Чтобы просмотреть описания всех параметров, введите команду "get-help get-childitem parameter*".
Пример 9
C:\PS>(get-help write-output).syntax Description ----------- Эта команда выводит только синтаксис вызова командлета Write-Output. Синтаксис является одним из свойств объектов справки. Также доступны описание, дополнительные сведения, примеры и параметры. Чтобы определить все свойства и методы объектов справки, введите команду "get-help <имя_командлета> | get-member", например "get-help start-service | get member".
Пример 10
C:\PS>(get-help trace-command).alertset Description ----------- Эта команда отображает примечания о командлете. Примечания сохраняются в свойстве alertSet объекта справки. В примечания включаются основные сведения и советы по использованию командлета. По умолчанию примечания отображаются только при использовании параметра Full команды Get-Help, но их также можно отобразить с помощью свойства alertSet.
Пример 11
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml Description ----------- В этом примере показано, как выполнить поиск слова в определенном разделе справки по командлету. Эта команда выполняет поиск слова "clixml" в полной версии раздела справки по командлету Add-Member. Поскольку командлет Get-Help создает объект MamlCommandHelpInfo, а не строку, необходимо использовать команду, преобразующую содержимое раздела в строку, например Out-String или Out-File.
Пример 12
C:\PS>get-help get-member -online Description ----------- Эта команда отображает интернет-версию раздела справки по командлету Get-Member.
Пример 13
C:\PS>get-help remoting Description ----------- Эта команда выводит список разделов, в содержимом которых встречается слово "remoting". Если введено слово, которое не используется ни в одном из разделов справки, Get-Help отобразит список разделов, в содержимом которых встречается это слово.
Пример 14
C:\PS>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. ... C:\PS> cd SQLSERVER:\DataCollection C:\PS> 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. ... C:\PS> Get-Item NAME Get-Item SYNOPSIS Gets the item at the specified location. ... Description ----------- В этом примере показано, как получить справку по командлету Get-Item, в которой поясняется использование командлета в узле DataCollection поставщика SQL Server Windows PowerShell. В примере демонстрируются два способа получение специальной справки по Get-Item. В первой команде используется параметр Path командлета Get-Help для задания пути поставщика. Эта команда может вводиться в любом местоположении. Во второй команде используется командлет Set-Location (псевдоним "cd") для перехода в путь поставщика. Из этого местоположения команда Get-Help возвратит специальную справку по пути поставщика даже без использования параметра Path. Третья команда демонстрирует, что при использовании Get-Help в пути файловой системы без указания параметра Path будет возвращена стандартная справка по командлету Get-Item.
Пример 15
C:\PS>get-help c:\ps-test\MyScript.ps1 Description ----------- Эта команда возвращает справку по скрипту MyScript.ps1. Информацию о написании разделов справки для функций и скриптов см. в разделе about_Comment_Based_Help.