다음을 통해 공유

호환 가능한 도움말 개요

  • 아티클

이 문서에서는 PowerShell 업데이트 가능 도움말 기능의 디자인 및 작업에 대한 기본 소개를 제공합니다. 모듈 작성자 및 사용자에게 Windows PowerShell 도움말 항목을 제공하는 다른 사용자를 위해 설계되었습니다.

소개

PowerShell 도움말 항목은 PowerShell 환경의 필수적인 부분입니다. PowerShell 모듈과 마찬가지로 작성자와 PowerShell 사용자 커뮤니티의 기여에 따라 도움말 항목이 지속적으로 업데이트되고 개선됩니다.

Windows PowerShell 3.0에서 도입된 업데이트할 수 있는 도움말 기능을 사용하면 새 모듈을 다운로드하거나 Windows 업데이트를 실행하지 않고도 기본 제공 PowerShell 명령에 대해서도 명령 프롬프트에서 최신 버전의 도움말 항목을 사용할 수 있습니다. 업데이트 가능한 도움말은 인터넷에서 최신 버전의 도움말 항목을 다운로드하고 사용자의 로컬 컴퓨터의 올바른 하위 디렉터리에 설치하는 cmdlet을 제공하여 간단하게 업데이트할 수 있습니다. 방화벽 뒤에 있는 사용자도 새 cmdlet을 사용하여 내부 파일 공유에서 업데이트된 도움말을 얻을 수 있습니다.

업데이트 가능한 도움말은 Windows 8 및 Windows Server 2012의 모든 Windows PowerShell 모듈에서 완벽하게 지원되며, 해당 기능은 모든 Windows PowerShell 모듈 작성자가 사용할 수 있습니다. 최신 도움말은 XML 기반 도움말 파일만 지원합니다. 주석 기반 도움말은 지원하지 않습니다.

업데이트할 수 있는 도움말에는 다음 기능이 포함되어 있습니다.

  • Update-Help cmdlet은 사용자가 모듈에 대한 최신 도움말 파일을 가지고 있는지 여부를 결정하고, 그렇지 않은 경우 인터넷에서 최신 도움말 파일을 다운로드하고, 압축을 풀고, 사용자 컴퓨터의 올바른 모듈 하위 디렉터리에 설치합니다. 사용자는 Get-Help cmdlet을 사용하여 새로 설치된 도움말 항목을 즉시 볼 수 있습니다. PowerShell을 다시 시작할 필요가 없습니다.

  • Save-Help cmdlet은 인터넷에서 최신 도움말 파일을 다운로드하고 파일 시스템 디렉터리에 저장합니다. 사용자는 Update-Help cmdlet을 사용하여 파일 시스템 디렉터리에서 도움말 파일을 가져와서 압축을 풀고 사용자 컴퓨터의 모듈 하위 디렉터리에 설치할 수 있습니다. Save-Help cmdlet은 인터넷 액세스가 제한되거나 없는 사용자와 인터넷 액세스를 제한하려는 기업을 위해 설계되었습니다.

  • 모듈 대한도움말입니다. 모듈에 대한 도움말 파일은 관리되고 한 단위로 전달되므로 사용자는 사용하는 모듈에 대한 모든 도움말 파일을 가져올 수 있습니다. 업데이트 가능한 도움말은 Windows PowerShell 스냅인이 아닌 모듈에 대해서만 지원됩니다.

  • 버전 지원. Updatable Help는 표준 4위(N1)를 사용합니다. N2. N3. N4) 버전 번호입니다. 업데이트할 수 있는 도움말은 사용자 컴퓨터 또는 Save-Help 디렉터리에 있는 도움말 파일의 버전 번호가 인터넷 위치에 있는 도움말 파일의 버전 번호보다 낮은 경우 도움말 파일을 다운로드합니다.

  • 다중 언어 지원 . Updatable Help는 여러 UI 문화권의 모듈 도움말 파일을 지원합니다. 업데이트할 수 있는 도움말 파일 이름에는 "en-US" 및 "ja-JP"와 같은 표준 언어 코드가 포함되며, Update-Help 및 Save-Help cmdlet은 도움말 파일을 모듈 디렉터리의 언어별 하위 디렉터리에 배치합니다.

  • 자동 생성된 도움말 . Get-Help cmdlet은 도움말 파일이 없는 명령에 대한 기본 도움말을 표시합니다. 자동 생성된 도움말에는 명령 구문과 별칭, 온라인 도움말 및 업데이트 가능한 도움말을 사용하기 위한 지침이 포함됩니다.

  • 고급 온라인 도움말. 온라인 도움말에 쉽게 액세스할 수 있으면 더 이상 도움말 파일이 필요하지 않습니다. 이제 Get-Help cmdlet의 Online 매개 변수는 도움말 파일에서 온라인 도움말 URL을 찾을 수 없는 경우 모든 명령의 HelpUri 속성 값에서 온라인 도움말 항목의 URL을 가져옵니다. cmdlet, 함수 및 CIM 명령 코드에 HelpUri 특성을 추가하거나 워크플로 및 스크립트에서 .LINK 주석 기반 도움말 키워드를 사용하여 HelpUri 속성을 채울 수 있습니다.

    도움말 파일을 업데이트할 수 있도록 Windows의 Windows PowerShell 모듈에는 도움말 파일이 제공되지 않습니다. 사용자는 업데이트 가능한 도움말을 사용하여 도움말 파일을 설치하고 업데이트할 수 있습니다. 다른 모듈의 작성자는 모듈에 도움말 파일을 포함하거나 생략할 수 있습니다. Updatable 도움말에 대한 지원은 선택 사항이지만 권장됩니다.