# matlab (UNIX)

Start MATLAB program (UNIX platforms)

## Syntax

`matlab helpOptionmatlab envDispOptionmatlab archOptionmatlab dispOptionmatlab modeOptionmatlab `

**licensefilematlab**

`-c`**matlab**

`-debug`**debugger optionsmatlab**

`-D`**portnumbermatlab**

`-jdb`**filenamematlab**

`-logfile`**visualidmatlab**

`-mwvisual`**matlab**

`-noFigureWindows`**matlab**

`-nosplash`**matlab**

`-nouserjavapath`**"command"matlab**

`-r`

`-singleCompThread`## Description

`matlab` is a Bourne shell script that starts
the MATLAB executable on UNIX^{®} platforms. (In this document, `matlab` refers
to this script; MATLAB refers to the application program). Before
actually initiating the execution of MATLAB, this script configures
the run-time environment by:

Determining the MATLAB root folder

Determining the host machine architecture

Processing any command line options

Reading the MATLAB startup file,

`.matlab7rc.sh`Setting MATLAB environment variables

There are two ways in which you can control the way the `matlab` script
works:

By specifying command line options

By assigning values in the MATLAB startup file,

`.matlab7rc.sh`

### Specifying Options at the Command Line

/Applications/MATLAB_R2012b.app/bin/matlab To run the ./matlab -nojvm -nodisplay -nosplash -r "myfun(10,30)" |

Options that you can enter at the command line are as follows:

`matlab helpOption` displays
information that matches the specified `helpOption` argument
without starting MATLAB. `helpOption` can be
any one of the keywords shown in the table below. Enter only one `helpOption` keyword
in a `matlab` command.

`matlab envDispOption` displays
the values of environment variables passed to MATLAB or their
values just prior to exiting MATLAB. `envDispOption` can
be either one of the options shown in the table below.

Option | Description |
---|---|

| Display all the final values of the environment variables and arguments passed to the MATLAB executable as well as other diagnostic information. Does not start MATLAB. |

| Display |

`matlab archOption` starts MATLAB and
assumes that you are running on the system architecture specified
by `arch`, or using the MATLAB version specified
by `variant`, or both. The values for the `archOption` argument
are shown in the table below. Enter only one of these options in a `matlab` command.

Option | Description |
---|---|

| Run MATLAB assuming this architecture rather than
the actual architecture of the machine you are using. Replace the
term matlab -glnx86 |

| Execute the version of MATLAB found in the folder |

| Execute the version of MATLAB found in the folder with
strings representing a specific architecture and MATLAB version.variant |

`matlab dispOption` starts MATLAB using
one of the display options shown in the table below. Enter only one
of these options in a `matlab` command.

Option | Description |
---|---|

| Send X commands to X Window Server display On Macintosh platforms, this option is ignored. |

| Start the Oracle On Macintosh platforms, start the JVM in headless mode, and prevent all windows from being displayed. |

`matlab modeOption` starts MATLAB without
its usual desktop component. Enter only one of the options shown below.

Option | Description |
---|---|

| Allow the MATLAB desktop to be started by a process without a controlling terminal. This is usually a required command line argument when attempting to start MATLAB from a window manager menu or desktop icon. |

| Start MATLAB without
bringing up the MATLAB desktop. The JVM software |

| Start MATLAB without the JVM software. Use
the current window to enter commands. The MATLAB desktop does
not open. Any tools that require Java |

`matlab -c licensefile` starts MATLAB using
the specified license file. The

`licensefile`argument can have the form

`port@host`or it can be a colon-separated list of license filenames. This option causes the

`LM_LICENSE_FILE`and

`MLM_LICENSE_FILE`environment variables to be ignored.

`matlab -debug` starts MATLAB and
displays debugging information that can be useful, especially for
X based problems. This option should be used only when working with
a Technical Support Representative from The MathWorks, Inc.

`matlab -Ddebugger
options` starts MATLAB in debug mode, using the named

`debugger`(for example,

`dbx`,

`gdb`,

`xdb`,

`cvd`,

`lldb`). A full path can be specified for debugger.

The

`options`argument can include*only*those options that follow the debugger name in the syntax of the actual debug command. For most debuggers, there is a very limited number of such options. Options that would normally be passed to the MATLAB executable should be used as parameters of a command inside the debugger (like`run`). They should not be used when running the`matlab`script.If any other

`matlab`command options are placed before the`-D``debugger`argument, they will be handled as if they were part of the options after the`-D``debugger`argument and will be treated as illegal options by most debuggers. The`MATLAB_DEBUG`environment variable is set to the filename part of the debugger argument.To customize your debugging session, use a startup file. See your debugger documentation for details.

For certain debuggers like

`gdb`, the`SHELL`environment variable is*always*set to`/bin/sh`.

`matlab -jdb portnumber` starts MATLAB,
enabling use of the Java debugger. If you specify a port number,
the Java debugger uses that port to communicate with MATLAB.
You can specify any port number in the range 0-65535 that is not reserved
or currently in use by another application on your system. By default, MATLAB uses
port 4444. If you are running multiple MATLAB sessions and want
to use the Java debugger, be sure to specify a port number.

`matlab -logfile filename` starts MATLAB and
makes a copy of any output to the command window in file log. This
includes all crash reports.

`matlab -mwvisual visualid` starts MATLAB and
uses

`visualid`as the default X visual for figure windows.

`visualid`is a hexadecimal number that can be found using

`xdpyinfo`.

`matlab -noFigureWindows` starts MATLAB,
but disables the display of any figure windows in MATLAB.

`matlab -nosplash` starts MATLAB but
does not display the splash screen during startup.

`matlab -nouserjavapath` disables

`javaclasspath.txt`and

`javalibrarypath.txt`files.

`matlab -r "command"` starts MATLAB and
executes the specified MATLAB

`command`. Include the command in double quotation marks (

`"`). If

*"*`command``command`is the name of a MATLAB function or script, do not specify the file extension. Use semicolons or commas to separate multiple statements.

`matlab -singleCompThread` limits MATLAB to
a single computational thread. By default, MATLAB makes use of
the multithreading capabilities of the computer on which it is running.

### Specifying Options in the MATLAB Startup File

The `.matlab7rc.sh` shell script contains definitions
for a number of variables that the `matlab` script
uses. These variables are defined within the `matlab` script,
but can be redefined in `.matlab7rc.sh`. When invoked, `matlab` looks
for the first occurrence of `.matlab7rc.sh` in the
current folder, in the home folder `($HOME)`, and
in the `matlabroot``/bin` folder,
where the template version of `.matlab7rc.sh` is
located.

You can edit the template file to redefine information used
by the `matlab` script. If you do not want your changes
applied systemwide, copy the edited version of the script to your
current or home folder. Ensure that you edit the section that applies
to your machine architecture.

The following table lists the variables defined in the`.matlab7rc.sh` file.
See the comments in the `.matlab7rc.sh` file for
more information about these variables.

Variable Options for Startup File

Variable | Definition and Standard Assignment Behavior |
---|---|

| The machine architecture. The value |

| Linux The value of |

| Final Load library path. The name The final value is normally a colon-separated
list of four sublists, each of which could be empty. The first sublist
is defined in |

| The FLEX lm license variable. The license
file value passed with the Later
in the |

| The MATLAB root folder. The default
computed by the script is used unless Currently |

| Normally set to the name of the debugger. The |

| The path to the root of the Java Runtime Environment. The
default set in the script is used unless |

| The MATLAB search path. The final value
is a colon-separated list with the |

| The shell to use when the " Note that
an additional environment variable called Currently,
the shipping |

| Path of the toolbox folder. A nonempty value
in the environment is used first. Otherwise, |

| The X application resource folder (Linux systems only). A nonempty value in the environment
is used first unless |

| The X keysym database file (Linux systems only). A
nonempty value in the environment is used first unless |

The `matlab` script determines the path of
the MATLAB root folder by looking up the folder tree from the `matlabroot``/bin` folder
(where the `matlab` script is located). The `MATLAB` variable
is then used to locate all files within the MATLAB folder tree.

You can change the definition of `MATLAB` if,
for example, you want to run a different version of MATLAB or
if, for some reason, the path determined by the `matlab` script
is not correct. (This can happen when certain types of automounting
schemes are used by your system.)