Documentation Environment Variables

Previous releases of the Siemens Software and Mentor Documentation System supported environment variables; however their use has changed.

The MGC_DOC_PATH environment variable was previously available at the OS level to set the location for the documentation system. The mgc_doc_options.ini file replaces this environment variable. For more information, refer to “Documentation Options”.

CAUTION:

This MGC_DOC_PATH environment variable should not be used because it will set the location for all installed documents, which exists in multiple software trees.

The MGC_HTML_BROWSER, and MGC_PDF_READER still function properly at the OS level, and can be set, if you are not using the mgc_doc_options.ini file.

  • MGC_HTML_BROWSER — Specifies the web browser to use for displaying HTML documentation and is used to override the default order of browser selection.

    • Windows: Your default browser setting is determined from the registry. You set this variable to the full path of a supported web browser executable. For example, set MGC_HTML_BROWSER to “C:\Program Files\Mozilla Firefox\firefox.exe”.

    • 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). For example, set MGC_HTML_BROWSER to “chromium”.

  • MGC_PDF_READER — Specifies the viewer to use for PDF documentation. You set this variable to the full path of the Acrobat executable. This variable replaces $MGC_HELP_VIEWER.

    • 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. For example, set MGC_PDF_READER to “C:\Program Files\Adobe\Acrobat 7.0\Reader\AcroRd32.exe”.

    • Linux: The PATH variable is searched for a PDF viewer (typically acroread). You set the MGC_PDF_READER 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). For example, set MGC_PDF_READER to “/opt/Acrobat7/bin/acroread”.

      Note:

      You can no longer download Adobe Reader for Linux; other third-party viewers are available. Third-party PDF viewers have different levels of search support, especially on Linux.