PowerShell Logo Small

Save-Help



This is the built-in help made by Microsoft for the command 'Save-Help', in PowerShell version 3 - as retrieved from Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Downloads and saves the newest help files to a file system directory.

SYNTAX


Save-Help [-DestinationPath] <String[]> [[-Module] <String[]>] [[-UICulture] <CultureInfo[]>] [-Credential <PSCredential>] [-Force]
[-UseDefaultCredentials] [<CommonParameters>]
Save-Help [[-Module] <String[]>] [[-UICulture] <CultureInfo[]>] [-Credential <PSCredential>] [-Force] [-UseDefaultCredentials] -LiteralPath
<String[]> [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Save-Help cmdlet downloads the newest help files for Windows PowerShell modules and saves them to a directory that you specify. This
feature allows you to update the help files on computers that do not have access to the Internet and makes it easier to update the help files
on multiple computers.


To install the saved help files, use the Update-Help cmdlet. Use its SourcePath parameter to specify the directory in which you saved the
Help files.


Without parameters, a Save-Help command downloads the newest help for all modules in the session and for modules that are installed on the
computer in a location listed in the PSModulePath environment variable. Modules that do not support Updatable Help are skipped without warning.


The Save-Help cmdlet checks the version of any help files in the destination directory and, if newer help files are available, it downloads
the newest help files from the Internet and saves them in the directory. The Save-Help cmdlet works just like the Update-Help cmdlet, except
that it saves the downloaded cabinet (.cab) files in a directory, instead of extracting the help files from the cabinet files and installing
them on the computer.


The saved help for each module consists of one help information (HelpInfo XML) file and one cabinet (.cab) file for the help files each UI
culture. You do not need to extract the help files from the cabinet file. The Update-Help cmdlet extracts the help files, validates the XML
for safety, and then installs the help files and the help information file in a language-specific subdirectory of the module directory.


To save the help files for modules in the Windows PowerShell installation directory ($pshome\Modules), start Windows PowerShell with the "Run
as administrator" option. You must be a member of the Administrators group on the computer to download the help files for these modules.


This cmdlet is introduced in Windows PowerShell 3.0.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=210612
Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)
Get-Culture
Get-Help
Get-Module
Get-UICulture
Update-Help

REMARKS

<

Examples


Example 1: Save help for all modules

PS C:\>Save-Help –DestinationPath \\Server01\FileShare01



This command downloads the newest help files for all modules in the UI culture set for Windows on the local computer. It saves the help files
in the \\Server01\Fileshare01 directory.




Example 2: Save help for a module on the computer

PS C:\>Save-Help –Module ServerManager -DestinationPath \\Server01\FileShare01 -Credential Domain01/Admin01



This command downloads the newest help files for the ServerManager module and saves them in the \\Server01\Fileshare01 directory.

When a module is installed on the computer, you can type the module name as the value of the Module parameter, even if the module is not
imported into the current session.

The command uses the Credential parameter to supply the credentials of a user who has permission to write to the file share.




Example 3: Save help for a module on a different computer

PS C:\>Invoke-Command –ComputerName Server02 {Get-Module –Name CustomSQL –ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01
-Credential Domain01\Admin01



These commands download the newest help files for the CustomSQL module and save them in the \\Server01\Fileshare01 directory.

Because the CustomSQL module is not installed on the computer, the sequence includes an Invoke-Command command that gets the module object for
the CustomSQL module from the Server02 computer and then pipes the module object to the Save-Help cmdlet.

When a module is not installed on the computer, Save-Help needs the module object, which includes information about the location of the newest
help files.




Example 4: Save help for a module in multiple languages

PS C:\>Save-Help –Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath D:\Help



This command saves help for the Windows PowerShell Core modules in four different UI cultures. The language packs for these locales do not
need to be installed on the computer.

Save-Help can download help files for modules in different UI cultures only when the module owner makes the translated files available on the
Internet.




Example 5: Save help more than once each day

PS C:\>Save-Help –Force –DestinationPath \\Server3\AdminShare\Help



This command saves help for all modules that are installed on the computer. The command uses It uses the Force parameter to override the rule
that prevents the Save-Help cmdlet from downloading help more than once in each 24-hour period.

The Force parameter also overrides the 1 GB restriction and circumvents version checking, so you can download files even if the version is not
greater than the version in the destination directory.

The command uses the Save-Help cmdlet to download and save the help files to the specified directory. The Force parameter is required when you
need to run a Save-Help command more than once each day.