Mercurial > octave

annotate doc/interpreter/octave-cli.1 @ 31246:43a6be589387

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: New documentation for memoization techniques (bug #60860) vectorize.texi: New section on memoization octave.texi: List new section
author Arun Giridhar <arungiridhar@gmail.com>
date Thu, 29 Sep 2022 20:31:52 -0400
parents 796f54d4ddbf
children 597f3ee61a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 .\" ---------------------------------------------------------------------
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 .\"
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
3 .\" Copyright (C) 1996-2022 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
4 .\"
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 .\" See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 .\" or <https://octave.org/copyright/>.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
7 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
8 .\" This file is part of Octave.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
9 .\"
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 .\" 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
11 .\" 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
12 .\" 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
13 .\" (at your option) any later version.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
14 .\"
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
15 .\" 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
16 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 .\" GNU General Public License for more details.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
19 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
20 .\" You should have received a copy of the GNU General Public License
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
21 .\" 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
22 .\" <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 .\"
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
24 .\" --------------------------------------------------------------------
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
25 .\"
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
26 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
27 .ft CW
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
28 .nf
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
29 ..
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
30 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
31 .ft R
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
32 .fi
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
33 ..
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
34 .\" --------------------------------------------------------------------
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
35 .TH OCTAVE-CLI 1 "03 January 2014" "GNU Octave"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
36 .SH NAME
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
37 octave-cli \- A high-level interactive language for numerical computations.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
38 .SH SYNOPSIS
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
39 \fBoctave-cli\fP [\fIoptions\fP]... [\fIfile\fP]
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
40 .SH DESCRIPTION
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
41 Octave is a high-level language, primarily intended for numerical
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
42 computations. It provides a convenient command line interface for
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
43 solving linear and nonlinear problems numerically. \fBoctave-cli\fP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
44 has been compiled without any GUI support (Qt) which makes it smaller
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
45 than the default \fBoctave\fP executable, but also limits it to
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
46 providing just the command line interface (CLI).
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
47 .SH OPTIONS
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
48 The complete set of command-line options for \fBoctave-cli\fP is available
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
49 by running the following command from the shell.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
50 .Vb
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
51
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
52 octave-cli \-\-help
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
53 .Ve
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
54 .SH DOCUMENTATION
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
55 The primary documentation for Octave is written using Texinfo, the GNU
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
56 documentation system, which allows the same source files to be used to
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
57 produce online and printed versions of the manual.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
58 .PP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
59 You can read the online copy of the Octave documentation by issuing
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
60 the following command from within Octave.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
61 .Vb
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
62
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
63 octave:1> doc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
64
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
65 .Ve
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
66 The Info files may also be read with a stand-alone program such as
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
67 \fBinfo\fP or \fBxinfo\fP. HTML, Postscript, or PDF versions of the
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
68 documentation are installed on many systems as well.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
69 .SH BUGS
25024
3c817af70eed maint: use https for all Octave project URLs
Mike Miller <mtmiller@octave.org>
parents: 24534
diff changeset
70 The Octave project maintains a bug tracker at https://bugs.octave.org.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
71 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
72 https://www.octave.org/bugs.html on how to submit a useful report.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
73 .SH FILES
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
74 Upon startup Octave looks for four initialization files. Each file
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
75 may contain any number of valid Octave commands.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
76 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
77 \fIoctave-home\fP/share/octave/site/m/startup/octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
78 Site-wide initialization file which changes options for all users.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
79 \fIoctave-home\fP is the directory where Octave was installed such as
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
80 \fB/usr/local\fP.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
81 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
82 \fIoctave-home\fP/share/octave/\fIversion\fP/m/startup/octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
83 Site-wide initialization file for Octave version \fIversion\fP.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
84 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
85 ~/.octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
86 User's personal initialization file.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
87 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
88 \&\.octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
89 Project-specific initialization file located in the current directory.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
90 .SH AUTHOR
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
91 John W. Eaton <jwe@octave.org>
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
92 .SH SEE ALSO
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
93 octave (1)