Documentation‎ > ‎

VS 11 Help Content Manager

posted Nov 13, 2011, 5:11 AM by Robert Chandler   [ updated Nov 27, 2012, 5:06 AM ]
The Help Content Manager for VS 11 (VS 2012) is used to add and remove content to/from a catalog. It has a command line interface.
Note that Windows 8 uses its own closed system. For Installing Windows 8 help see the appropriate Windows SDK.

C:\Program Files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Content Manager GUI (formally HelpLibManager.exe in HV1) is now integrated into the VS 11 Help viewer window.
Note that Windows 8 help does not have an open content manager. Windows 8 help do their own thing (using custom update code).

Use /? or /help to access command line art help.

Note: 

The following is from VS 11 RTM -- HlpCtntMgr.exe /?
Red text is extra notes that I've added.
Microsoft(R) Help Content Manager
Copyright (C) Microsoft Corporation. All rights reserved.

Description: Runs the Help Content Manager application to install, remove,
move, or update documentation.

To install content:

    HlpCtntMgr.exe /operation install /catalogName <catalog name>
    /locale <language-country/region> [/options]

    Required parameters: /operation, /catalogName, /locale
    Options: /sourceUri, /skuid, /membership, /booklist, /vendor, /productName,
    /silent
    Content filters: /locale, /membership, /booklist, /vendor, /productName
    Example: HlpCtntMgr.exe /operation install /catalogName VisualStudio11
    /locale en-US /skuId 3000 /booklist "Spec Explorer" "Dynamic AX"
    /sourceUri D:\binData\Documentaion\Dev11\SmallSet\helpcontentsetup.msha

To remove (uninstall) content:

    HlpCtntMgr.exe /operation uninstall /catalogName <catalog name>
    /locale <language-country/region> [/options]

    Required parameters: /operation, /catalogName, /locale
    Options: /sourceUri, /skuid, /membership, /booklist, /vendor, /productName,
    /silent
    Example: HlpCtntMgr.exe /operation uninstall /catalogName VisualStudio11
    /locale fr-FR /skuId 3000 /booklist "Visual C#" "Visual C++" "Help on Help"

To update content:

    HlpCtntMgr.exe /operation refresh /catalogName <catalog name>
    /locale <language-country/region> [/options]

    Required parameters: /operation, /catalogName, /locale
    Options: /sourceUri
    Example: HlpCtntMgr.exe /operation refresh /catalogName VisualStudio11
    /locale ja-JP

To move content:

    HlpCtntMgr.exe /operation move /catalogName <catalog name>
    /locationPath <destination file path>

    Required parameters: /operation, /catalogName, /locationPath

    Example: HlpCtntMgr.exe /operation move /catalogName VisualStudio11
    /locationPath D:\NewContentStore\VS11


Required Parameters:

    /operation <install|uninstall|refresh|move>
        Specifies the content operation to perform.

    /catalogName <catalog name>
        Specifies the product documentation catalog to install, uninstall,
        refresh, or move. Normally is "VisualStudio11". To use your own catalogs 
        you must first register the catalog name (see Catalogs).

    /locale <language-country/region>
        Use for install, uninstall, and refresh operations.
        Specifies the culture name (language and country/region) of the product
        documentation to install, uninstall, or refresh.
        For example, specify /locale en-us for English (United States).

    /locationPath <destination file path>
        Use only for move operations.
        Specifies the location to use for documentation.
        This parameter must be specified when the /silent parameter is being
        used.

Options:

    /sourceUri <source>
        Use for install, uninstall, and refresh operations.
        Specifies the content source. This can be an .msha file or a service
        endpoint URL. If omitted, the Visual Studio service endpoint is used.

    /skuid <SKU ID>
        Use for install and uninstall operations.
        Filters the booklist on the given SKU ID.
        See the Help Viewer administrator's guide for the list of SKU IDs.

    /membership <minimum|recommended|full>
        Use for install operations.
        Filters the booklist by the given content scope (minimum set of books,
        recommended books, or all available books).

    /booklist <list of book description files>
        Use for install and uninstall operations.
        Specifies the list of book names to install or uninstall. Use double
        quotation marks (") if the book name includes spaces (for example,
        "Visual C#"), and use a blank space to separate books.
        For install operations, if /booklist is not supplied, all books found
        on the /sourceURI will be installed.
        For uninstall operations, if /sourceUri is supplied, all books found
        on the /sourceURI will be uninstalled and the /booklist parameter is
        ignored.

    /vendor <vendor name>
        Use for install and uninstall operations, with the /booklist parameter.
        Specifies the vendor that created the books to install or uninstall.
        If omitted, defaults to "Microsoft".
        So for all of outside Microsoft this is a Required Parameter.

    /productName <product name>
        Use for install and uninstall operations, with the /booklist parameter.
        Specifies the product name associated with the books to install or
        uninstall.
        This parameter should not be used for the Visual Studio 11 service
        endpoint. It is provided for backward compatibility with the
        Visual Studio 2010 service endpoint.
        This parameter is required if you specify /booklist.

    /silent
        Use for all operations.
        Specifies that no graphical UI should be displayed when installing,
        removing, updating, or moving content. See the Help Viewer
        administrator's guide for information about error codes returned during
        silent mode.
        To specify this parameter, you must run HlpCtntMgr.exe from an elevated
        Command Prompt window. Otherwise, it will fail.

    /wait <seconds>
        Use for install, uninstall, and refresh operations.
        If an operation is already in progress for the catalog the process will
        wait up to the given number of seconds to continue.
        Use 0 to wait infinitely.

    /LaunchingApp
        Defines the application and catalog context when the Help viewer is launched without the parent application. 
               The arguments for this switch are CompanyName, ProductName, and VersionNumber (for example, /launchingApp Microsoft,VisualStudio,11.0).

    /e 
        
        Elevates Help Content Manager to administrator mode. 
        Required for installation
    /?
        Lists the switches and their descriptions for the command-line tool for Help Content Manager.

Press any key to continue...




Tips

/vendor 

If /vendor is omitted from the command line HlpCtntMgr assumes Microsoft. Assuming your MSHA file has no Microsoft books in it then this list will be empty and cause a cryptic error like "The specified content does not exist or is unreadable.". 

/catalogName

By default HlpCtntMgr.exe accepts a catalogName = "VisualStudio11". To use other catalogNames you will need to register them first otherwise you will get an error like "The specified content does not exist or is unreadable.".  See the catalogs section for more info.