Main Content

Install Documentation on Offline Machines

Before You Begin

Note

This page contains an interactive user interface (UI) for downloading the documentation installation file. You must be using a computer connected to the internet and viewing this page on the web to follow this workflow.

In this procedure, you download a documentation ISO (Windows® and Linux®) or DMG (macOS) image and mount it. The documentation ISO or DMG image is several GB in size. If you do not feel comfortable or knowledgeable performing this procedure, contact your system administrator.

Downloading the documentation ISO or DMG file requires a bat365® Account. However, you do not need a bat365 Account to install the documentation on the offline machine. Therefore, an administrator with a bat365 Account can download the file and a colleague can install the documentation for MATLAB® users, even if the colleague is not a MATLAB user.

If you normally work with MATLAB while connected to the internet and only occasionally work offline, follow the procedure in Install Documentation Using Internet Connection.

Step 1. Download Documentation Installer

  1. On this page, select the operating system for the target offline machine and then click Download documentation.

    Sign in to download documentation

  2. When the download is complete, copy the documentation ISO or DMG image to the offline computer using removable media or a shared network location.

Step 2. Install Documentation on Target Machine

  1. On the target machine, mount the documentation ISO or DMG image using the standard process for your platform. For more details, see How do I install bat365 products using an ISO or DMG image?

  2. At the operating system command prompt, navigate to the folder within the mounted image that contains the documentation installer.

    cd mountedDocImage/bin/arch

    • mountedDocImage is the root of the mounted documentation ISO or DMG image.

    • arch is the operating system architecture folder of the ISO or DMG image, such as win64, glnxa64, maci64, or maca64.

  3. Run the documentation installer:

    mpm install-doc --matlabroot=matlabrootfolder

    matlabrootfolder is the folder where MATLAB is installed on the target machine.

    • Windows example:

      Here, MATLAB is installed in the folder "C:\Program Files\MATLAB\R2023b". Precede the mpm command with the path to the current folder (.\). If the matlabrootfolder path includes spaces, enclose the path in double quotes.

      .\mpm install-doc --matlabroot="C:\Program Files\MATLAB\R2023b"

    • Linux or macOS example:

      Here, MATLAB is installed in the folder /home/username/matlab for user jomalley. Precede the mpm command with the path to the current folder (./).

      ./mpm install-doc --matlabroot=/home/jomalley/matlab

    By default, MATLAB installs documentation in the support package root folder. To find the support package root, use the function matlabshared.supportpkg.getSupportPackageRoot (MATLAB).

    To specify a different location for the documentation, use the --destination flag. If you mount the documentation ISO/DMG image in a location other than where MATLAB is installed, for example, a network drive, use the --source flag to provide the complete path to the installer files:

    mpm install-doc --matlabroot=matlabrootfolder --source=docinstallfolder --destination=destinationfolder

    Note

    • If you run this command before you install MATLAB, you get an error. Install MATLAB first, and then you can install the documentation.

    • If you run this command in a release earlier than R2023a, you get an error.

  4. Unmount the documentation ISO or DMG. If you need to reclaim the disk space, delete the image.

  5. If you used the --destination flag to install the documentation somewhere other than the default location, go to Step 3 to modify the startup file.

    Otherwise, restart MATLAB to complete documentation setup.

Step 3. Point MATLAB to Documentation

If you used the --destination flag to install the documentation somewhere other than the default location, follow this procedure to point MATLAB to the documentation.

  1. On the offline computer, open the startup.m file for editing.

  2. In your startup.m file, add this line to set the documentation root to the new documentation location, where newDocInstallFolder is the path to the folder where you installed the documentation:

    docroot('newDocInstallFolder/help')

  3. Restart MATLAB to complete documentation installation.

After Installation

Access the documentation as you normally would. If MATLAB still tries to open documentation on the web, go to the Home tab, and in the Environment section, click Preferences and select MATLAB > Help. Under Documentation Location, select Installed locally.

Notes

  • To revert back to documentation on the web, go to the Home tab, and in the Environment section, click Preferences and select MATLAB > Help. Under Documentation Location, select Web, on bat365.

  • For multiple computers, repeat this offline procedure as many times as you have computers that need documentation installed. For machines that are normally connected to the internet, see Install Documentation Using Internet Connection.

  • To update installed documentation after adding or removing products, or to make sure you have the most recent documentation, repeat this procedure.

Related Topics