Home ›
PowerShell入門

Update-Helpの使い方：ヘルプファイルを最新に更新する

広告

PowerShell では Get-Help コマンドレットを使ってコマンドの使い方を調べることができます。しかし、初期状態ではヘルプの内容が最新ではない場合があります。 Update-Help コマンドレットを使用すると、最新のヘルプファイルを取得してローカルの情報を更新できます。ここでは PowerShell における Update-Help コマンドレットの使い方について解説します。

目次

Update-Helpコマンドレットの書式
特定の言語のヘルプを更新する

Update-Helpコマンドレットの書式

Update-Help コマンドレットは、最新のヘルプファイルを取得してローカルの情報を更新するために使用します。 Update-Help コマンドレットの書式は次の通りです。

Update-Help
  [[-Module] <String[]>]
  [[-SourcePath] <String[]>]
  [[-UICulture] <CultureInfo[]>]
  [-FullyQualifiedModule <ModuleSpecification[]>]
  [-Recurse]
  [-Credential <PSCredential>]
  [-UseDefaultCredentials]
  [-Force]
  [-Scope <UpdateHelpScope>]
  [-WhatIf]
  [-Confirm]
  [<CommonParameters>]

Update-Help を実行することで Get-Help コマンドレットを実行したときに表示される内容が最新のものになります。

Update-Help を実行する場合は、管理者権限で PowerShell を起動してください（通常の権限では更新できない場合があります）。

Update-Helpコマンドレットの使い方(1)

次のように実行してください。

Update-Help

最新のヘルプファイルを取得して更新します。

Update-Helpコマンドレットの使い方(2)

最後に次のように表示され、更新できなかったファイルの一覧などが表示されます。更新できなかったファイルが表示される場合がありますが、対象のヘルプが提供されていないことなどが原因であることが多く、通常は問題ありません。

Update-Helpコマンドレットの使い方(3)

なお Update-Help は、同じモジュールに対して 24 時間に 1 回までしか実行できません。この制限を解除して実行するには -Force オプションを指定して実行してください。

Update-Help -Force

特定の言語のヘルプを更新する

ヘルプファイルは言語ごとに用意されています。（実際のところは日本語のヘルプファイルはあまり用意されていないので、基本的に英語のヘルプページが表示されます）。

特定の言語のヘルプファイルを取得するには -UICulture オプションを指定します。

Update-Help -UICulture 言語

英語を指定する場合は en-US 、日本語を指定する場合は ja-JP を指定します。

それでは英語を指定して実行してみます。

Update-Help -UICulture en-US

Update-Helpコマンドレットの使い方(4)

次に日本語を指定して実行してみます。

Update-Help -UICulture ja-JP

Update-Helpコマンドレットの使い方(5)

Update-Helpコマンドレットの使い方(6)

このように、言語を指定してヘルプファイルを更新することができます。

-- --

PowerShell における Update-Help コマンドレットの使い方について解説しました。

( Written by Tatsuo Ikura )

プロフィール画像

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。