Mercurial > octave-nkf

annotate doc/interpreter/octave.1 @ 12374:2186c54528c4 release-3-4-x

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
author Rik <octave@nomad.inbox5.com>
date Sat, 05 Feb 2011 11:51:18 -0800
parents fd0a3ac60b0e
children 72c96de7a403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9322
diff changeset
1 .\" Copyright (C) 1996-2011 John W. Eaton
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
2 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
3 .\" This file is part of Octave.
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
4 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
5 .\" Octave is free software; you can redistribute it and/or modify it
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
6 .\" 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
7 .\" Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
8 .\" your option) any later version.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
9 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
10 .\" Octave is distributed in the hope that it will be useful, but WITHOUT
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
13 .\" for more details.
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
14 .\"
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
15 .\" 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
16 .\" along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
17 .\" <http://www.gnu.org/licenses/>.
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
18 .\" --------------------------------------------------------------------
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
19 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
20 .ft CW
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
21 .nf
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
22 ..
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 .ft R
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 .fi
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 ..
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 .\" --------------------------------------------------------------------
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
28 .TH OCTAVE 1 "4 February 2011" "GNU Octave"
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
29 .SH NAME
3008
cc828a2ace0d [project @ 1997-05-30 20:18:47 by jwe]
jwe
parents: 2847
diff changeset
30 octave \- A high-level interactive language for numerical computations.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
31 .SH SYNOPSIS
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
32 \fBoctave\fP [\fIoptions\fP]... [\fIfile\fP]
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
33 .SH DESCRIPTION
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
34 Octave is a high-level language, primarily intended for numerical
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
35 computations. It provides a convenient command line interface for
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
36 solving linear and nonlinear problems numerically.
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37 .SH OPTIONS
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
38 The complete set of command-line options for \fBoctave\fP is available by
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
39 running the following command from the shell.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
40 .Vb
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
41
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 octave \-\-help
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 .Ve
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
44 .SH DOCUMENTATION
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
45 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
46 documentation system, which allows the same source files to be used to
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
47 produce on-line and printed versions of the manual.
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
48 .PP
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
49 You can read the on-line copy of the Octave documentation by issuing
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
50 the following command from within \fBoctave\fP.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
51 .Vb
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
52
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 octave:1> doc
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
54
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 .Ve
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 The Info files may also be read with a stand-alone program such as
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 \fBinfo\fP or \fBxinfo\fP. HTML, Postscript, or PDF versions of the
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 documentation are installed on many systems as well.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
59 .SH BUGS
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 The Octave project maintains a bug tracker at http://bugs.octave.org.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 Before submitting a new item please read the instructions at
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 http://www.octave.org/bugs.html on how to submit a useful report.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 .SH FILES
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 Upon startup Octave looks for four initialization files. Each file
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
65 may contain any number of valid Octave commands.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
66 .TP
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 \fIoctave-home\fP/share/octave/site/m/startup/octaverc
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68 Site-wide initialization file which changes options for all users.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 \fIoctave-home\fP is the directory where Octave was installed such as
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
70 \fB/usr/local\fP.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
71 .TP
2186c54528c4 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/\fIversion\fP/m/startup/octaverc
2186c54528c4 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 for Octave version \fIversion\fP.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
74 .TP
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
75 ~/.octaverc
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
76 User's personal initialization file.
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
77 .TP
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
78 \&\.octaverc
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
79 Project-specific initialization file located in the current directory.
2333
b1a56412c385 [project @ 1996-07-19 02:20:16 by jwe]
jwe
parents:
diff changeset
80 .SH AUTHOR
12374
2186c54528c4 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
81 John W. Eaton <jwe@octave.org>