PowerShell에서 특정 명령어에 대한 도움말을 확인하려면 Get-Help cmdlet(별칭: help)을 사용하면 됩니다. 도움이 필요한 명령어와 함께 입력하기만 하면 됩니다.
예를 들어 다음과 같이 사용합니다.
help Get-Service
이 명령을 실행하면 NAME(이름), SYNOPSIS(개요), SYNTAX(구문), DESCRIPTION(설명), RELATED LINKS(관련 링크), REMARKS(비고) 항목에 대한 설명을 확인할 수 있습니다.
Get-Help의 주요 매개변수
Get-Help는 목적에 따라 다양한 매개변수를 지원합니다.
-Full : 전체 상세 도움말
매개변수에 대한 자세한 설명과 예제까지 포함된 전체 도움말을 표시합니다.
help Get-Service -Full
-Detailed : 매개변수 중심의 상세 도움말
매개변수에 대한 상세한 설명을 제공하지만 예제는 포함되지 않습니다.
help Get-Service -Detailed
-Examples : 예제만 보기
예제와 관련된 도움말 내용만 PowerShell 화면에 표시됩니다.
help Get-Service -Examples
-Online : 온라인 도움말 보기
해당 cmdlet의 도움말 내용을 Microsoft 공식 웹사이트에서 온라인으로 검색하여 보여줍니다.
help Get-Service -Online
도움말 콘텐츠 업데이트 (Update-Help)
PowerShell 버전을 설치하거나 업데이트할 때, 또는 PowerShell이 사전 설치된 새 운영체제를 설치할 때는 반드시 Microsoft 웹사이트에서 도움말 콘텐츠를 최신 상태로 업데이트해야 합니다. 이 작업은 Update-Help 명령으로 수행할 수 있습니다.
Microsoft는 도움말 콘텐츠를 지속적으로 갱신하기 때문에 오래된 정보가 쌓이지 않도록 한 달에 한 번 정도 업데이트하는 것이 권장됩니다. 시스템에 오래된 도움말이 남아 있으면 일부 cmdlet의 도움말이 표시되지 않을 수 있으며, 이 경우에도 도움말 콘텐츠를 업데이트하면 해결됩니다.
-ShowWindow : 별도 창에서 도움말 보기
-ShowWindow 매개변수를 지정하면 해당 명령의 도움말이 별도의 창에 표시됩니다.
help Get-Service -ShowWindow
별도 창에는 Settings(설정) 버튼이 있으며, 여기에서 특정 항목만 필터링해서 볼 수 있는 옵션이 제공됩니다. 특정 섹션의 도움말만 필요하다면 해당 설정을 선택하면 됩니다.
-Parameter : 특정 매개변수의 도움말 보기
명령줄에서 특정 매개변수에 대한 도움말이 필요하다면 -Parameter 뒤에 매개변수 이름을 입력합니다.
help Get-Service -Parameter ComputerName
실행 결과는 다음과 같습니다.
PS C:\Users\Chirag.Nagarekar> help Get-Service -Parameter ComputerName -ComputerName <System.String[]> Gets the services running on the specified computers. The default is the local computer. Type the NetBIOS name, an IP address, or a fully qualified domain name (FQDN) of a remote computer. To specify the local computer, type the computer name, a dot (.), or localhost. This parameter does not rely on Windows PowerShell remoting. You can use the ComputerName parameter of Get-Service even if your computer is not configured to run remote commands. Required? false Position? named Default value None Accept pipeline input? True (ByPropertyName) Accept wildcard characters? false
모든 매개변수에 대한 도움말을 한 번에 보고 싶다면 매개변수 이름 대신 와일드카드 문자 *(애스터리스크)를 사용합니다.
help Get-Service -Parameter *
마찬가지로 명령줄에서 예제 섹션에 대한 도움말만 확인하고 싶다면 -Examples 매개변수를 사용하면 됩니다.
help Get-Service -Examples