annotate README @ 21244:1473547f50f5

include octave-config.h in public header files * mk-opts.pl, mkbuiltins, mk-ops.awk, sparse-mk-ops.awk: Emit "#include octave-config.h" statement for generated header files. * build-env.h, builtins.h, Cell.h, base-text-renderer.h, c-file-ptr-stream.h, cdisplay.h, comment-list.h, data.h, debug.h, defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h, dynamic-ld.h, error.h, errwarn.h, event-queue.h, file-io.h, ft-text-renderer.h, gl-render.h, gl2ps-print.h, graphics.in.h, gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h, jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h, ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h, ls-utils.h, mex.h, mexproto.h, mxarray.in.h, oct-errno.h, oct-fstrm.h, oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h, oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.h, oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h, octave-default-image.h, octave-link.h, octave-preserve-stream-state.h, pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h, sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h, sysdep.h, text-renderer.h, toplev.h, txt-eng.h, utils.h, variables.h, workspace-element.h, xdiv.h, xnorm.h, xpow.h, zfstream.h, oct-qhull.h, ov-base-diag.h, ov-base-int.h, ov-base-mat.h, ov-base-scalar.h, ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h, ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h, ov-classdef.h, ov-colon.h, ov-complex.h, ov-cs-list.h, ov-cx-diag.h, ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.h, ov-fcn-handle.h, ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h, ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h, ov-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h, ov-intx.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.h, ov-oncleanup.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h, ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h, ov-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h, ov-uint8.h, ov-usr-fcn.h, ov.h, ovl.h, octave.h, op-int.h, ops.h, options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h, pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h, pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h, pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h, pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h, pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h, pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h, Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h, CRowVector.h, CSparse.h, DiagArray2.h, MArray.h, MDiagArray2.h, MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h, boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h, dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h, dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h, fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h, fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h, int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h, uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h, f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h, CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h, CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h, DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h, ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, base-aepbal.h, base-dae.h, base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun.h, dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h, dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.h, fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h, fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h, fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h, floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h, lo-mappers.h, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h, oct-rand.h, oct-spparms.h, randgamma.h, randmtzig.h, randpoisson.h, sparse-chol.h, sparse-dmsolve.h, sparse-lu.h, sparse-qr.h, Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h, Sparse-perm-op-defs.h, mx-base.h, mx-defs.h, mx-ext.h, mx-op-decl.h, mx-op-defs.h, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h, mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h, oct-syscalls.h, oct-time.h, oct-uname.h, pathlen.h, sysdir.h, syswait.h, action-container.h, base-list.h, byte-swap.h, caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h, glob-match.h, lo-array-errwarn.h, lo-array-gripes.h, lo-cutils.h, lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h, lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h, oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h, oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h, pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h, statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h: Include octave-config.h.
author John W. Eaton <jwe@octave.org>
date Wed, 10 Feb 2016 14:25:53 -0500
parents 4197fc428c7d
children aaf59727f809
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
1 GNU Octave -- a high-level language for numerical computations.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
2
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19158
diff changeset
3 Copyright (C) 1996-2015 John W. Eaton
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
4
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
5 Overview
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
6 --------
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
7
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
8 GNU Octave is a high-level language, primarily intended for numerical
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
9 computations. It provides a convenient command line interface for
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
10 solving linear and nonlinear problems numerically.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
11
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
12 GNU Octave is free software; you can redistribute it and/or modify it
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
13 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
14 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
15 option) any later version.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
16
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
17 GNU Octave is distributed in the hope that it will be useful, but
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
18 WITHOUT ANY WARRANTY; without even the implied warranty of
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the file
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
20 COPYING for more details.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
21
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
22 Availability
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
23 ------------
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
24
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
25 The latest released version of Octave is always available via
8922
25b85c36208f update README
John W. Eaton <jwe@octave.org>
parents: 7088
diff changeset
26 anonymous ftp from ftp.gnu.org and its many mirror sites around the
25b85c36208f update README
John W. Eaton <jwe@octave.org>
parents: 7088
diff changeset
27 world. You may also find links to binary distributions at
25b85c36208f update README
John W. Eaton <jwe@octave.org>
parents: 7088
diff changeset
28 http://www.octave.org/download.html. The current development sources
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
29 may be found on Savannah (http://savannah.gnu.org/projects/octave)
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
30 under the Source Code tab.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
31
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
32 Installation
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
33 ------------
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
34
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
35 Octave requires approximately 1.4 GB of disk storage to unpack and
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
36 compile from source (significantly less, 400 MB, if you don't compile
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
37 with debugging symbols). Once installed, Octave requires
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
38 approximately 350MB of disk space (again, considerably less, 70 MB,
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
39 if you don't build shared libraries or the binaries and libraries do
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
40 not include debugging symbols).
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
41
3148
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
42 To compile Octave, you will need a recent version of GNU Make. You
9031
1052a66078cf Documentation cleanup of top-level Octave directory (READMEs, INSTALL)
Rik <rdrider0-list@yahoo.com>
parents: 8922
diff changeset
43 will also need a recent version of g++ or another ANSI C++ compiler.
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
44 You will also need a Fortran 77 compiler or f2c. If you use f2c, you
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
45 will need a script like fort77 that works like a normal Fortran
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
46 compiler by combining f2c with your C compiler in a single script.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
47
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
48 YOU MUST HAVE GNU MAKE TO COMPILE OCTAVE. Octave's Makefiles use
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
49 features of GNU Make that are not present in other versions of make.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
50 GNU Make is very portable and easy to install.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
51
19158
9c28728a3041 * README: Mention INSTALL.OCTAVE instead of INSTALL.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
52 See the notes in the files INSTALL.OCTAVE and the system-specific README
9c28728a3041 * README: Mention INSTALL.OCTAVE instead of INSTALL.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
53 files in the etc directory of the Octave source distribution for more
9c28728a3041 * README: Mention INSTALL.OCTAVE instead of INSTALL.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
54 specific installation instructions.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
55
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
56 Bugs and Patches
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
57 ----------------
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
58
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
59 The file BUGS explains the recommended procedure for reporting bugs
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
60 or contributing patches.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
61
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
62 Documentation
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
63 -------------
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
64
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
65 Octave's manual has been revised for version 3.4, but it is lagging a
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
66 bit behind the development of the software. In particular, there is
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
67 currently no complete documentation of the C++ class libraries. If
11453
780a8b80c3e8 README: Update WWW links and disk space requirements.
Rik <octave@nomad.inbox5.com>
parents: 9031
diff changeset
68 you notice omissions or inconsistencies, please report them on the
15497
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 14138
diff changeset
69 bug tracker at http://bugs.octave.org. Specific suggestions for ways
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 14138
diff changeset
70 to improve Octave and its documentation are always welcome. Reports
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 14138
diff changeset
71 with patches are even more welcome.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
72
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
73 Additional Information
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
74 ----------------------
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
75
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
76 Up to date information about Octave is available on the WWW at the
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
77 URL http://www.octave.org, including archives of the help, bug, and
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
78 maintainers mailing lists.
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
79
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
80
12733
b67c2d580a25 maint: clean up top-level directory
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
81 Last updated: Fri, 10 Jun 2011 14:02:32 EDT