HOME > Help系コマンドレット > Save-Help
Save-Help
Save-Helpは、ヘルプを保存するコマンドです。
エイリアスなし
解説
PowerShellモジュールの最新のヘルプファイルをダウンロードしてファイルに保存します。
インターネットにアクセスできないコンピューターや、
複数のコンピューターにヘルプファイルを更新する場合に便利です。
構文
- （構文）
- Save-Help [-DestinationPath] <string[]> [[-Module] <psmoduleinfo[]>] [[-UICulture] <cultureinfo[]>] [<CommonParameters>] Save-Help [[-Module] <psmoduleinfo[]>] [[-UICulture] <cultureinfo[]>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -DestinationPath パス | ヘルプファイルを保存するディレクトリのパスを指定する （例） Save-Help -DestinationPath "C:\PSHelp" |
| -LiteralPath パス | 対象パスを指定する（ワイルドカード使用不可） （例）-LiteralPath "D:\test" |
| -Module | ヘルプファイルを保存する特定のモジュールを指定する ※複数のモジュールを指定することも可 （例） Save-Help -Module DnsClient, NetTCPIP |
| -FullyQualifiedModule モジュール | 特定のモジュールのヘルプファイルをダウンロードする |
| -UICulture | ヘルプファイルのユーザーインターフェイスカルチャを指定する ※デフォルトは現在のカルチャ （例）Save-Help -UICulture ja-JP |
| -Credential 資格情報 | 資格情報を指定する （例）Save-Help -Credential (Get-Credential) |
| -UseDefaultCredentials | 現在のユーザーの資格情報を使用して認証を行う |
| -Force | 強制的に実行する |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
DnsClientモジュールの最新のヘルプファイルをダウンロードしてC:\PSHelpディレクトリに保存する
Save-Help -DestinationPath "C:\PSHelp" -Module DnsClient
すべてのモジュールのヘルプファイルを保存する
Save-Help -DestinationPath "C:\PSHelp"
特定のカルチャのヘルプファイルを保存する
Save-Help -DestinationPath "C:\PSHelp" -Module DnsClient -UICulture ja-JP
コマンドのヘルプを表示する
Get-Help Save-Help
備考
- Save-Helpコマンドレットは同じモジュールのヘルプを24時間に1回しかダウンロードできません。
この制限を無視してダウンロードしたい場合は-Forceパラメータを使用してください。
関連項目
- Help系コマンドレット
- Get-Help：ヘルプを表示する
- Save-Help：ヘルプを保存する
- Update-Help：ヘルプを更新する
