Get-Help

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

C:\PS>get-help

Description
-----------
Эта команда отображает справку по справочной системе оболочки Windows PowerShell.

C:\PS>get-help *

Description
-----------
Эта команда отображает список всех файлов справки в справочной системе оболочки Windows PowerShell.

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

Description
-----------
Эта команда отображает базовые сведения о командлете get-alias. Команды "Get-Help" и "-?" выводят сведения на одной странице. Команда "Help" отображает сведения постранично.

C:\PS>get-help about_*

Description
-----------
Эта команда выводит список разделов основных сведений, содержащихся в справке для оболочки Windows PowerShell. Все эти разделы начинаются со строки "about_". Для вывода конкретного файла справки введите команду "get-help <имя_раздела>, например "get-help about_signing".

C:\PS>get-help ls -detailed

Description
-----------
Эта команда выводит подробную справку по командлету Get-ChildItem, заданному одним из своих псевдонимов "ls". Параметр Detailed требует подробного представления файла справки, включая описания параметров и примеры. Для просмотра полного файла справки по командлету воспользуйтесь параметром Full.

C:\PS>get-help format-string -full

Description
-----------
Эта команда выводит полное представление справки по командлету Format-String. Полное представление справки включает описание параметров, примеры и таблицу технических сведений о параметрах.

C:\PS>get-help start-service -examples

Description
-----------
Эта команда выводит примеры использования командлета start-service в командах Windows PowerShell.

C:\PS>get-help get-childitem -parameter f*

Description
-----------
Эта команда выводит описания параметров командлета Get-ChildItem, которые начинаются с буквы "f" (filter и force). Чтобы просмотреть описания всех параметров, введите команду "get-help get-childitem parameter*".

C:\PS>(get-help write-output).syntax

Description
-----------
Эта команда выводит только синтаксис вызова командлета Write-Output. 

Синтаксис является одним из свойств объектов справки. Также доступны описание, дополнительные сведения, примеры и параметры. Чтобы определить все свойства и методы объектов справки, введите команду "get-help <имя_командлета> | get-member", например "get-help start-service | get member".

C:\PS>(get-help trace-command).alertset

Description
-----------
Эта команда отображает примечания о командлете. Примечания сохраняются в свойстве alertSet объекта справки.

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

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.

C:\PS>get-help get-member -online

Description
-----------
Эта команда отображает интернет-версию раздела справки по командлету Get-Member.

C:\PS>get-help remoting

Description
-----------
Эта команда выводит список разделов, в содержимом которых встречается слово "remoting". 

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

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.

C:\PS>get-help c:\ps-test\MyScript.ps1

Description
-----------
Эта команда возвращает справку по скрипту MyScript.ps1. Информацию о написании разделов справки для функций и скриптов см. в разделе about_Comment_Based_Help.