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

설명
-----------
이 명령은 Windows PowerShell 도움말 시스템에 대한 도움말을 표시합니다.

C:\PS>get-help *

설명
-----------
이 명령은 Windows PowerShell 도움말 시스템의 모든 도움말 파일 목록을 표시합니다.

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

설명
-----------
이들 명령은 get-alias cmdlet에 대한 기본 정보를 표시합니다. "Get-Help" 및 "-?" 명령은 정보를 한 페이지에 표시합니다. "Help" 명령은 한 번에 한 페이지씩 정보를 표시합니다.

C:\PS>get-help about_*

설명
-----------
이 명령은 Windows PowerShell 도움말에 포함된 개념 항목 목록을 표시합니다. 이러한 항목은 모두 "about_"으로 시작합니다. 특정 도움말 파일을 표시하려면 "get-help <topic-name>"(예: "get-help about_signing")을 입력하십시오.

C:\PS>get-help ls -detailed

설명
-----------
이 명령은 별칭 중하나("ls")를 지정하여 Get-ChildItem cmdlet의 자세한 도움말을 표시합니다. Detailed 매개 변수는 매개 변수 설명 및 예가 포함된 도움말 파일의 자세히 보기를 요청합니다. Cmdlet의 전체 도움말 파일을 보려면 Full 매개 변수를 사용합니다.

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

설명
-----------
이 명령은 Format-String cmdlet의 전체 보기 도움말을 표시합니다. 도움말 전체 보기에는 매개 변수 설명 및 예가 포함되어 있으며, 매개 변수에 대한 기술적 세부 정보 테이블을 제공합니다.

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

설명
-----------
이 명령은 Windows PowerShell 명령에 start-service를 사용하는 예를 표시합니다.

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

설명
-----------
이 명령은 "f"로 시작하는 Get-ChildItem cmdlet의 매개 변수(filter 및 force)에 대한 설명을 표시합니다. 모든 매개 변수에 대한 설명을 보려면 "get-help get-childitem parameter*"를 입력하십시오.

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

설명
-----------
이 명령은 Write-Output cmdlet의 구문만 표시합니다. 

구문은 도움말 개체의 많은 속성 중 하나이며 다른 속성으로는 설명, 세부 정보, 예, 매개 변수 등이 있습니다. 도움말 개체의 모든 속성 및 메서드를 찾으려면 "get-help <cmdlet-name> | get-member"(예: "get-help start-service | get member")를 입력하십시오.

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

설명
-----------
이 명령은 cmdlet에 대한 정보를 표시합니다. 이 정보는 도움말 개체의 alertSet 속성에 저장됩니다.

이 정보에는 개념 정보와 cmdlet 사용에 대한 팁이 포함되어 있습니다. 기본적으로 이 정보는 Get-Help의 Full 매개 변수를 사용할 때만 표시되지만 alertSet 속성을 통해서도 이 정보를 표시할 수 잇습니다.

C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml

설명
-----------
이 예에서는 특정 cmdlet 도움말 항목에서 단어를 검색하는 방법을 보여 줍니다. 이 명령은 Add-Member cmdlet의 정식 버전 도움말 항목에서 "clixml"이라는 단어를 검색합니다. 

Get-Help cmdlet은 문자열이 아니라 MamlCommandHelpInfo 개체를 생성하기 때문에 도움말 항목 내용을 Out-String 또는 Out-File과 같은 문자열로 변환하는 명령을 사용해야 합니다.

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

설명
-----------
이 명령은 Get-Member cmdlet의 온라인 버전 도움말 항목을 표시합니다.

C:\PS>get-help remoting

설명
-----------
이 명령은 내용에 "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.

...

설명
-----------
이 예에서는 Windows PowerShell SQL Server 공급자의 DataCollection 노드에서 Get-Item cmdlet을 사용하는 방법을 설명하는 Get-Item cmdlet의 도움말을 가져오는 방법을 보여 줍니다.

또한 Get-Item의 사용자 지정 도움말을 가져오는 두 가지 방법을 보여 줍니다. 

첫 번째 명령은 Get-Help의 Path 매개 변수를 사용하여 공급자 경로를 지정합니다. 이 명령은 모든 경로 위치에서 입력할 수 있습니다.

두 번째 명령은 Set-Location cmdlet(별칭 = "cd")을 사용하여 공급자 경로로 이동합니다. 이 위치에서 Path 매개 변수가 없는 경우에도 Get-Help 명령은 공급자 경로에 대한 사용자 지정 도움말을 가져옵니다.

세 번째 명령은 파일 시스템 경로의 Get-Help 명령은 Path 매개 변수 없이 Get-Item cmdlet의 표준 도움말을 가져오는 것을 보여 줍니다.

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

설명
-----------
이 명령은 MyScript.ps1 스크립트에 대한 도움말을 가져옵니다. 함수 및 스크립트에 대한 도움말을 작성하는 방법에 대한 자세한 내용은 about_Comment_Based_Help를 참조하십시오.