mgc_doc_options.ini File Format

Input for: Siemens Software and Mentor Documentation System

Locaiton: Top of the docs, doc, or shared directory in the installed software tree.

Controls the location where the software looks for the documentation tree and the default PDF and HTML viewers.

Format

A mgc_doc_options.ini file must conform to the following restrictions:

Comments begin the line with the pound sign (#). If the line wraps, use an additional pound sign.

One line per variable.

# Comment line. 
MGC_ALT_DOC_PATH="<alternate_path>" 
MGC_HTML_BROWSER="<browser_executable_path>" 
MGC_PDF_READER="<viewer_executable_path>"

Parameters

MGC_ALT_DOC_PATH

Specifies an alternate location of the product documentation tree. The default location for the documentation directory is <install_dir>/docs | doc | shared. You set this variable to the full path of a valid Mentor documentation tree (docs | doc | shared) containing infohubs, htmldocs, and pdfdocs sub-directories. Do not include the directories: infohubs, htmldocs, or pdfdocs as part of the path value.

MGC_HTML_BROWSER

Specifies the web browser to use for displaying HTML documentation; used to override the default order of browser selection. The default browser is determined differently on Windows versus Linux.

Windows: Your default browser setting is determined from the registry. You set this variable to the full path of a supported web browser executable.
Linux: The PATH variable is searched for a browser using the following order: firefox, mozilla, and then netscape. You set this variable to either the full path of a supported web browser executable, or simply to the name of the browser executable (if it can be found with the Unix/Linux PATH variable).

MGC_PDF_READER

Specifies the PDF viewer to use for displaying PDF documentation when it is opened directly from the Mentor product. The default browser is determined differently on Windows versus Linux.

Windows: Your default PDF viewer (typically AcroRd32.exe) is determined from the registry. You set this variable to the full path of a PDF viewer.
Linux: The PATH variable is searched for a PDF viewer (typically acroread). You set this variable to either the full path of a supported PDF viewer executable, or simply to the name of the viewer executable (if it can be found with the Unix/Linux PATH variable).

Note:
The MGC_PDF_READER variable does not control the PDF viewer used from the InfoHub (Open PDF button). That viewer is controlled by the browser’s “helper application” settings.

Examples

Use the following examples to set the path to the alternate access location for the docs directory:

Windows
```
MGC_ALT_DOC_PATH="Z:\EEXV.2.7\docs"  
```

Linux/UNIX

MGC_ALT_DOC_PATH="/usr/local/mgc/EEXV.2.7/docs"

Web server

MGC_ALT_DOC_PATH="http://server1/EEXV.2.7/docs"

Use the following examples to set the default web browser for the Mentor HTML content:

Windows

MGC_HTML_BROWSER="C:\Program Files\Mozilla Firefox\firefox.exe"

Linux/UNIX

MGC_HTML_BROWSER="/usr/local/bin/firefox"