Contact Info

Crumbtrail

ActiveXperts.com » Administration » Powershell » Powershell 3.0 » Save-Help

Save-Help - Powershell 3.0 CmdLet

ActiveXperts Network Monitor ships with integrated Powershell scripts to monitor complex network. The scripts run out of the box
Download the ActiveXperts Network Monitor FREE version now »

Save-Help

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

Syntax
Save-Help [-DestinationPath] <String[]> [[-Module] <String[]>] [[-UICulture] <CultureInfo[]>] [-Credential <PSCredentia
l>] [-Force] [-UseDefaultCredentials] [<CommonParameters>]
Save-Help [[-Module] <String[]>] [[-UICulture] <CultureInfo[]>] [-Credential <PSCredential>] [-Force] [-UseDefaultCrede
ntials] -LiteralPath <String[]> [<CommonParameters>]





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 a
re  installed on the computer in a location listed in the PSModulePath environment variable. Modules that do not suppor
t 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 ava
ilable, it downloads the newest help files from the Internet and saves them in the directory. The Save-Help cmdlet work
s 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 th
e help files each UI culture. You do not need to extract the help files from the cabinet file. The Update-Help cmdlet e
xtracts 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 Po
werShell with the "Run as administrator" option. You must be a member of the Administrators group on the computer to do
wnload the help files for these modules.


This cmdlet is introduced in Windows PowerShell 3.0.