Documentation Options

Merged Siemens Software and Mentor applications support a set of variables that control different aspects of your access to the Siemens Software and Mentor Documentation System. These documentation variables control the default HTML browser and the default PDF reader.

For some releases, an alternate location of the documentation tree is supported. For example, you can copy the documentation tree from your software tree to another location (such as to a web server that is internal to your company’s network), and then use a documentation variable to specify that location.

To use the documentation options and variables, you specify them in the mgc_doc_options.ini file, mgc_viewer_config.ini file, or the system level environment variables. You must create these files and place them in specific locations.

mgc_doc_options.ini

Controls the options for the specific documentation tree and software install. It is located at the top of the docs, doc, or shared directory in the installed software tree. The mgc_doc_options.ini file specifies where the software finds the documentation and which PDF and HTML viewer to use. This file is optional, and any of the three variables is optional. The file uses the following format:

# Comment line.
MGC_ALT_DOC_PATH=”alternate_path”
MGC_HTML_BROWSER=”browser_executable_path”
MGC_PDF_READER=”viewer_executable_path
mgc_viewer_config.ini

Controls the default viewer options for all merged products that use the Siemens Software and Mentor documentation trees. It is located in C:\users\<username>\AppData\Local\MentorGraphics\ on Windows and /home/<username>/ on Linux. The mgc_viewer_config.ini file (.mgc_viewer_config.ini on Linux) defines only the PDF and HTML viewers that the software uses. This file enables you to specify different viewers from those defined for an entire organization in the mgc_doc_options.ini file that is located in the software tree. The viewers that you specify in the mgc_viewer_config.ini file also override the viewers that your system uses for .pdf and .html file-type associations.

This file cannot specify where the software finds an alternative documentation tree. You define that location in the mgc_doc_options.ini file.

The mgc_viewer_config.ini file uses the following format:

# Comment line.
MGC_HTML_BROWSER=”browser_executable_path”
MGC_PDF_READER=”viewer_executable_path
environment variables

Controls the default viewer options for all merged products of Siemens Software and Mentor documentation trees. Previous releases of the Siemens Software and Mentor Documentation System supported environment variables; however their use has changed. The preferred method is to use the mgc_viewer_config.ini file.