Поделиться через

Get-Help

  • Ссылка
Модуль:
Microsoft.PowerShell.Core

Отображает сведения о командах и концепциях PowerShell.

Синтаксис

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Описание

Командлет Get-Help отображает сведения о концепциях и командах PowerShell, включая командлеты, функции, команды Common Information Model (CIM), рабочие процессы, поставщики, псевдонимы и скрипты.

Чтобы получить справку для командлета PowerShell, введите Get-Help за именем командлета, например Get-Help Get-Process.

Основные статьи справки в PowerShell начинаются с about_, например about_Comparison_Operators. Чтобы просмотреть все статьи about_, введите Get-Help about_*. Чтобы просмотреть определенную статью, введите Get-Help about_<article-name>, например Get-Help about_Comparison_Operators.

Чтобы получить справку для поставщика PowerShell, введите Get-Help за именем поставщика. Например, чтобы получить справку для поставщика сертификатов, введите Get-Help Certificate.

Вы также можете ввести help или man, в котором отображается один экран текста одновременно. Или, <cmdlet-name> -?, это идентично Get-Help, но работает только для командлетов.

Get-Help получает содержимое справки, отображаемое из файлов справки на компьютере. Без файлов справки Get-Help отображает только основные сведения о командлетах. Некоторые модули PowerShell включают файлы справки. Начиная с PowerShell 3.0, модули, которые входят в операционную систему Windows, не включают файлы справки. Чтобы скачать или обновить файлы справки для модуля в PowerShell 3.0, используйте командлет Update-Help.

Вы также можете просмотреть документы справки PowerShell в Интернете. Чтобы получить веб-версию файла справки, используйте параметр Online, например Get-Help Get-Process -Online.

Если вы вводите Get-Help с точным именем статьи справки или словом, уникальным для статьи справки, Get-Help отображает содержимое статьи. Если указать точное имя псевдонима команды, Get-Help отобразится справка для исходной команды. Если ввести слово или шаблон слова, отображаемый в нескольких заголовках статей справки, Get-Help отобразится список соответствующих названий. Если вы вводите текст, который не отображается в заголовках статей справки, Get-Help отображает список статей, которые включают этот текст в их содержимое.

Get-Help статьи справки по всем поддерживаемым языкам и языковым стандартам. Get-Help сначала ищет файлы справки в языковом стандарте Windows, а затем в родительском языковом стандарте, например pt для pt-BR, а затем в резервном языковом стандарте. Начиная с PowerShell 3.0, если Get-Help не находит справку в резервном языковом стандарте, он ищет статьи справки на английском языке en-US, прежде чем он возвращает сообщение об ошибке или отображает автоматическую справку.

Сведения о символах, которые Get-Help отображаются на схеме синтаксиса команд, см. в about_Command_Syntax. Сведения об атрибутах параметров, таких как Обязательный и положение, см. в about_Parameters.

Заметка

В PowerShell 3.0 и PowerShell 4.0 Get-Help не удается найти статьи о в модулях, если модуль не импортируется в текущий сеанс. Чтобы получить статьи о в модуле, импортируйте модуль с помощью командлета Import-Module или выполнив командлет, включенный в модуль.

Начиная с PSReadLine версии 2.2.2 модуль поставляется с двумя функциями, которые предоставляют быстрый доступ, чтобы помочь при вводе команды в командной строке. Справка отображается в терминале в альтернативном буфере экрана с разбиением по страницам.

При нажатии клавиши F1 функция PSReadLineShowCommandHelp вызывает Get-Help -Full для имени командлета слева от курсора. Когда курсор сразу же находится слева от параметра, функция переходит к описанию этого параметра в разделе полной справки. При нажатии Q для выхода из представления справки вы вернеесь в командную строку в той же позиции курсора, чтобы продолжить ввод команды.

При использовании сочетания клавиш alt+hфункция PSReadLineShowParameterHelp отображает сведения справки для параметра слева от курсора. Текст справки отображается под командной строкой. Это позволяет просмотреть описание параметра и продолжить ввод команды.

Дополнительные сведения см. в разделе Использование динамической справки.

Примеры

Пример 1. Отображение основных сведений о справке о командлете

В этих примерах отображаются основные сведения о командлете Format-Table.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> — это самый простой и стандартный синтаксис командлета Get-Help. Можно опустить параметр имени .

Синтаксис <cmdlet-name> -? работает только для командлетов.

Пример 2. Отображение основных сведений на одной странице за раз

В этих примерах отображаются основные сведения о командлете Format-Table по одной странице за раз.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help — это функция, которая выполняется Get-Help командлета внутри системы и отображает результат на одной странице одновременно.

man — это псевдоним функции help.

Get-Help Format-Table отправляет объект вниз конвейера. Out-Host -Paging получает выходные данные из конвейера и отображает его по одной странице за раз. Дополнительные сведения см. в out-host.

Пример 3. Отображение дополнительных сведений для командлета

В этих примерах отображаются более подробные сведения о командлете Format-Table.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

В параметре "Подробный" отображается подробное представление статьи справки, включающее описания параметров и примеры.

Параметр Full отображает полное представление статьи справки, включающую описания параметров, примеры, типы входных и выходных объектов и дополнительные заметки.

Параметры Подробные и Full эффективны только для команд, которые имеют файлы справки, установленные на компьютере. Параметры не эффективны для статей справки (about_).

Пример 4. Отображение выбранных частей командлета с помощью параметров

В этих примерах отображаются выбранные части справки по командлету Format-Table.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Параметр examples отображает имя файла справки и разделы SYNOPSIS и все примеры. Невозможно указать номер примера, так как параметр Examples является параметром switch.

Параметр отображает только описания указанных параметров. Если указать только подстановочный знак звездочки (*), он отображает описания всех параметров. Если параметр указывает имя параметра, например GroupBy, отображаются сведения об этом параметре.

Эти параметры не эффективны для статей справки (about_).

Пример 5. Отображение веб-версии справки

В этом примере отображается интерактивная версия справки для командлета Format-Table в веб-браузере по умолчанию.

Get-Help Format-Table -Online

Пример 6. Отображение справки о системе справки

Командлет Get-Help без параметров отображает сведения о системе справки PowerShell.

Get-Help

Пример 7. Отображение доступных статей справки

В этом примере отображается список всех статей справки, доступных на компьютере.

Get-Help *

Пример 8. Отображение списка концептуальных статей

В этом примере отображается список концептуальных статей, включенных в справку PowerShell. Все эти статьи начинаются с символов about_. Чтобы отобразить определенный файл справки, введите Get-Help \<about_article-name\>, например Get-Help about_Signing.

Отображаются только концептуальные статьи с файлами справки, установленными на компьютере. Сведения о скачивании и установке файлов справки в PowerShell 3.0 см. в разделе update-Help.

Get-Help about_*

Пример 9. Поиск слова в справке командлета

В этом примере показано, как найти слово в статье справки по командлету.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help использует параметр Full для получения сведений о справке по Add-Member. Объект MamlCommandHelpInfo отправляется по конвейеру. использует параметр Stream для преобразования объекта в строку. использует параметр шаблона для поиска строки Clixml.

Пример 10. Отображение списка статей, включающих слово

В этом примере отображается список статей, включающих слово удаленного взаимодействия.

При вводе слова, которое не отображается в заголовке статьи, Get-Help отображает список статей, включающих это слово.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Пример 11. Справка для конкретного поставщика

В этом примере показаны два способа получения справки для конкретного поставщика для Get-Item. Эти команды помогут в том, как использовать командлет в узле DataCollection поставщика PowerShell SQL Server.

В первом примере используется параметр Get-Helppath, чтобы указать путь поставщика SQL Server. Так как указан путь поставщика, можно выполнить команду из любого расположения пути.

Второй пример использует Set-Location для перехода к пути поставщика SQL Server. В этом расположении параметр пути не нужен для получения справки для конкретного поставщика.

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.
    ...

Set-Location SQLSERVER:\DataCollection
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.
    ...

Пример 12. Отображение справки по скрипту

В этом примере показано, как помочь MyScript.ps1 script. Сведения о том, как написать справку по функциям и сценариям, см. в about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Параметры

-Category

Отображает справку только для элементов указанной категории и их псевдонимов. Концептуальные статьи находятся в категории HelpFile.

Допустимые значения для этого параметра приведены следующим образом:

  • Псевдоним
  • Командлет
  • Поставщик
  • Общее
  • Вопросы и ответы
  • Глоссарий
  • HelpFile
  • ScriptCommand
  • Функция
  • Фильтр
  • ExternalScript
  • Все
  • DefaultHelp
  • Рабочий процесс
  • DscResource
  • Класс
  • Конфигурация
Тип:String[]
Допустимые значения:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Component

Отображает команды с указанным значением компонента, например Exchange. Введите имя компонента. Разрешены подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Detailed

Добавляет описания параметров и примеры в базовое отображение справки. Этот параметр действует только при установке файлов справки на компьютере. Он не влияет на отображение концептуальной (About_) справки.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Examples

Отображает только имя, синопсис и примеры. Этот параметр действует только при установке файлов справки на компьютере. Он не влияет на отображение концептуальной (About_) справки.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Full

Отображает всю статью справки для командлета. Full включает описания параметров и атрибуты, примеры, типы входных и выходных объектов и дополнительные заметки.

Этот параметр действует только при установке файлов справки на компьютере. Он не влияет на отображение концептуальной (About_) справки.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Functionality

Отображает справку по элементам с указанными функциями. Введите функциональные возможности. Разрешены подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Name

Получает справку по указанной команде или концепции. Введите имя командлета, функции, поставщика, скрипта или рабочего процесса, например Get-Member, концептуальное имя статьи, например about_Objects, или псевдоним, например ls. Подстановочные знаки разрешены в именах командлетов и поставщиков, но вы не можете использовать подстановочные знаки для поиска имен справки функций и статей справки по скрипту.

Чтобы получить справку по скрипту, который не находится в пути, указанном в переменной среды $env:Path, введите путь и имя файла скрипта.

Если ввести точное имя статьи справки, Get-Help отображает содержимое статьи.

Если ввести слово или шаблон слова, отображаемый в нескольких заголовках статей справки, Get-Help отобразится список соответствующих названий.

Если вы вводите текст, который не соответствует заголовкам статей справки, Get-Help отображает список статей, которые включают этот текст в их содержимое.

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

Тип:String
Position:0
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-Online

Отображает веб-версию статьи справки в браузере по умолчанию. Этот параметр действителен только для статей справки по командлетам, функциям, рабочим процессам и скриптам. Невозможно использовать параметр Online с Get-Help в удаленном сеансе.

Сведения о поддержке этой функции в статьях справки, которые вы пишете, см. в статьях about_Comment_Based_Helpи поддержке веб-справкии справку по написанию справки по командлетам PowerShell.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Parameter

Отображает только подробные описания указанных параметров. Разрешены подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

Тип:String[]
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Path

Возвращает справку, объясняющую, как командлет работает в указанном пути поставщика. Введите путь поставщика PowerShell.

Этот параметр получает настраиваемую версию справки командлета, которая объясняет, как командлет работает в указанном пути поставщика PowerShell. Этот параметр действует только для справки о командлете поставщика и только если поставщик включает пользовательскую версию справки командлета поставщика в файле справки. Чтобы использовать этот параметр, установите файл справки для модуля, включающего поставщика.

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

Дополнительные сведения о поставщиках PowerShell см. в about_Providers.

Заметка

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Role

Отображает справку, настроенную для указанной роли пользователя. Введите роль. Разрешены подстановочные знаки.

Введите роль, которую пользователь играет в организации. Некоторые командлеты отображают другой текст в файлах справки на основе значения этого параметра. Этот параметр не влияет на справку для основных командлетов.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-ShowWindow

Отображает раздел справки в окне для упрощения чтения. В окне содержится функция поиска поиска и поле параметров, которое позволяет задавать параметры отображения, включая параметры для отображения только выбранных разделов справки.

Параметр ShowWindow поддерживает разделы справки по командам (командлетам, функциям, командам CIM, скриптам) и концептуальным о статьях. Он не поддерживает справку поставщика.

Этот параметр был повторно введен в PowerShell 7.0. Этот параметр доступен только в Windows.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

ExtendedCmdletHelpInfo

Если вы запускаете Get-Help в команде, в которой нет файла справки, Get-Help возвращает объект ExtendedCmdletHelpInfo, представляющий автоматическую справку.

String

Если вы получите концептуальную справку, Get-Help возвращает ее в виде строки.

MamlCommandHelpInfo

Если вы получите команду с файлом справки, Get-Help возвращает объект MamlCommandHelpInfo.

Примечания

PowerShell 3.0 не включает файлы справки. Чтобы скачать и установить файлы справки, которые Get-Help считываются, используйте командлет Update-Help. Командлет Update-Help можно использовать для скачивания и установки файлов справки для основных команд, которые входят в PowerShell и для всех установленных модулей. Вы также можете использовать его для обновления файлов справки, чтобы справка на компьютере никогда не устарела.

Вы также можете ознакомиться со статьями справки о командах, которые входят в PowerShell online, начиная с начала работы с Windows PowerShell.

Get-Help отображает справку в языковом стандарте для операционной системы Windows или на резервном языке для этого языкового стандарта. Если у вас нет файлов справки для основного или резервного языкового стандарта, Get-Help ведет себя так, как если на компьютере нет файлов справки. Чтобы получить справку по другому языковому стандарту, используйте регион и язык на панели управления, чтобы изменить параметры. В Windows 10 или более поздней версии параметрывремени &языка.

Полное представление справки содержит таблицу сведений о параметрах. Таблица содержит следующие поля:

  • Обязательный. Указывает, является ли параметр обязательным (true) или необязательным (false).

  • положение. Указывает, является ли параметр именованным или позициальным (числовым). Позиционные параметры должны отображаться в указанном месте команды.

  • Именованный указывает, что имя параметра является обязательным, но параметр может отображаться в любом месте команды.

  • числовой указывает, что имя параметра является необязательным, но если имя опущено, параметр должен находиться в месте, указанном номером. Например, 2 указывает, что если имя параметра опущено, параметр должен быть вторым или единственным неименованным параметром в команде. При использовании имени параметра параметр может отображаться в любом месте команды.

  • значение по умолчанию. Значение параметра или поведение по умолчанию, используемое PowerShell, если параметр не включен в команду.

  • Принимает входные данные конвейера. Указывает, можно ли (true) или не (false) отправлять объекты в параметр через конвейер. по имени свойства означает, что конвейерный объект должен иметь свойство с тем же именем, что и имя параметра.

  • Принимает подстановочные знаки. Указывает, может ли значение параметра включать подстановочные знаки, такие как звездочка (*) или вопросительный знак (?).