Mercurial > octave-nkf

annotate doc/interpreter/install.txi @ 20349:3300cb76cccd stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
install.txi: Add warning about incorrect behavior of reference BLAS library. * install.txi: Add warning about incorrect behavior of reference BLAS library.
author Rik <rik@octave.org>
date Tue, 07 Jul 2015 19:09:35 -0700
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19630
diff changeset
1 @c Copyright (C) 1996-2015 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
8 @c your option) any later version.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
9 @c
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
13 @c for more details.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
14 @c
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
17 @c <http://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
19 @c The text of this file appears in the file INSTALL in the Octave
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
20 @c distribution, as well as in the Octave manual.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
22 @ifclear INSTALLONLY
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3960
diff changeset
23 @node Installation
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24 @appendix Installing Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
25 @end ifclear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
26
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
27 @ifset INSTALLONLY
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
28 @include macros.texi
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
29
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
30 This file documents the installation of Octave.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
31
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
32 Octave is free software; you can redistribute it and/or modify it
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
33 under the terms of the GNU General Public License as published by the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
34 Free Software Foundation.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
35
12973
b80b18f537ca doc: Correct various Texinfo warnings about incorrect use of macros.
Rik <octave@nomad.inbox5.com>
parents: 12702
diff changeset
36 @strong{Note}: This file is automatically generated from
9031
1052a66078cf Documentation cleanup of top-level Octave directory (READMEs, INSTALL)
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
37 @file{doc/interpreter/install.txi} in the Octave sources. To update
1052a66078cf Documentation cleanup of top-level Octave directory (READMEs, INSTALL)
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
38 the documentation make changes to the .txi source file rather than this
1052a66078cf Documentation cleanup of top-level Octave directory (READMEs, INSTALL)
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
39 derived file.
7144
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
40
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3960
diff changeset
41 @node Installation
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
42 @chapter Installing Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
43 @end ifset
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
44
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
45 @cindex installing Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
46
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
47 The procedure for installing Octave from source on a Unix-like system is
17765
26a418799bc3 doc: avoid word 'below' when reference is in another node (bug #39260)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
48 described next. Building on other platforms will follow similar
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
49 steps. Note that this description applies to Octave releases. Building
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
50 the development sources from the Mercurial archive requires additional
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
51 steps as described in @ref{Building the Development Sources}.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
52
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
53 @menu
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
54 * Build Dependencies::
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
55 * Running Configure and Make::
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
56 * Compiling Octave with 64-bit Indexing::
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
57 * Installation Problems::
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
58 @end menu
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
59
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
60 @node Build Dependencies
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
61 @section Build Dependencies
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
62
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
63 Octave is a fairly large program with many build dependencies. You may
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
64 be able to find pre-packaged versions of the dependencies distributed as
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
65 part of your system, or you may have to build some or all of them
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
66 yourself.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
67
14187
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
68 @menu
14531
8985cbbd2fe4 doc: Periodic spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 14480
diff changeset
69 * Obtaining the Dependencies Automatically::
14187
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
70 * Build Tools::
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
71 * External Packages::
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
72 @end menu
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
73
14531
8985cbbd2fe4 doc: Periodic spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 14480
diff changeset
74 @node Obtaining the Dependencies Automatically
8985cbbd2fe4 doc: Periodic spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 14480
diff changeset
75 @subsection Obtaining the Dependencies Automatically
14187
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
76
14480
3d628878e109 doc: Reword the manual section on getting build dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14187
diff changeset
77 On some systems you can obtain many of Octave's build dependencies
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14622
diff changeset
78 automatically. The commands for doing this vary by system. Similarly,
14480
3d628878e109 doc: Reword the manual section on getting build dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14187
diff changeset
79 the names of pre-compiled packages vary by system and do not always
3d628878e109 doc: Reword the manual section on getting build dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14187
diff changeset
80 match exactly the names listed in @ref{Build Tools} and @ref{External
3d628878e109 doc: Reword the manual section on getting build dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14187
diff changeset
81 Packages}.
14187
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
82
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
83 You will usually need the development version of an external dependency
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
84 so that you get the libraries and header files for building software,
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
85 not just for running already compiled programs. These packages
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
86 typically have names that end with the suffix @code{-dev} or @code{-devel}.
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
87
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
88 On systems with @code{apt-get} (Debian, Ubuntu, etc.), you may be able
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
89 to install most of the tools and external packages using a command
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
90 similar to
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
91
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
92 @example
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
93 apt-get build-dep octave
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
94 @end example
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
95
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
96 @noindent
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
97 The specific package name may be @code{octave3.2} or @code{octave3.4}.
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
98 The set of required tools and external dependencies does not change
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
99 frequently, so it is not important that the version match exactly, but
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
100 you should use the most recent one available.
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
101
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
102 On systems with @code{yum} (Fedora, Red Hat, etc.), you may be able to
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
103 install most of the tools and external packages using a command similar to
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
104
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
105 @example
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
106 yum-builddep octave
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
107 @end example
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
108
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
109 @noindent
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
110 The @code{yum-builddep} utility is part of the @code{yum-utils} package.
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
111
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
112 For either type of system, the package name may include a version
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
113 number. The set of required tools and external dependencies does not
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
114 change frequently, so it is not important that the version exactly match
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
115 the version you are installing, but you should use the most recent one
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
116 available.
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
117
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
118 @node Build Tools
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
119 @subsection Build Tools
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
120
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
121 The following tools are required:
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
122
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
123 @table @asis
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
124 @item C++, C, and Fortran compilers
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
125 The Octave sources are primarily written in C++, but some portions are
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
126 also written in C and Fortran. The Octave sources are intended to be
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
127 portable. Recent versions of the GNU compiler collection (GCC) should
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
128 work (@url{http://gcc.gnu.org}). If you use GCC, you should avoid
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
129 mixing versions. For example, be sure that you are not using the
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
130 obsolete @code{g77} Fortran compiler with modern versions of @code{gcc}
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
131 and @code{g++}.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
132
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
133 @item GNU Make
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
134 Tool for building software (@url{http://www.gnu.org/software/make}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
135 Octave's build system requires GNU Make. Other versions of Make will
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
136 not work. Fortunately, GNU Make is highly portable and easy to install.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
137
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
138 @item AWK, sed, and other Unix utilities
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
139 Basic Unix system utilities are required for building Octave. All will
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
140 be available with any modern Unix system and also on Windows with either
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
141 Cygwin or MinGW and MSYS.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
142 @end table
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
143
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
144 Additionally, the following tools may be needed:
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
145
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
146 @table @asis
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
147 @item Bison
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
148 Parser generator (@url{http://www.gnu.org/software/bison}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
149 You will need Bison if you modify the @code{oct-parse.yy} source file or
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
150 if you delete the files that are generated from it.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
151
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
152 @item Flex
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
153 Lexer analyzer (@url{http://www.gnu.org/software/flex}). You will need
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
154 Flex if you modify the @code{lex.ll} source file or if you delete the
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
155 files that are generated from it.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
156
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
157 @item Autoconf
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
158 Package for software configuration
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
159 (@url{http://www.gnu.org/software/autoconf}). Autoconf is required if
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
160 you modify Octave's @code{configure.ac} file or other files that it
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
161 requires.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
162
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
163 @item Automake
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
164 Package for Makefile generation
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
165 (@url{http://www.gnu.org/software/automake}). Automake is required if
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
166 you modify Octave's @code{Makefile.am} files or other files that they
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
167 depend on.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
168
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
169 @item Libtool
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
170 Package for building software libraries
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
171 (@url{http://www.gnu.org/software/libtool}). Libtool is required by
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
172 Automake.
18285
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
173
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
174 @item gperf
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
175 Perfect hash function generator (@url{http://www.gnu.org/software/gperf}).
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
176 You will need gperf if you modify the @code{octave.gperf} file or if you
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
177 delete the file that is generated from it.
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
178
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
179 @item Texinfo
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
180 Package for generating online and print documentation
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
181 (@url{http://www.gnu.org/software/texinfo}). You will need Texinfo to
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
182 build Octave's documentation or if you modify the documentation source
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
183 files or the docstring of any Octave function.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
184 @end table
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
185
14187
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
186 @node External Packages
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
187 @subsection External Packages
53a9c916ba2f doc: include tips for installing build dependencies on specific systems
John W. Eaton <jwe@octave.org>
parents: 14171
diff changeset
188
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
189 The following external packages are required:
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
190
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
191 @table @asis
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
192 @item BLAS
20349
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
193 Basic Linear Algebra Subroutine library. Accelerated @sc{blas} libraries such
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
194 as OpenBLAS (@url{http://www.openblas.net/}) or
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
195 ATLAS (@url{http://math-atlas.sourceforge.net}) are recommended for best
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
196 performance. The reference implementation (@url{http://www.netlib.org/blas})
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
197 is slow, unmaintained, and suffers from certain bugs in corner case inputs.
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14622
diff changeset
198
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
199 @item LAPACK
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
200 Linear Algebra Package (@url{http://www.netlib.org/lapack}).
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14622
diff changeset
201
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14150
diff changeset
202 @item PCRE
16792
b157ba28f123 doc: Use Texinfo @url command consistently throughout documentation.
Rik <rik@octave.org>
parents: 16710
diff changeset
203 The Perl Compatible Regular Expression library (@url{http://www.pcre.org}).
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
204 @end table
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
205
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
206 The following external package is optional but strongly recommended:
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
207
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
208 @table @asis
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
209 @item GNU Readline
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
210 Command-line editing library (@url{www.gnu.org/s/readline}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
211 @end table
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
212
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
213 If you wish to build Octave without GNU readline installed, you must use
14622
92659ad0d215 doc: Use @option macro where appropriate.
Rik <octave@nomad.inbox5.com>
parents: 14531
diff changeset
214 the @option{--disable-readline} option when running the configure script.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
215
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
216 The following external software packages are optional but recommended:
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
217
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
218 @table @asis
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
219 @item ARPACK
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
220 Library for the solution of large-scale eigenvalue problems
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
221 (@url{http://forge.scilab.org/index.php/p/arpack-ng}). @sc{arpack} is
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
222 required to provide the functions @code{eigs} and @code{svds}.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
223
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
224 @item cURL
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
225 Library for transferring data with URL syntax
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14150
diff changeset
226 (@url{http://curl.haxx.se}). cURL is required to provide the
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
227 @code{urlread} and @code{urlwrite} functions and the @code{ftp} class.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
228
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
229 @item FFTW3
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
230 Library for computing discrete Fourier transforms
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
231 (@url{http://www.fftw.org}). FFTW3 is used to provide better
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
232 performance for functions that compute discrete Fourier transforms
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
233 (@code{fft}, @code{ifft}, @code{fft2}, etc.)
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
234
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
235 @item FLTK
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
236 Portable GUI toolkit (@url{http://www.fltk.org}). FLTK is currently
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
237 used to provide windows for Octave's OpenGL-based graphics functions.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
238
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
239 @item fontconfig
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
240 Library for configuring and customizing font access
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
241 (@url{http://www.freedesktop.org/wiki/Software/fontconfig}). Fontconfig
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
242 is used to manage fonts for Octave's OpenGL-based graphics functions.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
243
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
244 @item FreeType
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
245 Portable font engine (@url{http://www.freetype.org}). FreeType is used
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14150
diff changeset
246 to perform font rendering for Octave's OpenGL-based graphics functions.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
247
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
248 @item GLPK
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
249 GNU Linear Programming Kit (@url{http://www.gnu.org/software/glpk}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
250 GPLK is required for the function @code{glpk}.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
251
18075
24759ac2b8cb doc: Periodic spellcheck of documentation
Rik <rik@octave.org>
parents: 18073
diff changeset
252 @item @nospell{gl2ps}
18073
42c3e30557a4 doc: Small fixes to the octave manual (bug #40557).
Rik <rik@octave.org>
parents: 17772
diff changeset
253 OpenGL to PostScript printing library (@url{http://www.geuz.org/gl2ps/}).
18075
24759ac2b8cb doc: Periodic spellcheck of documentation
Rik <rik@octave.org>
parents: 18073
diff changeset
254 @nospell{gl2ps} is required for printing when using the FLTK toolkit.
18073
42c3e30557a4 doc: Small fixes to the octave manual (bug #40557).
Rik <rik@octave.org>
parents: 17772
diff changeset
255
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
256 @item gnuplot
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
257 Interactive graphics program (@url{http://www.gnuplot.info}). gnuplot
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
258 is currently the default graphics renderer for Octave.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
259
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
260 @item GraphicsMagick++
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
261 Image processing library (@url{http://www.graphicsmagick.org}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
262 GraphicsMagick++ is used to provide the @code{imread} and @code{imwrite}
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
263 functions.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
264
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
265 @item HDF5
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
266 Library for manipulating portable data files
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
267 (@url{http://www.hdfgroup.org/HDF5}). @sc{hdf5} is required for Octave's
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14150
diff changeset
268 @code{load} and @code{save} commands to read and write HDF data files.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
269
18285
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
270 @item Java Development Kit
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
271 Java programming language compiler and libraries. The OpenJDK free
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
272 software implementation is recommended (@url{http://openjdk.java.net/}),
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
273 although other JDK implementations may work. Java is required to be able
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
274 to call Java functions from within Octave.
8671f39d1728 doc: Document missing build tools and external packages (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 18079
diff changeset
275
15046
d7124baf5f86 Document extra LLVM dependency
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
276 @item LLVM
16710
00db1d7312bb doc: Use double space after period for INSTALL file.
Rik <rik@octave.org>
parents: 15276
diff changeset
277 Compiler framework, (@url{http://www.llvm.org}). LLVM is required for
15046
d7124baf5f86 Document extra LLVM dependency
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
278 Octave's experimental just-in-time (JIT) compilation for speeding up the
d7124baf5f86 Document extra LLVM dependency
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
279 interpreter.
d7124baf5f86 Document extra LLVM dependency
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
280
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
281 @item OpenGL
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14622
diff changeset
282 API for portable 2-D and 3-D graphics (@url{http://www.opengl.org}). An
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
283 OpenGL implementation is required to provide Octave's OpenGL-based
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
284 graphics functions. Octave's OpenGL-based graphics functions usually
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
285 outperform the gnuplot-based graphics functions because plot data can be
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
286 rendered directly instead of sending data and commands to gnuplot for
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
287 interpretation and rendering.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
288
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
289 @item Qhull
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
290 Computational geometry library (@url{http://www.qhull.org}). Qhull is
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
291 required to provide the functions @code{convhull}, @code{convhulln},
19198
ba167badef9f Deprecate delaunay3 and extend delaunay to 3-D inputs.
Rik <rik@octave.org>
parents: 18854
diff changeset
292 @code{delaunay}, @code{delaunayn}, @code{voronoi}, and @code{voronoin}.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
293
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
294 @item QRUPDATE
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
295 QR factorization updating library
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
296 (@url{http://sourceforge.net/projects/qrupdate}). QRUPDATE is used to
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
297 provide improved performance for the functions @code{qrdelete},
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
298 @code{qrinsert}, @code{qrshift}, and @code{qrupdate}.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
299
15047
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
300 @item QScintilla
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
301 Source code highlighter and manipulator; a Qt port of Scintilla
15047
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
302 (@url{http://www.riverbankcomputing.co.uk/software/qscintilla}).
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
303 QScintilla is used for syntax highlighting and code completion in the
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
304 GUI.
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
305
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
306 @item Qt
16710
00db1d7312bb doc: Use double space after period for INSTALL file.
Rik <rik@octave.org>
parents: 15276
diff changeset
307 GUI and utility libraries (@url{}). Qt is required for building the GUI.
15047
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
308 It is a large framework, but the only components required are the GUI,
18073
42c3e30557a4 doc: Small fixes to the octave manual (bug #40557).
Rik <rik@octave.org>
parents: 17772
diff changeset
309 core, and network modules.
15047
11c05ff73c83 Document extra Qt dependencies
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14853
diff changeset
310
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
311 @item SuiteSparse
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
312 Sparse matrix factorization library
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
313 (@url{http://www.cise.ufl.edu/research/sparse/SuiteSparse}).
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
314 SuiteSparse is required to provide sparse matrix factorizations and
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
315 solution of linear equations for sparse systems.
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
316
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
317 @item zlib
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
318 Data compression library (@url{http://zlib.net}). The zlib library is
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
319 required for Octave's @code{load} and @code{save} commands to handle
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14622
diff changeset
320 compressed data, including @sc{matlab} v5 MAT files.
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
321 @end table
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
322
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
323 @node Running Configure and Make
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
324 @section Running Configure and Make
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
325
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
326 @itemize @bullet
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
327 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
328 Run the shell script @file{configure}. This will determine the features
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
329 your system has (or doesn't have) and create a file named
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
330 @file{Makefile} from each of the files named @file{Makefile.in}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
331
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
332 Here is a summary of the configure options that are most frequently used
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
333 when building Octave:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
334
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
335 @table @code
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
336 @item --help
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
337 Print a summary of the options recognized by the configure script.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
338
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
339 @item --prefix=@var{prefix}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
340 Install Octave in subdirectories below @var{prefix}. The default value
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
341 of @var{prefix} is @file{/usr/local}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
342
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
343 @item --srcdir=@var{dir}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
344 Look for Octave sources in the directory @var{dir}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
345
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
346 @item --enable-64
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
347 This is an @strong{experimental} option to enable Octave to use 64-bit
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
348 integers for array dimensions and indexing on 64-bit platforms. You
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
349 probably don't want to use this option unless you know what you are
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
350 doing. @xref{Compiling Octave with 64-bit Indexing}, for more details
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
351 about building Octave with this option.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
352
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
353 @item --enable-bounds-check
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
354 Enable bounds checking for indexing operators in the internal array
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
355 classes. This option is primarily used for debugging Octave. Building
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 7144
diff changeset
356 Octave with this option has a negative impact on performance and is not
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
357 recommended for general use.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
358
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
359 @item --disable-docs
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
360 Disable building all forms of the documentation (Info, PDF, HTML). The
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
361 default is to build documentation, but your system will need functioning
14038
b0cdd60db5e5 doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 14018
diff changeset
362 Texinfo and @TeX{} installs for this to succeed.
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
363
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
364 @item --enable-float-truncate
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
365 This option allows for truncation of intermediate floating point results
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
366 in calculations. It is only necessary for certain platforms.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
367
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
368 @item --enable-readline
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
369 Use the readline library to provide for editing of the command line in
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
370 terminal environments. This option is on by default.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
371
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
372 @item --enable-shared
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
373 Create shared libraries (this is the default). If you are planning to
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
374 use the dynamic loading features, you will probably want to use this
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
375 option. It will make your @file{.oct} files much smaller and on some
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
376 systems it may be necessary to build shared libraries in order to use
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
377 dynamically linked functions.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
378
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
379 You may also want to build a shared version of @code{libstdc++}, if your
7081
503001863427 [project @ 2007-10-31 01:08:14 by jwe]
jwe
parents: 7018
diff changeset
380 system doesn't already have one.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
381
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
382 @item --enable-dl
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
383 Use @code{dlopen} and friends to make Octave capable of dynamically
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
384 linking externally compiled functions (this is the default if
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
385 @option{--enable-shared} is specified). This option only works on
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
386 systems that actually have these functions. If you plan on using this
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
387 feature, you should probably also use @option{--enable-shared} to reduce
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
388 the size of your @file{.oct} files.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
389
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
390 @item --with-blas=<lib>
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
391 By default, configure looks for the best @sc{blas} matrix libraries on
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
392 your system, including optimized implementations such as the free ATLAS
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
393 3.0, as well as vendor-tuned libraries. (The use of an optimized
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
394 @sc{blas} will generally result in several-times faster matrix
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
395 operations.) Use this option to specify a particular @sc{blas} library
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
396 that Octave should use.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
397
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
398 @item --with-lapack=<lib>
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
399 By default, configure looks for the best @sc{lapack} matrix libraries on
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
400 your system, including optimized implementations such as the free ATLAS
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
401 3.0, as well as vendor-tuned libraries. (The use of an optimized
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
402 @sc{lapack} will generally result in several-times faster matrix
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
403 operations.) Use this option to specify a particular @sc{lapack}
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
404 library that Octave should use.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
405
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
406 @item --with-magick=<lib>
12575
d0b799dafede Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
407 Select the library to use for image I/O@. The two possible values are
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
408 @qcode{"GraphicsMagick"} (default) or @qcode{"ImageMagick"}.
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
409
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
410 @item --with-sepchar=<char>
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
411 Use <char> as the path separation character. This option can help when
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
412 running Octave on non-Unix systems.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
413
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
414 @item --without-amd
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
415 Don't use @sc{amd}, disable some sparse matrix functionality.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
416
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
417 @item --without-camd
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
418 Don't use @sc{camd}, disable some sparse matrix functionality.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
419
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
420 @item --without-colamd
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
421 Don't use @sc{colamd}, disable some sparse matrix functionality.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
422
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
423 @item --without-ccolamd
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
424 Don't use @sc{ccolamd}, disable some sparse matrix functionality.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
425
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
426 @item --without-cholmod
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
427 Don't use @sc{cholmod}, disable some sparse matrix functionality.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
428
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
429 @item --without-curl
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
430 Don't use the cURL library, disable the ftp objects, @code{urlread} and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
431 @code{urlwrite} functions.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
432
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
433 @item --without-cxsparse
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
434 Don't use @sc{cxsparse}, disable some sparse matrix functionality.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
435
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
436 @item --without-fftw3
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
437 Use the included @sc{fftpack} library for computing Fast Fourier
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
438 Transforms instead of the @sc{fftw3} library.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
439
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
440 @item --without-fftw3f
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
441 Use the included @sc{fftpack} library for computing Fast Fourier
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
442 Transforms instead of the @sc{fftw3} library when operating on single
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
443 precision (float) values.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
444
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
445 @item --without-glpk
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
446 Don't use the @sc{glpk} library for linear programming.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
447
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
448 @item --without-hdf5
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
449 Don't use the @sc{hdf5} library, disable reading and writing of
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
450 @sc{hdf5} files.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
451
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
452 @item --without-opengl
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
453 Don't use OpenGL, disable native graphics toolkit for plotting. You
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
454 will need @code{gnuplot} installed in order to make plots.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
455
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
456 @item --without-qhull
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
457 Don't use Qhull, disable @code{delaunay}, @code{convhull}, and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
458 related functions.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
459
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
460 @item --without-qrupdate
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
461 Don't use @sc{qrupdate}, disable QR and Cholesky update functions.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
462
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
463 @item --without-umfpack
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
464 Don't use @sc{umfpack}, disable some sparse matrix functionality.
7091
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
465
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
466 @item --without-zlib
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
467 Don't use the zlib library, disable data file compression and support
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
468 for recent MAT file formats.
5608935ff522 [project @ 2007-10-31 21:26:39 by jwe]
jwe
parents: 7081
diff changeset
469
8791
d943e26d30e2 Add documentation for configure options "--without-framework-carbon" and "--without-framework-opengl".
Thomas Treichl <Thomas.Treichl@gmx.net>
parents: 8481
diff changeset
470 @item --without-framework-carbon
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
471 Don't use framework Carbon headers, libraries, or specific source code
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
472 even if the configure test succeeds (the default is to use Carbon
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
473 framework if available). This is a platform specific configure option
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
474 for Mac systems.
8791
d943e26d30e2 Add documentation for configure options "--without-framework-carbon" and "--without-framework-opengl".
Thomas Treichl <Thomas.Treichl@gmx.net>
parents: 8481
diff changeset
475
d943e26d30e2 Add documentation for configure options "--without-framework-carbon" and "--without-framework-opengl".
Thomas Treichl <Thomas.Treichl@gmx.net>
parents: 8481
diff changeset
476 @item --without-framework-opengl
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
477 Don't use framework OpenGL headers, libraries, or specific source code
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
478 even if the configure test succeeds. If this option is given then
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
479 OpenGL headers and libraries in standard system locations are tested
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
480 (the default value is @option{--with-framework-opengl}). This is a
8791
d943e26d30e2 Add documentation for configure options "--without-framework-carbon" and "--without-framework-opengl".
Thomas Treichl <Thomas.Treichl@gmx.net>
parents: 8481
diff changeset
481 platform specific configure option for Mac systems.
d943e26d30e2 Add documentation for configure options "--without-framework-carbon" and "--without-framework-opengl".
Thomas Treichl <Thomas.Treichl@gmx.net>
parents: 8481
diff changeset
482
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
483 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
484
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
485 See the file @file{INSTALL} for more general information about the
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
486 command line options used by configure. That file also contains
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
487 instructions for compiling in a directory other than the one where
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
488 the source is located.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
489
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
490 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
491 Run make.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
492
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
493 You will need a recent version of GNU Make as Octave relies on certain
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
494 features not generally available in all versions of make. Modifying
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
495 Octave's makefiles to work with other make programs is probably not
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
496 worth your time; instead, we simply recommend installing GNU Make.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
497
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
498 There are currently two options for plotting in Octave: (1) the external
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
499 program gnuplot, or (2) the internal graphics engine using OpenGL and
12575
d0b799dafede Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
500 FLTK@. Gnuplot is a command-driven interactive function plotting
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
501 program. Gnuplot is copyrighted, but freely distributable. As of
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
502 Octave release 3.4, gnuplot is the default option for plotting. But,
12702
013cd94d8d7f doc: Spelling fixes for various documentation files
John Bradshaw <john@johnbradshaw.org>
parents: 12575
diff changeset
503 the internal graphics engine is nearly 100% compatible, certainly for
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
504 most ordinary plots, and users are encouraged to test it. It is
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
505 anticipated that the internal engine will become the default option at
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
506 the next major release of Octave.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
507
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
508 To compile Octave, you will need a recent version of @code{g++} or other
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
509 ANSI C++ compiler. In addition, you will need a Fortran 77 compiler or
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
510 @code{f2c}. If you use @code{f2c}, you will need a script like
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
511 @code{fort77} that works like a normal Fortran compiler by combining
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
512 @code{f2c} with your C compiler in a single script.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
513
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
514 If you plan to modify the parser you will also need GNU @code{bison} and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
515 @code{flex}. If you modify the documentation, you will need GNU
11291
5abe6815aa5e install.txi: delete obsolete statement about needing a patch for makeinfo
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
516 Texinfo.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
517
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
518 GNU Make, @code{gcc} (and @code{libstdc++}), @code{gnuplot},
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
519 @code{bison}, @code{flex}, and Texinfo are all available from many
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
520 anonymous ftp archives. The primary site is @url{ftp.gnu.org}, but it
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
521 is often very busy. A list of sites that mirror the software on
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
522 @url{ftp.gnu.org} is available by anonymous ftp from
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
523 @url{ftp://ftp.gnu.org/pub/gnu/GNUinfo/FTP}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
524
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
525 Octave requires approximately 1.4 GB of disk storage to unpack and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
526 compile from source (significantly less, 400 MB, if you don't compile
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
527 with debugging symbols). To compile without debugging symbols try the
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
528 command
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
529
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
530 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
531 make CFLAGS=-O CXXFLAGS=-O LDFLAGS=
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
532 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
533
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
534 @noindent
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
535 instead of just @command{make}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
536
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
537 @item
17765
26a418799bc3 doc: avoid word 'below' when reference is in another node (bug #39260)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
538 If you encounter errors while compiling Octave, first
17772
7900595f1533 * install.txi: Use @ref instead of xref or pxref in mid sentence.
John W. Eaton <jwe@octave.org>
parents: 17765
diff changeset
539 see @ref{Installation Problems} for a list of
17765
26a418799bc3 doc: avoid word 'below' when reference is in another node (bug #39260)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
540 known problems and if there is a workaround or solution for
17772
7900595f1533 * install.txi: Use @ref instead of xref or pxref in mid sentence.
John W. Eaton <jwe@octave.org>
parents: 17765
diff changeset
541 your problem. If not, see
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
542 @ifclear INSTALLONLY
17772
7900595f1533 * install.txi: Use @ref instead of xref or pxref in mid sentence.
John W. Eaton <jwe@octave.org>
parents: 17765
diff changeset
543 @ref{Trouble}
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
544 @end ifclear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
545 @ifset INSTALLONLY
17772
7900595f1533 * install.txi: Use @ref instead of xref or pxref in mid sentence.
John W. Eaton <jwe@octave.org>
parents: 17765
diff changeset
546 the file BUGS
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
547 @end ifset
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
548 for information about how to report bugs.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
549
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
550 @item
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
551 Once you have successfully compiled Octave, run @code{make install}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
552
8481
00df69d7e698 [docs] capitalize Octave consistently
Brian Gough <bjg@gnu.org>
parents: 8325
diff changeset
553 This will install a copy of Octave, its libraries, and its documentation
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
554 in the destination directory. As distributed, Octave is installed in
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
555 the following directories. In the table below, @var{prefix} defaults to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
556 @file{/usr/local}, @var{version} stands for the current version number
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
557 of the interpreter, and @var{arch} is the type of computer on which
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
558 Octave is installed (for example, @samp{i586-unknown-gnu}).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
559
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
560 @table @file
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
561 @item @var{prefix}/bin
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
562 Octave and other binaries that people will want to run directly.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
563
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
564 @item @var{prefix}/lib/octave-@var{version}
15271
648dabbb4c6b build: Refactor liboctave into multiple subdirectories. Move libcruft into liboctave.
Rik <rik@octave.org>
parents: 15048
diff changeset
565 Libraries like liboctave.a and liboctinterp.a.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
566
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
567 @item @var{prefix}/octave-@var{version}/include/octave
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
568 Include files distributed with Octave.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
569
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
570 @item @var{prefix}/share
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
571 Architecture-independent data files.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
572
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
573 @item @var{prefix}/share/man/man1
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
574 Unix-style man pages describing Octave.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
575
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
576 @item @var{prefix}/share/info
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
577 Info files describing Octave.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
578
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
579 @item @var{prefix}/share/octave/@var{version}/m
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
580 Function files distributed with Octave. This includes the Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
581 version, so that multiple versions of Octave may be installed at the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
582 same time.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
583
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
584 @item @var{prefix}/libexec/octave/@var{version}/exec/@var{arch}
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
585 Executables to be run by Octave rather than the user.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
586
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
587 @item @var{prefix}/lib/octave/@var{version}/oct/@var{arch}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
588 Object files that will be dynamically loaded.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
589
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
590 @item @var{prefix}/share/octave/@var{version}/imagelib
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
591 Image files that are distributed with Octave.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
592 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
593 @end itemize
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
594
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17097
diff changeset
595 @node Compiling Octave with 64-bit Indexing
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
596 @section Compiling Octave with 64-bit Indexing
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
597
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
598 Note: the following only applies to systems that have 64-bit pointers.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
599 Configuring Octave with @option{--enable-64} cannot magically make a
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
600 32-bit system have a 64-bit address space.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
601
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
602 On 64-bit systems, Octave is limited to (approximately) the following
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
603 array sizes when using the default 32-bit indexing mode:
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
604
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
605 @example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
606 @group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
607 double: 16GB
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
608 single: 8GB
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
609 uint64, int64: 16GB
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
610 uint32, int32: 8GB
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
611 uint16, int16: 4GB
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
612 uint8, int8: 2GB
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
613 @end group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
614 @end example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
615
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
616 In each case, the limit is really (approximately) @math{2^{31}} elements
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
617 because of the default type of the value used for indexing arrays
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
618 (signed 32-bit integer, corresponding to the size of a Fortran INTEGER
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
619 value).
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
620
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
621 Trying to create larger arrays will produce the following error:
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
622
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
623 @example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
624 @group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
625 octave:1> a = zeros (1024*1024*1024*3, 1, 'int8');
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
626 error: memory exhausted or requested size too large
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
627 for range of Octave's index type --
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
628 trying to return to prompt
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
629 @end group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
630 @end example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
631
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
632 @noindent
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
633 You will obtain this error even if your system has enough memory to
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
634 create this array (4 GB in the above case).
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
635
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
636 To use arrays larger than 2 GB, Octave has to be configured with the
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
637 option @option{--enable-64}. This option is experimental and you are
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
638 encouraged to submit bug reports if you find a problem. With this
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
639 option, Octave will use 64-bit integers internally for array dimensions
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
640 and indexing. However, all numerical libraries used by Octave will
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
641 @strong{also} need to use 64-bit integers for array dimensions and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
642 indexing. In most cases, this means they will need to be compiled from
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
643 source since most (all?) distributions which package these libraries
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
644 compile them with the default Fortran integer size, which is normally
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
645 32-bits wide.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
646
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
647 The following instructions were tested with the development version of
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
648 Octave and GCC 4.3.4 on an x86_64 Debian system.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
649
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
650 The versions listed below are the versions used for testing. If newer
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
651 versions of these packages are available, you should try to use them,
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
652 although there may be some differences.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
653
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
654 All libraries and header files will be installed in subdirectories of
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
655 @code{$prefix64} (you must choose the location of this directory).
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
656
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
657 @itemize @bullet
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
658 @item @sc{blas} and @sc{lapack} (@url{http://www.netlib.org/lapack})
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
659
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
660 Reference versions for both libraries are included in the reference
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
661 @sc{lapack} 3.2.1 distribution from @url{netlib.org}.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
662
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
663 @itemize @minus
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
664 @item
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
665 Copy the file @file{make.inc.example} and name it @file{make.inc}.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
666 The options @option{-fdefault-integer-8} and @option{-fPIC} (on 64-bit
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
667 CPU) have to be added to the variable @code{OPTS} and @code{NOOPT}.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
668
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
669 @item
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
670 Once you have compiled this library make sure that you use it for
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
671 compiling Suite Sparse and Octave. In the following we assume that
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
672 you installed the @sc{lapack} library as $prefix64/lib/liblapack.a.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
673 @end itemize
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
674
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
675 @item QRUPDATE (@url{http://sourceforge.net/projects/qrupdate})
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
676
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
677 In the @file{Makeconf} file:
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
678
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
679 @itemize @minus
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
680 @item
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
681 Add @option{-fdefault-integer-8} to @env{FFLAGS}.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
682
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
683 @item
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
684 Adjust the @sc{blas} and @sc{lapack} variables as needed if your 64-bit
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
685 aware @sc{blas} and @sc{lapack} libraries are in a non-standard
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
686 location.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
687
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
688 @item
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
689 Set @env{PREFIX} to the top-level directory of your install tree.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
690
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
691 @item
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
692 Run @code{make solib} to make a shared library.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
693
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
694 @item
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
695 Run @code{make install} to install the library.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
696 @end itemize
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
697
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
698 @item
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
699 SuiteSparse (@url{http://www.cise.ufl.edu/research/sparse/SuiteSparse})
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
700
18079
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
701 Pass the following options to @command{make} to enable 64-bit integers
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
702 for @sc{blas} library calls. On 64-bit Windows systems, use
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
703 @code{-DLONGBLAS="long long"} instead.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
704
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
705 @example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
706 @group
18079
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
707 CFLAGS='-DLONGBLAS=long'
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
708 CXXFLAGS='-DLONGBLAS=long'
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
709 @end group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
710 @end example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
711
18079
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
712 The SuiteSparse makefiles don't generate shared libraries. On some
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
713 systems, you can generate them by doing something as simple as
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
714
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
715 @example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
716 @group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
717 top=$(pwd)
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
718 for f in *.a; do
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
719 mkdir tmp
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
720 cd tmp
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
721 ar vx ../$f
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
722 gcc -shared -o ../$@{f%%.a@}.so *.o
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
723 cd $top
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
724 rm -rf tmp
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
725 done
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
726 @end group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
727 @end example
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
728
18079
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
729 @noindent
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
730 Other systems may require a different solution.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
731
19332
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
732 @item @sc{arpack} (http://forge.scilab.org/index.php/p/arpack-ng/)
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
733
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
734 @itemize @minus
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
735 @item Add @option{-fdefault-integer-8} to @env{FFLAGS} when running configure.
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
736
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
737 @item Run @code{make} to build the library.
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
738
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
739 @item Run @code{make install} to install the library.
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
740 @end itemize
ed1bf35dc11c doc: Add note about compiling arpack with 64-bit integers when using --enable-64 (bug #43031).
Rik <rik@octave.org>
parents: 18285
diff changeset
741
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
742 @item ATLAS instead of reference @sc{blas} and @sc{lapack}
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
743
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
744 Suggestions on how to compile ATLAS would be most welcome.
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
745
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
746 @item @sc{glpk}
18854
19a140e93b1f doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 18713
diff changeset
747
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
748 @item Qhull (@url{http://www.qhull.org})
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
749
18079
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
750 Both @sc{glpk} and Qhull use @code{int} internally so maximum problem
d8d0e9e189f5 * install.txi: Update 64-bit build info for suitesparse, glpk, and qhull.
John W. Eaton <jwe@octave.org>
parents: 18075
diff changeset
751 sizes may be limited.
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
752
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
753 @item Octave
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
754
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
755 Octave's 64-bit index support is activated with the configure option
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
756 @option{--enable-64}.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
757
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
758 @example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
759 @group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
760 ./configure \
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
761 LD_LIBRARY_PATH="$prefix64/lib" \
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
762 CPPFLAGS="-I$prefix64/include" LDFLAGS="-L$prefix64/lib" \
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
763 --enable-64
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
764 @end group
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
765 @end example
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
766
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
767 You must ensure that all Fortran sources except those in the
15271
648dabbb4c6b build: Refactor liboctave into multiple subdirectories. Move libcruft into liboctave.
Rik <rik@octave.org>
parents: 15048
diff changeset
768 @file{liboctave/cruft/ranlib} directory are compiled such that INTEGERS are
15275
ecdb1463bff4 Fix typo in install.txi and in documentation spellcheck dictionary
Rik <rik@octave.org>
parents: 15271
diff changeset
769 8-bytes wide. If you are using gfortran, the configure script should
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
770 automatically set the Makefile variable @w{@env{F77_INTEGER_8_FLAG}} to
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
771 @option{-fdefault-integer-8}. If you are using another compiler, you
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
772 must set this variable yourself. You should NOT set this flag in
15271
648dabbb4c6b build: Refactor liboctave into multiple subdirectories. Move libcruft into liboctave.
Rik <rik@octave.org>
parents: 15048
diff changeset
773 @env{FFLAGS}, otherwise the files in @file{liboctave/cruft/ranlib} will be
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
774 miscompiled.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
775
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
776 @item Other dependencies
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
777
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
778 Probably nothing special needs to be done for the following
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
779 dependencies. If you discover that something does need to be done,
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
780 please submit a bug report.
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
781
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
782 @itemize @minus
12462
e4dbfe3019b1 Use PCRE regular expressions throughout Octave.
Rik <octave@nomad.inbox5.com>
parents: 12218
diff changeset
783 @item pcre
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
784
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
785 @item zlib
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
786
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
787 @item hdf5
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
788
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
789 @item fftw3
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
790
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
791 @item cURL
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
792
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
793 @item GraphicsMagick++
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
794
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
795 @item OpenGL
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
796
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
797 @item freetype
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
798
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
799 @item fontconfig
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
800
11302
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
801 @item fltk
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
802 @end itemize
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
803
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
804 @end itemize
e971caa4c2bb doc/interpreter/install.txi: explain how to compile Octave with 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 11291
diff changeset
805
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3960
diff changeset
806 @node Installation Problems
14150
87f06b9990bb doc: improve documentation for building Octave
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
807 @section Installation Problems
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
808
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
809 This section contains a list of problems (and some apparent problems
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
810 that don't really mean anything is wrong) that may show up during
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
811 installation of Octave.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
812
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
813 @itemize @bullet
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
814 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
815 On some SCO systems, @code{info} fails to compile if
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
816 @w{@code{HAVE_TERMIOS_H}} is defined in @file{config.h}. Simply
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
817 removing the definition from @file{info/config.h} should allow it to
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
818 compile.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
819
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
820 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
821 If @code{configure} finds @code{dlopen}, @code{dlsym}, @code{dlclose},
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
822 and @code{dlerror}, but not the header file @file{dlfcn.h}, you need to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
823 find the source for the header file and install it in the directory
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
824 @file{usr/include}. This is reportedly a problem with Slackware 3.1.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
825 For Linux/GNU systems, the source for @file{dlfcn.h} is in the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
826 @code{ldso} package.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
827
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
828 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
829 Building @file{.oct} files doesn't work.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
830
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
831 You should probably have a shared version of @code{libstdc++}. A patch
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
832 is needed to build shared versions of version 2.7.2 of @code{libstdc++}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
833 on the HP-PA architecture. You can find the patch at
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
834 @url{ftp://ftp.cygnus.com/pub/g++/libg++-2.7.2-hppa-gcc-fix}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
835
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
836 @item
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
837 On some DEC alpha systems there may be a problem with the @code{libdxml}
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
838 library, resulting in floating point errors and/or segmentation faults
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
839 in the linear algebra routines called by Octave. If you encounter such
3464
ab5ae0aca0f1 [project @ 2000-01-20 09:48:41 by jwe]
jwe
parents: 3294
diff changeset
840 problems, then you should modify the configure script so that
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9081
diff changeset
841 @w{@code{SPECIAL_MATH_LIB}} is not set to @code{-ldxml}.
3464
ab5ae0aca0f1 [project @ 2000-01-20 09:48:41 by jwe]
jwe
parents: 3294
diff changeset
842
ab5ae0aca0f1 [project @ 2000-01-20 09:48:41 by jwe]
jwe
parents: 3294
diff changeset
843 @item
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
844 On FreeBSD systems Octave may hang while initializing some internal
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
845 constants. The fix appears to be to use
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
846
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
847 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
848 options GPL_MATH_EMULATE
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
849 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
850
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
851 @noindent
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
852 rather than
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
853
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
854 @example
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
855 options MATH_EMULATE
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
856 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
857
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
858 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
859 in the kernel configuration files (typically found in the directory
18713
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 18285
diff changeset
860 @file{/sys/i386/conf}). After making this change, you'll need to rebuild
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
861 the kernel, install it, and reboot.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
862
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
863 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
864 If you encounter errors like
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
865
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
866 @example
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
867 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
868 passing `void (*)()' as argument 2 of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
869 `octave_set_signal_handler(int, void (*)(int))'
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
870 @end group
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
871 @end example
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
872
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
873 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
874 or
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
875
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
876 @example
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
877 @group
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
878 warning: ANSI C++ prohibits conversion from `(int)'
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9081
diff changeset
879 to `(@dots{})'
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
880 @end group
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
881 @end example
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
882
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
883 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
884 while compiling @file{sighandlers.cc}, you may need to edit some files
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
885 in the @code{gcc} include subdirectory to add proper prototypes for
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
886 functions there. For example, Ultrix 4.2 needs proper declarations for
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
887 the @code{signal} function and the @w{@code{SIG_IGN}} macro in the file
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
888 @file{signal.h}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
889
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
890 On some systems the @w{@code{SIG_IGN}} macro is defined to be something
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
891 like this:
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
892
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
893 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
894 #define SIG_IGN (void (*)())1
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
895 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
896
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
897 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
898 when it should really be something like:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
899
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
900 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
901 #define SIG_IGN (void (*)(int))1
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
902 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
903
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
904 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
905 to match the prototype declaration for the @code{signal} function. This
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
906 change should also be made for the @w{@code{SIG_DFL}} and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
907 @w{@code{SIG_ERR}} symbols. It may be necessary to change the
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
908 definitions in @file{sys/signal.h} as well.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
909
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
910 The @code{gcc} @code{fixincludes} and @code{fixproto} scripts should
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
911 probably fix these problems when @code{gcc} installs its modified set of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
912 header files, but I don't think that's been done yet.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
913
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
914 @strong{You should not change the files in @file{/usr/include}}. You
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
915 can find the @code{gcc} include directory tree by running the command
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
916
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
917 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
918 gcc -print-libgcc-file-name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
919 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
920
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
921 @noindent
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
922 The directory of @code{gcc} include files normally begins in the same
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
923 directory that contains the file @file{libgcc.a}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
924
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
925 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
926 Some of the Fortran subroutines may fail to compile with older versions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
927 of the Sun Fortran compiler. If you get errors like
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
928
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
929 @example
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
930 @group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
931 zgemm.f:
10599
d0e0bb2ebebb Remove tabs in .txi files causing problems with pdf formatting.
Rik <octave@nomad.inbox5.com>
parents: 9895
diff changeset
932 zgemm:
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
933 warning: unexpected parent of complex expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
934 zgemm.f, line 245: warning: unexpected parent of complex
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
935 expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
936 warning: unexpected parent of complex expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
937 zgemm.f, line 304: warning: unexpected parent of complex
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
938 expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
939 warning: unexpected parent of complex expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
940 zgemm.f, line 327: warning: unexpected parent of complex
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
941 expression subtree
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
942 pcc_binval: missing IR_CONV in complex op
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
943 make[2]: *** [zgemm.o] Error 1
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
944 @end group
6670
14992092ab06 [project @ 2007-05-29 17:51:37 by jwe]
jwe
parents: 5196
diff changeset
945 @end example
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
946
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
947 @noindent
15271
648dabbb4c6b build: Refactor liboctave into multiple subdirectories. Move libcruft into liboctave.
Rik <rik@octave.org>
parents: 15048
diff changeset
948 when compiling the Fortran subroutines in the @file{liboctave/cruft}
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
949 subdirectory, you should either upgrade your compiler or try compiling
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
950 with optimization turned off.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
951
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
952 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
953 On NeXT systems, if you get errors like this:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
954
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
955 @example
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
956 @group
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19332
diff changeset
957 /usr/tmp/cc007458.s:unknown:Undefined local
7081
503001863427 [project @ 2007-10-31 01:08:14 by jwe]
jwe
parents: 7018
diff changeset
958 symbol LBB7656
503001863427 [project @ 2007-10-31 01:08:14 by jwe]
jwe
parents: 7018
diff changeset
959 /usr/tmp/cc007458.s:unknown:Undefined local
503001863427 [project @ 2007-10-31 01:08:14 by jwe]
jwe
parents: 7018
diff changeset
960 symbol LBE7656
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
961 @end group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
962 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
963
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
964 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
965 when compiling @file{Array.cc} and @file{Matrix.cc}, try recompiling
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
966 these files without @option{-g}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
967
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
968 @item
14018
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
969 Some people have reported that calls to system() and the pager do not
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
970 work on SunOS systems. This is apparently due to having
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9081
diff changeset
971 @w{@code{G_HAVE_SYS_WAIT}} defined to be 0 instead of 1 when compiling
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
972 @code{libg++}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
973
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
974 @item
20349
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
975 On systems where the reference @sc{blas} library is used the following
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
976 matrix-by-vector multiplication incorrectly handles NaN values of the
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
977 form @code{NaN * 0}.
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
978
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
979 @example
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
980 @group
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
981 [NaN, 1; 0, 0] * [0; 1]
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
982 @result{}
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
983 [ 1
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
984 0 ]
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
985
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
986 correct result @result{}
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
987 [ NaN
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
988 0 ]
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
989 @end group
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
990 @end example
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
991
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
992 Install a different @sc{blas} library such as OpenBLAS or ATLAS to correct
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
993 this issue.
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
994
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
995 @item
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
996 On NeXT systems, linking to @file{libsys_s.a} may fail to resolve the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
997 following functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
998
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
999 @example
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
1000 @group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1001 _tcgetattr
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1002 _tcsetattr
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1003 _tcflow
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
1004 @end group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1005 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1006
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1007 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1008 which are part of @file{libposix.a}. Unfortunately, linking Octave with
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
1009 @option{-posix} results in the following undefined symbols.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1010
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1011 @example
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
1012 @group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1013 .destructors_used
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1014 .constructors_used
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1015 _objc_msgSend
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1016 _NXGetDefaultValue
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1017 _NXRegisterDefaults
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1018 .objc_class_name_NXStringTable
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1019 .objc_class_name_NXBundle
9081
c79cf77061b7 Cleanup documentation files contrib.texi, bugs.texi, install.texi, emacs.texi
Rik <rdrider0-list@yahoo.com>
parents: 9031
diff changeset
1020 @end group
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1021 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1022
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1023 One kluge around this problem is to extract @file{termios.o} from
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1024 @file{libposix.a}, put it in Octave's @file{src} directory, and add it
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1025 to the list of files to link together in the makefile. Suggestions for
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1026 better ways to solve this problem are welcome!
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1027
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1028 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1029 If Octave crashes immediately with a floating point exception, it is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1030 likely that it is failing to initialize the IEEE floating point values
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1031 for infinity and NaN.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1032
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1033 If your system actually does support IEEE arithmetic, you should be able
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1034 to fix this problem by modifying the function @code{octave_ieee_init} in
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1035 the file @file{lo-ieee.cc} to correctly initialize Octave's internal
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1036 infinity and NaN variables.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1037
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1038 If your system does not support IEEE arithmetic but Octave's configure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1039 script incorrectly determined that it does, you can work around the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1040 problem by editing the file @file{config.h} to not define
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
1041 @w{@code{HAVE_ISINF}}, @w{@code{HAVE_FINITE}}, and
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
1042 @w{@code{HAVE_ISNAN}}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1043
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1044 In any case, please report this as a bug since it might be possible to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1045 modify Octave's configuration script to automatically determine the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1046 proper thing to do.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1047
7144
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1048 @item
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1049 If Octave is unable to find a header file because it is installed in a
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1050 location that is not normally searched by the compiler, you can add the
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1051 directory to the include search path by specifying (for example)
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1052 @code{CPPFLAGS=-I/some/nonstandard/directory} as an argument to
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1053 @code{configure}. Other variables that can be specified this way are
12152
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
1054 @env{CFLAGS}, @env{CXXFLAGS}, @env{FFLAGS}, and @env{LDFLAGS}. Passing
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
1055 them as options to the configure script also records them in the
8e1ab522c902 Update build instructions in INSTALL.OCTAVE for release 3.4.
Rik <octave@nomad.inbox5.com>
parents: 11573
diff changeset
1056 @file{config.status} file. By default, @env{CPPFLAGS} and @env{LDFLAGS}
20349
3300cb76cccd install.txi: Add warning about incorrect behavior of reference BLAS library.
Rik <rik@octave.org>
parents: 19731
diff changeset
1057 are empty, @env{CFLAGS} and @env{CXXFLAGS} are set to @qcode{"-g -O2"} and
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1058 @env{FFLAGS} is set to @qcode{"-O"}.
7144
30c0533e39ae [project @ 2007-11-09 17:37:24 by jwe]
jwe
parents: 7091
diff changeset
1059
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1060 @end itemize
18854
19a140e93b1f doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 18713
diff changeset
1061