Main Content

Specify Startup Options

Startup Options from Operating System Prompt

Startup options instruct MATLAB® to perform certain operations when you start the program. Startup options also are called command flags or command-line switches. When you start at the operating system prompt, specify the options as arguments to the matlab command. For example, the following limits MATLAB to a single computational thread for numerical computations.

matlab -singleCompThread

On Windows® platforms, you can precede a startup option with either a hyphen (-) or a slash (/). For example, -singleCompThread and /singleCompThread are equivalent.

Startup Options in Shortcut on Windows Systems

You can add selected startup options to the target path for your shortcut on the Windows platform for MATLAB.

To use startup options for the MATLAB shortcut icon, follow these steps:

  1. Right-click the shortcut icon for MATLAB and select Properties from the context menu. The Properties dialog box for MATLAB opens to the Shortcut pane.

  2. In the Target field, after the target path for "matlab.exe", add the startup option, and click OK.

This example runs the MATLAB results script or function after startup, where results.m is in the startup folder or on the MATLAB search path. The text in the Target field is similar to the following:

"C:\Program Files\MATLAB\R2016b\bin\matlab.exe" -r "results"

Include the statement, but not the option (-r) in double quotation marks.

Use semicolons or commas to separate multiple statements. This example changes the format to short, and then runs the MATLAB code file results:

"... matlab.exe" -r "format('short');results"

Separate multiple options with spaces. This example starts MATLAB without allowing the JVM® software to be loaded in the session, and then runs the MATLAB code file results:

"... matlab.exe" -nojvm -r "results"

Startup Options in MATLAB Startup File

The startup.m file is a file you create to specify startup options. Create the startup.m file in a folder on the MATLAB search path. Use startup.m to modify the default search path, predefine variables in your workspace, or define defaults for graphics objects. For example, the following statement adds the user-defined folder /home/myname/mytools to the search path.

addpath /home/myname/mytools

To change the current folder on startup to mytools, set the Initial working folder value, located in the General Settings options in the Settings window:

/home/myname/mytools

At startup, MATLAB automatically executes the matlabrc.m file and startup.m, if it exists on the MATLAB search path. The file matlabrc.m, which is in the matlabroot/toolbox/local folder, is reserved for use by MathWorks® and by system administrators on multiuser systems. To locate the startup.m file, type:

which startup

If MATLAB finds a startup.m file, then it displays the path to the file.

Note

MATLAB executes the first file on the search path named startup that has an executable file extension. Examples of an executable file extension are .m, .mlx, and .mlapp.

Passing Perl Variables on Startup

You can pass Perl variables to MATLAB on startup by using the -r option of the matlab function. For example, assume a MATLAB function test that takes one input variable:

function test(x)

To pass a Perl variable instead of a constant as the input parameter, follow these steps. This command starts MATLAB and runs test with the input argument 10.

  1. Create a Perl script such as

     #!/usr/local/bin/perl
     $val = 10; 
     system('matlab -r "test(' . ${val} . ')"');

  2. Invoke the Perl script at the prompt using a Perl interpreter.

For more information, see the -r option in matlab (Windows), matlab (macOS), or matlab (Linux).

Startup and Calling Java Software from MATLAB

When MATLAB starts, it constructs the class path for Java® software using javaclasspath.txt and javalibrarypath.txt files. For more information, see Java Class Path and Locate Native Method Libraries.

For information about memory allocation for Java objects, see Java Runtime Environment Settings.

Common Startup Options

This table lists commonly used startup options for the matlab command. For a complete list of options, refer to the input arguments for matlab (Windows), matlab (macOS), or matlab (Linux).

Option

Description

-c license

License to use, specified as the full path to a license file, a list of license file paths, or the port@host address of a license server. Separate multiple paths with a semicolon (Windows) or colon (Linux®, macOS).

Licenses specified in the -c option override all other licenses, including ones set in environment variables or stored in other folders. For more details, see MATLAB License Search Path.

-h or -help

Display startup options (without starting MATLAB).

-logfile "logfilename"

Automatically write output from MATLAB to the specified log file.

-nojvm

Start MATLAB without allowing the JVM software to be loaded in the session. Features that require Java software are not supported.

Before R2025a: Desktop tools and graphics not supported when MATLAB is started using the -nojvm startup option. In addition, -nojvm is not supported on Windows systems.

-batch "statement"

Run the specified statement non-interactively.

-r "statement"

Run the specified statement interactively.

-singleCompThread

Limit MATLAB to a single computational thread. This option is for numerical computations only.

On Windows systems, this option uses the multithreading capabilities of the computer on which it is running by default.

See Also

| |

Topics