Mercurial > octave

annotate doc/interpreter/octave.1 @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 .\" Copyright (C) 1996-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 .\"
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 .\" See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 .\" or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 .\"
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
6 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
7 .\" This file is part of Octave.
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
8 .\"
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 .\" Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
10 .\" under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 .\" the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 .\" (at your option) any later version.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
13 .\"
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
14 .\" Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
15 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 .\" GNU General Public License for more details.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
18 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
19 .\" You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
20 .\" along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 .\" <https://www.gnu.org/licenses/>.
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
22 .\"
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 .\" --------------------------------------------------------------------
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 .ft CW
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 .nf
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 ..
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
28 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
29 .ft R
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
30 .fi
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
31 ..
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
32 .\" --------------------------------------------------------------------
15543
57dd92260f09 doc: Use now standard 'online' rather than 'on-line' in man page.
Rik <rik@octave.org>
parents: 14138
diff changeset
33 .TH OCTAVE 1 "19 October 2012" "GNU Octave"
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
34 .SH NAME
3008
cc828a2ace0d [project @ 1997-05-30 20:18:47 by jwe]
jwe
parents: 2847
diff changeset
35 octave \- A high-level interactive language for numerical computations.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
36 .SH SYNOPSIS
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37 \fBoctave\fP [\fIoptions\fP]... [\fIfile\fP]
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
38 .SH DESCRIPTION
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
39 Octave is a high-level language, primarily intended for numerical
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
40 computations. It provides a convenient command line interface for
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
41 solving linear and nonlinear problems numerically.
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 .SH OPTIONS
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 The complete set of command-line options for \fBoctave\fP is available by
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 running the following command from the shell.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 .Vb
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47 octave \-\-help
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 .Ve
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
49 .SH DOCUMENTATION
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
50 The primary documentation for Octave is written using Texinfo, the GNU
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
51 documentation system, which allows the same source files to be used to
15543
57dd92260f09 doc: Use now standard 'online' rather than 'on-line' in man page.
Rik <rik@octave.org>
parents: 14138
diff changeset
52 produce online and printed versions of the manual.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
53 .PP
15543
57dd92260f09 doc: Use now standard 'online' rather than 'on-line' in man page.
Rik <rik@octave.org>
parents: 14138
diff changeset
54 You can read the online copy of the Octave documentation by issuing
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 the following command from within \fBoctave\fP.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 .Vb
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
57
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 octave:1> doc
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
59
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 .Ve
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 The Info files may also be read with a stand-alone program such as
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 \fBinfo\fP or \fBxinfo\fP. HTML, Postscript, or PDF versions of the
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 documentation are installed on many systems as well.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 .SH BUGS
25024
3c817af70eed maint: use https for all Octave project URLs
Mike Miller <mtmiller@octave.org>
parents: 24534
diff changeset
65 The Octave project maintains a bug tracker at https://bugs.octave.org.
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
66 Before submitting a new item please read the instructions at
25024
3c817af70eed maint: use https for all Octave project URLs
Mike Miller <mtmiller@octave.org>
parents: 24534
diff changeset
67 https://www.octave.org/bugs.html on how to submit a useful report.
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68 .SH FILES
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 Upon startup Octave looks for four initialization files. Each file
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
70 may contain any number of valid Octave commands.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
71 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
72 \fIoctave-home\fP/share/octave/site/m/startup/octaverc
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
73 Site-wide initialization file which changes options for all users.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
74 \fIoctave-home\fP is the directory where Octave was installed such as
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
75 \fB/usr/local\fP.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
76 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
77 \fIoctave-home\fP/share/octave/\fIversion\fP/m/startup/octaverc
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
78 Site-wide initialization file for Octave version \fIversion\fP.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
79 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
80 ~/.octaverc
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
81 User's personal initialization file.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
82 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
83 \&\.octaverc
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
84 Project-specific initialization file located in the current directory.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
85 .SH AUTHOR
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
86 John W. Eaton <jwe@octave.org>