Mercurial > octave-nkf

annotate doc/interpreter/octave-cli.1 @ 20595:c1a6c31ac29a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.
author John W. Eaton <jwe@octave.org>
date Tue, 06 Oct 2015 00:20:02 -0400
parents 8d7e45ea11fa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18213
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
1 .\" Copyright (C) 1996-2014 John W. Eaton
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
2 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
3 .\" This file is part of Octave.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
4 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
5 .\" Octave is free software; you can redistribute it and/or modify it
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
6 .\" under the terms of the GNU General Public License as published by the
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
7 .\" Free Software Foundation; either version 3 of the License, or (at
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
8 .\" your option) any later version.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
9 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
10 .\" Octave is distributed in the hope that it will be useful, but WITHOUT
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
13 .\" for more details.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
14 .\"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
15 .\" 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
16 .\" along with Octave; see the file COPYING. If not, see
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
17 .\" <http://www.gnu.org/licenses/>.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
18 .\" --------------------------------------------------------------------
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
19 .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
20 .ft CW
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
21 .nf
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
22 ..
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
23 .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
24 .ft R
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
25 .fi
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
26 ..
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
27 .\" --------------------------------------------------------------------
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
28 .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
29 .SH NAME
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
30 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
31 .SH SYNOPSIS
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
32 \fBoctave-cli\fP [\fIoptions\fP]... [\fIfile\fP]
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
33 .SH DESCRIPTION
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
34 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
35 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
36 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
37 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
38 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
39 providing just the command line interface (CLI).
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
40 .SH OPTIONS
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
41 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
42 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
43 .Vb
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
44
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
45 octave-cli \-\-help
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
46 .Ve
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
47 .SH DOCUMENTATION
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
48 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
49 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
50 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
51 .PP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
52 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
53 the following command from within Octave.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
54 .Vb
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
55
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
56 octave:1> doc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
57
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
58 .Ve
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
59 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
60 \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
61 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
62 .SH BUGS
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
63 The Octave project maintains a bug tracker at http://bugs.octave.org.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
64 Before submitting a new item please read the instructions at
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
65 http://www.octave.org/bugs.html on how to submit a useful report.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
66 .SH FILES
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
67 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
68 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
69 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
70 \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
71 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
72 \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
73 \fB/usr/local\fP.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
74 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
75 \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
76 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
77 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
78 ~/.octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
79 User's personal initialization file.
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
80 .TP
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
81 \&\.octaverc
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
82 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
83 .SH AUTHOR
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
84 John W. Eaton <jwe@octave.org>
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
85 .SH SEE ALSO
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
diff changeset
86 octave (1)