Skip to content

Commit a8e8f4b

Browse files
authored
Merge pull request #5653 from ghogen/help-viewer-docs
help viewer catalog name for VS 2019
2 parents 96bc9e7 + 2fb86b3 commit a8e8f4b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/help-viewer/command-line-arguments.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,17 @@ For example:
3333
hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us /sourceuri d:\productDocumentation\HelpContentSetup.msha
3434
```
3535

36+
>[!NOTE]
37+
> The catalog name is VisualStudio15 for both Visual Studio 2017 and Visual Studio 2019. This might be unexpected, but this is because the same Help Viewer is used for both Visual Studio versions.
38+
3639
## Switches and arguments
3740

3841
The following table defines the switches and arguments that you can use for the command-line tool for Help Content Manager:
3942

4043
|Switch|Required?|Arguments|
4144
|------------|---------------|---------------|
4245
|/operation|Yes|- **Install**--Adds books from the specified installation source to the local content store.<br /> This switch requires the /booklist argument, the /sourceURI argument, or both. If you don't specify the /sourceURI argument, the default Visual Studio URI is used as the installation source. If you don't specify the /booklist argument, all books on the /sourceUri are installed.<br />- **Uninstall**--Removes the books that you specify from the local content store.<br /> This switch requires the /booklist argument or the /sourceURI argument. If you specify the /sourceURI argument, all books are removed, and the /booklist argument is ignored.<br />- **Move**--Moves the local store to the path that you specify. The default local store path is set as a directory under *%ProgramData%*<br /> This switch requires the /locationPath and /catalogName arguments. Error messages will be logged in the event log if you specify a path that isn't valid or if the drive doesn't contain enough free space to hold the content.<br />- **Refresh**--Updates topics that have changed since they were installed or most recently updated.<br /> This switch requires the /sourceURI argument.|
43-
|/catalogName|Yes|Specifies the name of the content catalog.|
46+
|/catalogName|Yes|Specifies the name of the content catalog. For Visual Studio 2017 and Visual Studio 2019, this is VisualStudio15.|
4447
|/locale|No|Specifies the product locale that's used to view and manage content for the current instance of the Help viewer. For example, you specify `EN-US` for English-United States.<br /><br /> If you don't specify a locale, the locale of the operating system is used. If that locale can't be determined, `EN-US` is used.<br /><br /> If you specify a locale that isn't valid, an error message is logged in the event log.|
4548
|/e|No|Elevates the Help Content Manager to Administrative privileges if the current user has administrative credentials.|
4649
|/sourceURI|No|Specifies the URL from which content is installed (Service API) or the path to the content installation file (*.msha*). The URL can point to the Product Group (top-level node) or to the Product Books (leaf-level node) in a Visual Studio 2010 style endpoint. You don't need to include a slash (/) at the end of the URL. If you do include a trailing slash, it will be handled appropriately.<br /><br /> An error message is logged in the event log if you specify a file that isn't found, isn't valid, or isn't accessible or if a connection to the internet isn't available or is interrupted while content is being managed.|

0 commit comments

Comments
 (0)