Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.32 KB

README.org

File metadata and controls

109 lines (68 loc) · 3.32 KB
Raw

Emacs MATLAB-mode

MathWorks MATLAB® and GNU Emacs integration:

  1. matlab-mode for editing *.m files.
    • Edit MATLAB code with syntax highlighting and smart indentation.
    • Lint MATLAB code with fix-it’s using the MATLAB Code Analyzer.
  2. M-x matlab-shell for running and debugging MATLAB within Emacs (Unix-only).
    • matlab-shell uses company-mode for completions.
  3. tlc-mode for editing *.tlc files. The Target Language Compiler (TLC) part of Simulink® Coder™.

Installation

Install via MELPA

Installing via MELPA is recommended because MELPA will contain the latest validated release.

Add to your ~/.emacs:

(add-to-list 'package-archives '("melpa" . "http://melpa.org/packages/") t)

then run

M-x RET package-list-packages RET

Install from this repository

Build:

cd /path/to/Emacs-MATLAB-mode

# Build lisp and run tests (requires MATLAB executable):
make
# Alternatively, build lisp and run tests using a specific MATLAB executable:
make MATLAB_EXE=/path/to/matlab

# If desired, you can separate the building of lisp and running tests using:
make lisp
make tests
make tests MATLAB_EXE=/path/to/matlab # if using a specific MATLAB executable

Add the following to your ~/.emacs file:

(add-to-list 'load-path "/path/to/Emacs-MATLAB-mode")
(load-library "matlab-load")

MathWorks Products (https://www.mathworks.com)

Emacs MATLAB-mode is designed to be compatible with the last six years of MathWorks products and may support even older versions of MathWorks products.

License

GPL3, https://www.gnu.org/licenses/gpl-3.0.en.html (see License.txt)

Community Support

MATLAB Central

FAQ

How do I customize matlab-mode?

You can configure matlab-emacs using the “matlab” or “matlab-shell” customization groups:

Emacs -> Options -> Customize Emacs -> Specific Group

How do I customize “edit file.m” behavior?

By default when you run

M-x matlab-shell

:

>> edit file.m

file.m will open in emacs using ‘emacsclient -n’. matlab-shell achieve this behavior by instructing MATLAB to use ‘emacsclient -n’ as the external text editor.

You can customize this by setting `matlab-shell-emacsclient-command’ in the matlab-shell customization group. You can change this command to what’s appropriate. If you set it to the empty string, ‘edit file.m’ will use the default MATLAB editor setting.

The default MATLAB editor setting is controlled in the MATLAB preferences, (e.g. R2018a Home tab, Environment section, Preferences) where you can select which editor you want to edit a text file. MATLAB Editor or an external text editor. If you always want to use Emacs as your matlab editor even when running MATLAB outside of emacs, select Text editor and set it to the appropriate ‘emacsclient -n’ command.

History

matlab-mode has a history dating back many years. Older contributions can be found in https://sourceforge.net/projects/matlab-emacs/.