자세한 도움말 정보 보기

Windows PowerShell에는 Windows PowerShell 개념과 Windows PowerShell 언어에 대해 설명하는 자세한 도움말 항목이 포함되어 있습니다. 각 cmdlet 및 공급자에 대한 도움말 항목과 여러 함수 및 스크립트에 대한 도움말 항목도 있습니다.

명령 프롬프트에서 이러한 도움말 항목을 표시하거나, Microsoft TechNet 라이브러리에서 이러한 항목의 최신 업데이트 버전을 볼 수 있습니다. Windows PowerShell 통합 스크립팅 환경 등 Windows PowerShell을 호스트하는 여러 프로그램에서는 상황에 맞는 도움말과 컴파일된 도움말 파일(.chm)과 같은 추가적인 도움말 기능을 제공합니다.

cmdlet에 대한 도움말 보기

Windows PowerShell cmdlet에 대한 도움말을 보려면 Get-Help cmdlet을 사용합니다. 예를 들어 Get-ChildItem cmdlet에 대한 도움말을 보려면 다음과 같이 입력하십시오.

get-help get-childitem

또는

get-childitem -?

Get-Help cmdlet에 대한 도움말을 볼 수도 있습니다. 예를 들면 다음과 같습니다.

get-help get-help

세션에 있는 모든 cmdlet 도움말 항목의 목록을 보려면 다음과 같이 입력하십시오.

get-help -category cmdlet

각 도움말 항목을 한 번에 한 페이지씩 표시하려면 help 함수 또는 해당 별칭인 man을 사용하십시오. 예를 들어 Get-ChildItem cmdlet에 대한 도움말을 표시하려면 다음과 같이 입력하십시오.

man get-childitem

또는

help get-childitem

매개 변수에 대한 설명과 사용 예를 포함하여 cmdlet, 함수 또는 스크립트에 대한 자세한 정보를 표시하려면 Get-Help cmdlet의 Detailed 매개 변수를 사용합니다. 예를 들어 Get-ChildItem cmdlet에 대한 자세한 정보를 보려면 다음과 같이 입력하십시오.

get-help get-childitem -detailed

도움말 항목의 모든 내용을 표시하려면 Get-Help cmdlet의 Full 매개 변수를 사용합니다. 예를 들어 Get-ChildItem에 대한 도움말 항목에 있는 모든 내용을 표시하려면 다음과 같이 입력하십시오.

get-help get-childitem -full

cmdlet의 매개 변수에 대한 자세한 도움말을 보려면 Get-Help cmdlet의 Parameter 매개 변수를 사용합니다. 예를 들어 Get-ChildItem cmdlet의 모든 매개 변수에 대한 자세한 도움말을 보려면 다음과 같이 입력하십시오.

get-help get-childitem -parameter *

도움말 항목에 있는 예만 표시하려면 Get-Help의 Example 매개 변수를 사용합니다. 예를 들어 Get-ChildItem cmdlet에 대한 도움말 항목에 있는 예만 표시하려면 다음과 같이 입력하십시오.

get-help get-childitem -examples

직접 작성한 cmdlet에 대한 도움말 항목을 작성하는 방법에 대한 자세한 내용은 MSDN의 "How to Write Cmdlet Help(Cmdlet 도움말 작성 방법)" 항목을 참조하십시오.

개념 도움말 보기

Get-Help cmdlet은 Windows PowerShell 언어에 대한 항목을 비롯하여 Windows PowerShell에서 개념 항목에 대한 정보도 표시합니다. 개념 도움말 항목은 about_line_editing과 같이 "about_" 접두사로 시작합니다. 개념 항목의 이름은 영어 이외 버전의 Windows PowerShell을 사용하는 경우에도 영어로 입력해야 합니다.

개념 항목 목록을 표시하려면 다음과 같이 입력하십시오.

get-help about_*

특정 도움말 항목을 표시하려면 다음과 같이 항목 이름을 입력하십시오.

get-help about_command_syntax

Detailed, Parameter 및 Examples와 같은 Get-Help의 매개 변수는 개념 도움말 항목의 표시에 영향을 주지 않습니다.

공급자에 대한 도움말 보기

Get-Help cmdlet은 Windows PowerShell 공급자에 대한 정보를 표시합니다. 공급자에 대한 도움말을 보려면 "Get-Help"를 입력하고 그 뒤에 공급자 이름을 입력합니다. 예를 들어 레지스트리 공급자에 대한 도움말을 보려면 다음과 같이 입력하십시오.

get-help registry

세션에 있는 모든 공급자 도움말 항목의 목록을 보려면 다음과 같이 입력하십시오.

get-help -category provider

Detailed, Parameter 및 Examples와 같은 Get-Help의 매개 변수는 공급자 도움말 항목의 표시에 영향을 주지 않습니다.

스크립트 및 함수에 대한 도움말 보기

Windows PowerShell의 여러 스크립트 및 함수에는 도움말 항목이 있습니다. Get-Help cmdlet을 사용하여 스크립트 및 함수의 도움말 항목을 표시할 수 있습니다.

함수에 대한 도움말을 표시하려면 "get-help"를 입력하고 그 뒤에 함수 이름을 입력합니다. 예를 들어 Disable-PSRemoting 함수에 대한 도움말을 보려면 다음과 같이 입력하십시오.

get-help disable-psremoting

스크립트에 대한 도움말을 표시하려면 스크립트 파일의 정규화된 경로를 입력합니다. 스크립트가 Path 환경 변수에 나열된 경로에 있으면 명령에서 경로를 생략할 수 있습니다.

예를 들어 C:\PS-Test 디렉터리에 "TestScript.ps1"이라는 스크립트가 있는 경우 이 스크립트의 도움말 항목을 표시하려면 다음과 같이 입력하십시오.

get-help c:\ps-test\TestScript.ps1

Detailed, Full, Examples 및 Parameter와 같이 cmdlet 도움말을 표시하도록 설계된 매개 변수는 스크립트 도움말 및 함수 도움말에서도 사용됩니다. 그러나 "get-help *"를 입력하여 모든 도움말을 표시할 때는 함수 및 스크립트에 대한 도움말이 나타나지 않습니다.

함수 및 스크립트에 대한 도움말 항목을 작성하는 방법에 대한 자세한 내용은 about_Functions, about_Scripts 및 about_Comment_Based_Help를 참조하십시오.

온라인 도움말 보기

인터넷에 연결된 경우에는 온라인에서 도움말 항목을 보는 것이 가장 좋은 방법 중 하나입니다. 온라인 항목은 업데이트하기 쉽기 때문에 최신 내용이 제공될 가능성이 높습니다.

온라인 도움말을 보려면 Get-Help cmdlet의 Online 매개 변수를 사용합니다. Get-Help cmdlet의 Online 매개 변수는 cmdlet 도움말, 함수 도움말 및 스크립트 도움말에서만 사용할 수 있습니다. 개념(About) 항목이나 공급자 도움말 항목에서는 Online 매개 변수를 사용할 수 없습니다. 또한 이 기능은 선택 항목이기 때문에 일부 cmdlet, 함수 또는 스크립트 도움말 항목에서는 작동하지 않습니다.

그러나 공급자 도움말 및 개념(About) 도움말 항목을 포함하여 Windows PowerShell과 함께 제공되는 모든 도움말 항목은 Microsoft TechNet 라이브러리의 Windows PowerShell 섹션에서 온라인으로 볼 수 있습니다.

Get-Help cmdlet의 Online 매개 변수를 사용하려면 다음 명령 형식을 사용하십시오.

get-help <command-name> -online

예를 들어 Get-ChildItem cmdlet에 대한 온라인 버전의 도움말 항목을 보려면 다음과 같이 입력하십시오.

get-help get-childitem -online

온라인 버전의 도움말 항목이 있는 경우 기본 브라우저에서 열립니다.

도움말 항목에 대해 온라인 도움말이 지원되는 경우 도움말 항목의 인터넷 주소(URL)도 볼 수 있습니다. 인터넷 주소는 도움말 항목의 관련 링크 섹션에 나타납니다.

예를 들어 Add-Computer cmdlet의 온라인 버전에 대한 URL을 보려면 다음과 같이 입력하십시오.

get-help add-computer

항목의 관련 링크 섹션에 있는 첫 번째 줄은 아래와 같이 표시됩니다.

Online version: https://go.microsoft.com/fwlink/?LinkID=135194

도움말 항목의 온라인 지원을 제공하는 방법에 대한 자세한 내용은 about_Comment_Based_Help와 MSDN(Microsoft Developer Network) 라이브러리의 "How to Write Cmdlet Help(Cmdlet 도움말 작성 방법)"(https://go.microsoft.com/fwlink/?LinkID=123415)를 참조하십시오.