자세한 도움말 정보 보기Getting detailed help information

PowerShell에는 PowerShell 개념과 PowerShell 언어를 설명하는 자세한 도움말 문서가 포함되어 있습니다.PowerShell includes detailed Help articles that explain PowerShell concepts and the PowerShell language. 각 cmdlet 및 공급자에 대한 도움말 문서와 많은 함수 및 스크립트에 대한 도움말 문서도 있습니다.There are also Help articles for each cmdlet and provider and for many functions and scripts.

명령 프롬프트에서 이러한 도움말 문서를 표시하거나 PowerShell온라인 설명서에서 이러한 문서의 가장 최근 업데이트 버전을 볼 수 있습니다.You can display these Help articles at the command prompt or view the most recently updated versions of these articles in the PowerShell documentation online.

cmdlet에 대한 도움말 보기Getting help for cmdlets

PowerShell cmdlet에 대한 도움말을 보려면 Get-Help cmdlet을 사용합니다.To get Help about PowerShell cmdlets, use the Get-Help cmdlet. 예를 들어 Get-ChildItem cmdlet에 대한 도움말을 보려면 다음과 같이 입력합니다.For example, to get Help for the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem

또는or

Get-ChildItem -?

Get-Help cmdlet에 대한 도움말을 볼 수도 있습니다.You can even get Help about the Get-Help cmdlet. 예:For example:

Get-Help Get-Help

세션에 있는 모든 cmdlet 도움말 문서의 목록을 보려면 다음과 같이 입력합니다.To get a list of all the cmdlet Help articles in your session, type:

Get-Help -Category Cmdlet

각 도움말 문서를 한 번에 한 페이지씩 표시하려면 help 함수 또는 해당 별칭 man을 사용합니다.To display one page of each Help article at a time, use the help function or its alias man. 예를 들어 Get-ChildItem cmdlet에 대한 도움말을 표시하려면 다음과 같이 입력합니다.For example, to display Help for the Get-ChildItem cmdlet, type

man Get-ChildItem

또는or

help Get-ChildItem

자세한 정보를 표시하려면 Get-Help cmdlet의 Detailed 매개 변수를 사용합니다.To display detailed information, use the Detailed parameter of the Get-Help cmdlet. 예를 들어 Get-ChildItem cmdlet에 대한 자세한 정보를 보려면 다음과 같이 입력합니다.For example, to get detailed information about the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Detailed

도움말 문서의 모든 내용을 표시하려면 Get-Help cmdlet의 Full 매개 변수를 사용합니다.To display all content in the Help article, use the Full parameter of the Get-Help cmdlet. 예를 들어 Get-ChildItem cmdlet에 대한 도움말 문서의 모든 내용을 표시하려면 다음과 같이 입력합니다.For example, to display all content in the Help article for the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Full

cmdlet의 매개 변수에 대한 자세한 도움말을 보려면 Get-Help cmdlet의 Parameter 매개 변수를 사용합니다.To get detailed Help about the parameters of a cmdlet, use the Parameter parameter of the Get-Help cmdlet. 예를 들어 Get-ChildItem cmdlet의 모든 매개 변수에 대한 자세한 도움말을 보려면 다음과 같이 입력합니다.For example, to get detailed Help for all of the parameters of the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Parameter *

도움말 문서의 예제만 표시하려면 Get-HelpExample 매개 변수를 사용합니다.To display only the examples in a Help article, use the Examples parameter of the Get-Help. 예를 들어 Get-ChildItem cmdlet에 대한 도움말 문서의 예제만 표시하려면 다음과 같이 입력합니다.For example, to display only the examples in the Help article for the Get-ChildItemcmdlet, type:

Get-Help Get-ChildItem -Examples

작성하는 cmdlet의 도움말 문서를 작성하는 방법에 대한 자세한 내용은 Cmdlet 도움말 작성 방법을 참조하세요.For information about how to write Help articles for the cmdlets that you write, see How to Write Cmdlet Help.

개념 도움말 보기Getting conceptual help

Get-Help cmdlet은 PowerShell 언어에 대한 문서를 포함하여 PowerShell의 개념 항목에 대한 정보도 표시합니다.The Get-Help cmdlet also displays information about conceptual articles in PowerShell, including articles about the PowerShell language. 개념 도움말 문서는 "about_" 접두사로 시작합니다(예: about_line_editing).Conceptual Help articles begin with the "about_" prefix, such as about_line_editing. 개념 문서의 이름은 영어가 아닌 PowerShell 버전에서도 영어로 입력해야 합니다.(The name of the conceptual article must be entered in English even on non-English versions of PowerShell.)

개념 문서 목록을 표시하려면 다음과 같이 입력합니다.To display a list of conceptual articles, type:

Get-Help about_*

특정 도움말 문서를 표시하려면 다음과 같이 문서 이름을 입력합니다.To display a particular Help article, type the article name, for example:

Get-Help about_command_syntax

Detailed, ParameterExamples와 같은 Get-Help의 매개 변수는 개념 도움말 문서의 표시에 영향을 주지 않습니다.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of conceptual Help articles.

공급자에 대한 도움말 보기Getting help about providers

Get-Help cmdlet은 PowerShell 공급자에 대한 정보를 표시합니다.The Get-Help cmdlet displays information about PowerShell providers. 공급자에 대한 도움말을 보려면 "Get-Help"를 입력한 다음, 공급자 이름을 입력합니다.To get Help for a provider, type Get-Help followed by the provider name. 예를 들어 레지스트리 공급자에 대한 도움말을 보려면 다음과 같이 입력합니다.For example, to get Help for the Registry provider, type:

Get-Help registry

세션에 있는 모든 공급자 도움말 문서의 목록을 보려면 다음과 같이 입력합니다.To get a list of all the provider Help articles in your session, type

Get-Help -Category provider

Detailed, ParameterExamples와 같은 Get-Help의 매개 변수는 공급자 도움말 문서의 표시에 영향을 주지 않습니다.The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of provider Help articles.

스크립트 및 함수에 대한 도움말 보기Getting help about scripts and functions

PowerShell의 많은 스크립트 및 함수에는 도움말 문서가 있습니다.Many scripts and functions in PowerShell have Help articles. Get-Help cmdlet을 사용하여 스크립트 및 함수에 대한 도움말 문서를 표시할 수 있습니다.Use the Get-Help cmdlet to display the Help articles for scripts and functions.

함수에 대한 도움말을 표시하려면 "Get-Help"를 입력한 다음, 함수 이름을 입력합니다.To display the Help for a function, type Get-Help followed by the function name. 예를 들어 Disable-PSRemoting 함수에 대한 도움말을 보려면 다음과 같이 입력합니다.For example, to get Help for the Disable-PSRemoting function, type:

Get-Help Disable-PSRemoting

스크립트에 대한 도움말을 표시하려면 스크립트 파일의 경로를 입력합니다.To display the Help for a script, type the path to the script file. 스크립트가 Path 환경 변수에 나열된 경로에 없는 경우 정규화된 경로를 사용해야 합니다.If the script is not in a path listed in the Path environment variable, you must use the fully qualified path.

예를 들어 C:\PS-Test 디렉터리에 "TestScript.ps1"이라는 스크립트가 있는 경우 이 스크립트의 도움말 문서를 표시하려면 다음과 같이 입력합니다.For example, if you have a script called "TestScript.ps1" in your C:\PS-Test directory, to display the Help article for the script, type:

Get-Help c:\ps-test\TestScript.ps1

cmdlet 도움말을 표시하도록 디자인된 매개 변수는 스크립트 및 함수 도움말에도 작동합니다.The parameters that are designed for displaying cmdlet Help work for script and function Help, too. 그러나 Get-Help *를 표시할 때 함수 및 스크립트에 대한 도움말은 표시되지 않습니다.However, help for functions and scripts is not shown when you run Get-Help *.

함수 및 스크립트에 대한 도움말 문서 작성에 대한 내용은 다음 문서를 참조하세요.For information about writing Help articles for your functions and scripts, see the following articles:

온라인 도움말 보기Getting help online

온라인 도움말 문서는 도움말을 보는 가장 좋은 방법 중 하나입니다.Viewing the Help articles online is one of the best ways to get help. 온라인 문서는 업데이트하기가 더 쉽고 가장 최신 콘텐츠를 제공합니다.Online articles are easier to update and provide the most current content.

온라인 도움말을 보려면 Get-Help cmdlet의 Online 매개 변수를 사용합니다.To get Help online, use the Online parameter of the Get-Help cmdlet. 공급자 도움말 및 개념(정보) 도움말을 포함하여 Powershell에 함께 제공되는 모든 도움말 문서는 온라인 PowerShell 설명서에서 볼 수 있습니다.All the Help articles that come with PowerShell, including provider Help and conceptual (About) Help articles, are available online in the PowerShell documentation.

참고

개념(about_*) 또는 공급자 도움말 문서에서는 Online 매개 변수를 사용할 수 없습니다.You can't use the Online parameter with conceptual (about_*) or provider Help articles. 온라인 도움말은 선택 항목이기 때문에 일부 cmdlet, 함수 또는 스크립트에는 작동하지 않습니다.Online help is optional, so it does not work for every cmdlet, function, or script.

예를 들어 Get-ChildItem cmdlet에 대한 온라인 버전의 도움말 문서를 보려면 다음과 같이 입력합니다.For example, to get the online version of the Help article about the Get-ChildItem cmdlet, type:

Get-Help Get-ChildItem -Online

PowerShell은 기본 브라우저에서 문서를 엽니다.PowerShell opens the article in your default browser. 도움말 문서에 대해 온라인 도움말이 지원되는 경우 도움말 문서의 URL도 볼 수 있습니다.If online Help is supported for a Help article, you can also view the URL of the Help article. URL은 도움말 문서의 관련 링크 섹션에 나타납니다.The URL appears in the Related Links section of a Help article.

예를 들어 Add-Computer cmdlet의 온라인 버전에 대한 URL을 보려면 다음과 같이 입력합니다.For example, to see the URL for the online version of the Add-Computer cmdlet, type:

Get-Help Add-Computer

문서의 관련 링크 섹션에 있는 첫 번째 줄은 아래와 같이 표시됩니다.The first line in the Related Links section of the article is shown below.

Online version: http://go.microsoft.com/fwlink/?LinkId=821564

도움말 문서에 대한 온라인 지원을 제공하는 방법에 대한 내용은 about_Comment_Based_Help를 참조하세요.For information about how to provide online support for your Help articles, see about_Comment_Based_Help.

참고 항목See also