Editing Building

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
:''This article provides general information about '''building GNU Octave''' from source (on Unix-like systems).''
General information about building the Octave source for different operating systems.


:*''If you just want to '''install GNU Octave''', see [[:Category:Installation]].''
We try to keep build instructions up to date in the source tree. Please clone using [[Mercurial]] or download it to see the README.
:*''For '''MS Windows''', read [[Building on Microsoft Windows]] and [[Windows Installer]].''
:*''For '''macOS''', read [[Octave for macOS]].''


== General steps ==
There are also instructions in the [http://www.gnu.org/software/octave/doc/interpreter/Installation.html manual].


# Install all [[#Dependencies|build dependencies]] (see below).
* [[Octave for Debian systems]].
# Getting the Octave sources ...
* [[Octave for Arch Linux]].
::(A) ... from the development repository (requires also [https://www.mercurial-scm.org/ Mercurial])
* [[Building for Macintosh platform]]
<div style="margin-left:5em;">
* [[Building on Cygwin platform]]
hg clone https://www.octave.org/hg/octave && \
cd octave                                  && \
./bootstrap
</div>
::(B) ... from a release
<div style="margin-left:5em;">
wget https://ftpmirror.gnu.org/octave/octave-{{Release}}.tar.gz && \
tar -xzf octave-{{Release}}.tar.gz                              && \
cd octave-{{Release}}
</div>
: 3. Configure, build, check, and install Octave
<div style="margin-left:3em;">
mkdir .build                            && \
cd    .build                            && \
./../configure --prefix=$HOME/my_octave && \ <ref><code>--prefix</code> determines the installation location, see the [[#Install Octave in home directory|Tweaks section]] for details. For more information about configuration options, type <code>./../configure --help</code>.</ref>
make -j2                                && \ <ref>Depending on your system and processor count, use a larger number of parallel jobs, e.g. <code>-j8</code>.</ref>
make check                              && \
make install
</div>


== Dependencies ==
==Dependencies==


Most of the dependencies given in this section can be very conveniently installed on many [[Octave for GNU/Linux|GNU/Linux]] systems.
{| class"wikitable"
 
|-
{{Note|For a quick way to install the required dependencies, see:
| Critical
* [[Octave for Debian systems#The right way|Debian / Ubuntu]]
| width="50pt" style="background:red" | &nbsp;
* [[Octave for Arch Linux|Arch Linux]]
|-
* [[Octave for Red Hat Linux systems|Fedora / RedHat / CentOS]]}}
| Recommended
 
| style="background:yellow" | &nbsp;
Dependencies marked with <span style="background:lightgreen">green background</span> are '''required''' for building Octave.  All other tools and libraries are recommended/optional, but very useful features (like the GUI, plotting, etc.) are likely to be disabled.
|-
 
| Not critical
=== Build tools ===
| style="background:green" | &nbsp;
|}


{| class="wikitable"
{| class="wikitable"
|-
|-
! Dependency
! Task
! Description
! Name
! Usage
! License / Copyright
! License / Copyright
|-style="background:lightgreen"
! Version
| [https://www.gnu.org/software/autoconf Autoconf]
! [[Debian]]
| Software configuration
! [[Arch Linux]]
| GNU GPL v3.0
! Level
|-style="background:lightgreen"
! Recent CVE ?
| [https://www.gnu.org/software/automake Automake]
|-
| Makefile generator
| rowspan="8"| Build tools
| GNU GPL v3.0
| [http://gcc.gnu.org C++, C, and Fortran compilers]
|-style="background:lightgreen"
| [https://gcc.gnu.org C++, C, and Fortran compilers]
| Compiling the source code
| Compiling the source code
| GNU GPL v3.0
| GNU GPL v3.0
|-style="background:lightgreen"
|
| [https://www.gnu.org/software/make GNU Make]
| {{codeline|build-essential}}
|
| style="background:red" | &nbsp;
| none
|-
| [http://www.gnu.org/software/make GNU Make]
| Makefile processor
| Makefile processor
| GNU GPL v3.0
| GNU GPL v3.0
|-style="background:lightgreen"
|
| [https://www.gnu.org/software/libtool Libtool]
| {{codeline|make}}
| Dependency of automake
|
| Free Software Foundation
| style="background:red" | &nbsp;
|-style="background:lightgreen"
| none
| Unix utilities: gawk, gperf, less, ncurses
|-
| AWK, sed, and other Unix utilities
| Miscellaneous tasks
| Miscellaneous tasks
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|awk}}, {{codeline|sed}}, ...
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.gnu.org/software/bison Bison]
| [http://www.gnu.org/software/bison Bison]
| Parser generator
| Parser generator
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|bison}}
|
| style="background:green" | &nbsp;
| none
|-
|-
| [https://www.gnu.org/software/flex Flex]
| [http://www.gnu.org/software/flex Flex]
| Lexical analyzer
| Lexical analyzer
| The Flex project
| The Flex project
|}
|
 
| {{codeline|flex}}
=== Documentation tools ===
|
 
| style="background:green" | &nbsp;
{| class="wikitable"
| none
|-
|-
! Dependency
| [http://www.gnu.org/software/autoconf Autoconf]
! Description
| Software configuration
! License / Copyright
|-
| [http://www.ghostgum.com.au/software/epstool.htm epstool]
| Epstool is a utility to create or extract preview images in EPS files, fix bounding boxes and convert to bitmaps.
| GNU GPL v2.0
|-
| [https://www.freetype.org FTGL]
| Portable font engine to perform font rendering for Octave’s OpenGL-based graphics functions.
| GNU GPL v2.0
|-
| [http://geuz.org/gl2ps GL2PS]
| GL2PS is a C library providing high quality vector output for any OpenGL application.
| GNU LGPL v2.0
|-
| [https://www.nongnu.org/texi2html Texi2HTML]
| Perl script which converts Texinfo source files to HTML output.
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|autoconf}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.gnu.org/software/texinfo Texinfo]
| [http://www.gnu.org/software/automake Automake]
| Documentation system that uses a single source to produce both on-line information and printed output.
| Makefile generator
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|automake}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.tug.org/texlive/ TeX Live]
| [http://www.gnu.org/software/libtool Libtool]
| TeX document production system including all the major TeX-related programs, macro packages, and fonts that are free software.
| Dependency of automake
| Freely redistributable as defined by the Free Software Foundation
| Free Software Foundation
|}
|
 
| {{codeline|libtool}}
=== External tools and libraries ===
|
 
| style="background:red" | &nbsp;
{| class="wikitable"
| none
|-
|-
! Dependency
| rowspan="19"| External tools
! Description
| [http://www.netlib.org/blas BLAS]
! License / Copyright
|-style="background:lightgreen"
| [https://www.netlib.org/blas BLAS]
| Basic Linear Algebra Subroutine library
| Basic Linear Algebra Subroutine library
| Free - proper attribution request
| Free - proper attribution request
|-style="background:lightgreen"
|
| [https://netlib.org/lapack LAPACK]
| {{codeline|libatlas-base-dev}}
|
| style="background:red" | &nbsp;
| none
|-
| [http://www.netlib.org/lapack LAPACK]
| Linear Algebra Package
| Linear Algebra Package
| Free - proper attribution request
| Free - proper attribution request
|-style="background:lightgreen"
|
| [https://www.pcre.org PCRE]
| {{codeline|liblapack-dev}}
|
| style="background:red" | &nbsp;
| none
|-
| [http://www.pcre.org PCRE]
| Perl Compatible Regular Expression library
| Perl Compatible Regular Expression library
| Free
| Free
|-style="background:lightgreen"
|
| [https://www.gnu.org/software/readline GNU Readline]
| {{codeline|libpcre3-dev}}
|
| style="background:red" | &nbsp;
| none
|-
| [http://www.gnu.org/s/readline GNU Readline]
| Command-line editing library
| Command-line editing library
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|libreadline-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| [https://github.com/opencollab/arpack-ng ARPACK-NG]
| [http://forge.scilab.org/index.php/p/arpack-ng ARPACK]
| Solution of large-scale eigenvalue problems
| Solution of large-scale eigenvalue problems
| BSD like - various authors
| BSD like - various authors
|
| {{codeline|libarpack2-dev}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://curl.haxx.se cURL]
| [http://curl.haxx.se cURL]
| Library for transferring data with URL syntax
| Library for transferring data with URL syntax
| Free Software -- main author
| Free Software -- main author
| > 7.32.00
| {{codeline|curl}}
|
| style="background:red" | &nbsp;
| [http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2013-4545 CVE-2013-4545]
|-
|-
| [http://www.fftw.org FFTW3]
| [http://www.fftw.org FFTW3]
| Library for computing discrete Fourier transforms
| Library for computing discrete Fourier transforms
| MIT -- GNU GPL v2.0
| MIT -- GNU GPL v2.0
|
| {{codeline|libfftw3-dev}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.fltk.org FLTK]
| [http://www.fltk.org FLTK]
| Portable GUI toolkit
| Portable GUI toolkit
| GNU GPL v2.0 with static linking exception
| GNU GPL v2.0 with static linking exception
|
| {{codeline|libfltk1.3-dev}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.freedesktop.org/wiki/Software/fontconfig fontconfig]
| [http://www.freedesktop.org/wiki/Software/fontconfig fontconfig]
| Library for configuring and customizing font access
| Library for configuring and customizing font access
| Provided "as is" -- various authors
| Provided "as is" -- various authors
|
| {{codeline|fontconfig}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.freetype.org FreeType]
| [http://www.freetype.org FreeType]
| Portable font engine
| Portable font engine
| compatible with GNU GPL v3.0
| compatible with GNU GPL v3.0
|
| {{codeline|libfreetype6-dev}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| [https://www.geuz.org/gl2ps/ GL2PS]
| [http://www.gnu.org/software/glpk GLPK]
| OpenGL to PostScript printing library
| GNU GPL v2.0
|-
| [https://www.gnu.org/software/glpk GLPK]
| GNU Linear Programming Kit
| GNU Linear Programming Kit
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|libglpk-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| [http://www.gnuplot.info gnuplot]
| [http://www.gnuplot.info gnuplot]
| Interactive graphics program
| Interactive graphics program
| Provided "as is" -- various authors
| Provided "as is" -- various authors
|
| {{codeline|gnuplot}}
|
| style="background:red" | &nbsp;
| none
|-
|-
| Magick++, e.g. [http://www.graphicsmagick.org GraphicsMagick++]
| [http://www.graphicsmagick.org GraphicsMagick++]
| Image processing library
| Image processing library
| various -- integrates many third-party libs
| various -- integrates many third-party libs
| > 1.3.18
| {{codeline|libgraphicsmagick++1-dev}}
|
| style="background:yellow" | &nbsp;
| [http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2013-4589 CVE-2013-4589]
|-
|-
| [https://www.hdfgroup.org/solutions/hdf5 HDF5]
| [http://www.hdfgroup.org/HDF5 HDF5]
| Library for manipulating portable data files
| Library for manipulating portable data files
| BSD - like
| BSD - like
|
| {{codeline|libhdf5-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| JDK, e.g. [https://www.hdfgroup.org/solutions/hdf5 OpenJDK]
| [http://www.opengl.org OpenGL]
| Java programming language compiler and libraries
| GNU GPL v2.0
|-
| [https://www.opengl.org OpenGL]
| API for portable 2D and 3D graphics
| API for portable 2D and 3D graphics
| Free specs -- license is driver dependent
| Free specs -- license is driver dependent
|-
|
| [http://www.portaudio.com/ PortAudio]
| {{codeline|libgl-dev}}
| Audio I/O library
|
| Free software -- specific
| style="background:red" | &nbsp;
| none
|-
|-
| [http://www.qhull.org Qhull]
| [http://www.qhull.org Qhull]
| Computational geometry library
| Computational geometry library
| Free software -- specific
| Free software -- specific
|
| {{codeline|libqhull-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| [http://sourceforge.net/projects/qrupdate QRUPDATE]
| [http://sourceforge.net/projects/qrupdate QRUPDATE]
| QR factorization updating library
| QR factorization updating library
| GNU GPL v3.0
| GNU GPL v3.0
|
| {{codeline|libqrupdate-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| [https://riverbankcomputing.com/software/qscintilla QScintilla]
| [http://www.cise.ufl.edu/research/sparse/SuiteSparse SuiteSparse]
| Source code highlighter and manipulator; a Qt port of Scintilla
| GNU GPL v3.0
|-
| [https://www.qt.io/ Qt]
| Widget toolkit for creating graphical user interfaces
| GNU LGPL v3.0
|-
| [https://rapidjson.org/ RapidJSON]
| A fast JSON parser/generator for C++ with both SAX/DOM style API
| MIT license
|-
| [http://faculty.cse.tamu.edu/davis/suitesparse.html SuiteSparse]
| Sparse matrix factorization library
| Sparse matrix factorization library
| Main author
| Main author
|
| {{codeline|libsuitesparse-dev}}
|
| style="background:yellow" | &nbsp;
| none
|-
|-
| [https://computing.llnl.gov/projects/sundials/ida SUNDIALS IDA]
| [http://zlib.net zlib]
| SUite of Nonlinear and DIfferential/ALgebraic equation Solvers - Initial value problems for Differential-Algebraic equation (DAE) systems
| BSD 3-Clause
|-
| [https://zlib.net zlib]
| Data compression library
| Data compression library
| Provided "as is" -- various authors
| Provided "as is" -- various authors
|
| {{codeline|zlib1g-dev}}
|
| style="background:yellow" | &nbsp;
| none
|}
|}


== Tweaks ==
=== Install Octave in home directory ===
To install multiple versions of GNU Octave on one system, it is recommended to use the <code>--prefix</code> option of the <code>configure</code> script.  With this option one can determine a custom installation directory, preferably within your user's home directory, to avoid elevated installation privileges.  One does not "clutter" the system by running <code>sudo make install</code> and the custom build Octave can coexist with, for example, your Linux distribution installation of Octave.
In order to start the custom build of Octave almost as convenient as the Linux distribution installation of Octave, one can create an alias within {{Path|.bashrc}}:
echo "alias myoctave='$HOME/my_octave/bin/octave'" >> ~/.bashrc
Then update your {{Path|.bashrc}} without doing logout and login:
source $HOME/.bashrc
If you simply enter <code>octave</code>, you'll start your Linux distribution installation of Octave. But when you enter <code>myoctave</code>, you'll start your custom build of Octave inside your home directory.
=== Uninstall ===
# If you still have the {{Path|.build}} folder, just run <code>make uninstall</code> from it.
# Just delete the install folder, e.g. <code>rm -rf $HOME/my_octave</code>.
In any case, don't forget to remove any created ''alias'' entries in {{Path|~/.bashrc}}.
=== Large array support ===
: ''Main article: [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.]]''
== See also ==
* [https://hg.savannah.gnu.org/hgweb/octave/file/tip/README <code>README</code>] and [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/HACKING.md <code>/etc/HACKING.md</code>] in the development repository.
* https://octave.org/doc/interpreter/Installation.html
* [[MXE]] -- a more customized Octave build including many self-compiled tools.
== Footnotes ==
<references/>


==Security concerns==
* CVE-2013-4545 (cURL): solved by version 7.34.00. Upgrade dependencies.
* CVE-2013-4589 (graphicsmagick): the actual version (1.3.18, released March 9th, 2013), is affected. Awaiting a new release.
[[Category:Building]]
[[Category:Building]]
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page: