Get-Help

구문

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

Description

Get-Help cmdlet은 cmdlet, 함수, CIM(Common Information Model) 명령, 워크플로, 공급자, 별칭 및 스크립트를 포함하여 PowerShell 개념 및 명령에 대한 정보를 표시합니다.

PowerShell cmdlet에 대한 도움말을 보려면 Get-Help 다음 cmdlet 이름(예: Get-Help Get-Process)을 입력합니다.

PowerShell의 개념 도움말 문서는 about_Comparison_Operators같은 about_시작합니다. 모든 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동일하지만 cmdlet에 대해서만 작동합니다.

Get-Help 컴퓨터의 도움말 파일에서 표시되는 도움말 콘텐츠를 가져옵니다. 도움말 파일이 없으면 Get-Help cmdlet에 대한 기본 정보만 표시합니다. 일부 PowerShell 모듈에는 도움말 파일이 포함됩니다. PowerShell 3.0부터 Windows 운영 체제와 함께 제공되는 모듈에는 도움말 파일이 포함되지 않습니다. PowerShell 3.0에서 모듈에 대한 도움말 파일을 다운로드하거나 업데이트하려면 Update-Help cmdlet을 사용합니다.

PowerShell 도움말 문서를 온라인으로 볼 수도 있습니다. 도움말 파일의 온라인 버전을 얻으려면 Online 매개 변수(예: Get-Help Get-Process -Online)를 사용합니다.

도움말 문서의 정확한 이름 뒤에 Get-Help 입력하거나 도움말 문서에 고유한 단어를 입력하면 Get-Help 문서의 콘텐츠가 표시됩니다. 명령 별칭의 정확한 이름을 지정하는 경우 Get-Help 원래 명령에 대한 도움말을 표시합니다. 여러 도움말 문서 제목에 표시되는 단어 또는 단어 패턴을 입력하면 Get-Help 일치하는 제목 목록이 표시됩니다. 도움말 문서 제목에 표시되지 않는 텍스트를 입력하면 Get-Help 해당 내용에 해당 텍스트를 포함하는 문서 목록이 표시됩니다.

Get-Help 지원되는 모든 언어 및 로캘에 대한 도움말 문서를 가져올 수 있습니다. Get-Help 먼저 Windows용 로캘 집합에서 도움말 파일을 찾은 다음, 부모 로캘(예: pt-BRpt) 및 대체 로캘을 찾습니다. PowerShell 3.0부터 Get-Help 대체 로캘에서 도움말을 찾지 못하면 오류 메시지를 반환하거나 자동 생성된 도움말을 표시하기 전에 영어, en-US도움말 문서를 찾습니다.

명령 구문 다이어그램에 Get-Help 표시되는 기호에 대한 자세한 내용은 about_Command_Syntax참조하세요. 필수 및 위치같은 매개 변수 특성에 대한 자세한 내용은 about_Parameters참조하세요.

PSReadLine v2.2.2부터 모듈에는 명령줄에 명령을 입력하는 동안 도움이 되는 빠른 액세스를 제공하는 두 개의 함수가 제공됩니다. 도움말은 페이징이 있는 대체 화면 버퍼의 터미널에 표시됩니다.

F1 키를 누르면 PSReadLineShowCommandHelp 함수는 커서 왼쪽에 가장 가까운 cmdlet 이름에 대한 Get-Help -Full 호출합니다. 커서가 매개 변수의 왼쪽에 있는 경우 함수는 전체 도움말 항목에서 해당 매개 변수의 설명으로 이동합니다. Q 눌러 도움말 보기를 종료하면 명령 입력을 계속할 수 있도록 동일한 커서 위치에 있는 명령줄로 돌아갑니다.

Alth키 조합을 사용하면 PSReadLine 함수는 커서 왼쪽에 있는 매개 변수에 대한 도움말 정보를 즉시 표시합니다. 명령줄 아래에 도움말 텍스트가 표시됩니다. 이렇게 하면 매개 변수에 대한 설명을 보고 명령을 계속 입력할 수 있습니다.

자세한 내용은 동적 도움말사용하여 참조하세요.

예제

예제 1: cmdlet에 대한 기본 도움말 정보 표시

다음 예제에서는 Format-Table cmdlet에 대한 기본 도움말 정보를 표시합니다.

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

Get-Help <cmdlet-name> Get-Help cmdlet의 가장 간단하고 기본 구문입니다. Name 매개 변수를 생략할 수 있습니다.

구문 <cmdlet-name> -? cmdlet에 대해서만 작동합니다.

예제 2: 기본 정보를 한 번에 한 페이지씩 표시

다음 예제에서는 한 번에 한 페이지에 Format-Table cmdlet에 대한 기본 도움말 정보를 표시합니다.

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

help Get-Help cmdlet을 내부적으로 실행하고 결과를 한 번에 한 페이지씩 표시하는 함수입니다.

man help 함수의 별칭입니다.

Get-Help Format-Table 개체를 파이프라인 아래로 보냅니다. Out-Host -Paging 파이프라인에서 출력을 수신하고 한 번에 한 페이지씩 표시합니다. 자세한 내용은 Out-Host참조하세요.

예제 3: cmdlet에 대한 자세한 정보 표시

이러한 예제에서는 Format-Table cmdlet에 대한 자세한 도움말 정보를 표시합니다.

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

자세한 매개 변수는 매개 변수 설명 및 예제를 포함하는 도움말 문서의 자세한 보기를 표시합니다.

전체 매개 변수는 매개 변수 설명, 예제, 입력 및 출력 개체 형식 및 추가 메모를 포함하는 도움말 문서의 전체 보기를 표시합니다.

자세한 및 전체 매개 변수는 도움말 파일이 컴퓨터에 설치된 명령에만 적용됩니다. 매개 변수는 개념(about_) 도움말 문서에는 효과적이지 않습니다.

예제 4: 매개 변수를 사용하여 cmdlet의 선택한 부분 표시

다음 예제에서는 Format-Table cmdlet 도움말의 선택한 부분을 표시합니다.

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

예제 매개 변수는 도움말 파일의 NAME 및 SYNOPSIS 섹션 및 모든 예제를 표시합니다. Examples 매개 변수가 switch 매개 변수이므로 예제 번호를 지정할 수 없습니다.

매개 변수 매개 변수는 지정된 매개 변수에 대한 설명만 표시합니다. 별표(*) 와일드카드 문자만 지정하면 모든 매개 변수에 대한 설명이 표시됩니다. 매개 변수GroupBy같은 매개 변수 이름을 지정하면 해당 매개 변수에 대한 정보가 표시됩니다.

이러한 매개 변수는 개념(about_) 도움말 문서에는 효과적이지 않습니다.

예제 5: 온라인 버전의 도움말 표시

다음은 기본 웹 브라우저에서 Format-Table cmdlet에 대한 도움말 문서의 온라인 버전을 표시하는 예제입니다.

Get-Help Format-Table -Online

예제 6: 도움말 시스템에 대한 도움말 표시

매개 변수가 없는 Get-Help cmdlet은 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: cmdlet 도움말에서 단어 검색

이 예제에서는 cmdlet 도움말 문서에서 단어를 검색하는 방법을 보여줍니다.

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 개체가 파이프라인 아래로 전송됩니다. Out-String Stream 매개 변수를 사용하여 개체를 문자열로 변환합니다. Select-String Pattern 매개 변수를 사용하여 문자열에서 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대한 공급자별 도움말을 가져오는 두 가지 방법을 보여 주었습니다. 이러한 명령은 PowerShell SQL Server 공급자의 Get-Item 노드에서 cmdlet을 사용하는 방법을 설명하는 도움말을 제공합니다.

첫 번째 예제에서는 Get-HelpPath 매개 변수를 사용하여 SQL Server 공급자의 경로를 지정합니다. 공급자의 경로가 지정되었으므로 모든 경로 위치에서 명령을 실행할 수 있습니다.

두 번째 예제에서는 Set-Location 사용하여 SQL Server 공급자의 경로로 이동합니다. 해당 위치에서 공급자별 도움말을 얻기 위해 Get-Help 매개 변수가 필요하지 않습니다.

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

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

입력

None

개체를 이 cmdlet으로 파이프할 수 없습니다.

출력

ExtendedCmdletHelpInfo

도움말 파일이 없는 명령에서 Get-Help 실행하는 경우 Get-Help 자동 생성된 도움말을 나타내는 ExtendedCmdletHelpInfo 개체를 반환합니다.

String

개념 도움말 문서를 받으면 Get-Help 문자열로 반환합니다.

MamlCommandHelpInfo

도움말 파일이 있는 명령을 받으면 Get-HelpMamlCommandHelpInfo 개체를 반환합니다.

참고

PowerShell 3.0에는 도움말 파일이 포함되어 있지 않습니다. 읽기를 Get-Help 도움말 파일을 다운로드하고 설치하려면 Update-Help cmdlet을 사용합니다. Update-Help cmdlet을 사용하여 PowerShell과 함께 제공되는 핵심 명령 및 설치하는 모든 모듈에 대한 도움말 파일을 다운로드하고 설치할 수 있습니다. 컴퓨터의 도움말이 오래되지 않도록 도움말 파일을 업데이트하는 데 사용할 수도 있습니다.

Windows PowerShell 시작시작하는 PowerShell 온라인과 함께 제공되는 명령에 대한 도움말 문서를 읽을 수도 있습니다.

Get-Help Windows 운영 체제의 로캘 집합 또는 해당 로캘에 대한 대체 언어로 도움말을 표시합니다. 기본 또는 대체 로캘에 대한 도움말 파일이 없는 경우 Get-Help 컴퓨터에 도움말 파일이 없는 것처럼 동작합니다. 다른 로캘에 대한 도움말을 보려면 제어판에서 지역 및 언어 사용하여 설정을 변경합니다. Windows 10 이상에서는 설정, 시간 & 언어.

도움말의 전체 보기에는 매개 변수에 대한 정보 테이블이 포함되어 있습니다. 표에는 다음 필드가 포함되어 있습니다.

• 필수입니다. 매개 변수가 필요한지(true) 또는 선택 사항(false)인지를 나타냅니다.

• 위치. 매개 변수의 이름을 지정하는지 위치(숫자)인지 여부를 나타냅니다. 위치 매개 변수는 명령의 지정된 위치에 나타나야 합니다.

• 명명된 매개 변수 이름이 필요하지만 매개 변수가 명령의 아무 곳에나 나타날 수 있음을 나타냅니다.

• 숫자 매개 변수 이름이 선택 사항임을 나타내지만 이름을 생략하면 매개 변수가 숫자로 지정된 위치에 있어야 합니다. 예를 들어 2 매개 변수 이름을 생략하면 매개 변수가 명령의 두 번째 또는 명명되지 않은 매개 변수여야 임을 나타냅니다. 매개 변수 이름을 사용하면 명령의 아무 곳에나 매개 변수가 나타날 수 있습니다.

• 기본값. 명령에 매개 변수를 포함하지 않는 경우 PowerShell에서 사용하는 매개 변수 값 또는 기본 동작입니다.

• 파이프라인 입력을 허용합니다. 파이프라인을 통해 매개 변수에 개체를 보낼 수 있는지(true) 또는 (false) 보낼 수 있는지 여부를 나타냅니다. By Property Name 파이프라인된 개체에는 매개 변수 이름과 이름이 같은 속성이 있어야 합니다.

• 와일드카드 문자를 허용합니다. 매개 변수 값에 별표(*) 또는 물음표(?)와 같은 와일드카드 문자를 포함할 수 있는지 여부를 나타냅니다.

관련 링크

• about_Command_Syntax
• about_Comment_Based_Help
• Get-Command
• Updatable 도움말 지원
• Update-Help
• 메모 기반 도움말 항목 작성
• PowerShell Cmdlet에 대한 도움말 작성