Mercurial > hg > octave-lyh

comparison doc/interpreter/octave.1 @ 12341:402456ba3f61

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
comparison
equal deleted inserted replaced
12340:d63007ac067a 12341:402456ba3f61
13 .\" for more details. 13 .\" for more details.
14 .\" 14 .\"
15 .\" You should have received a copy of the GNU General Public License 15 .\" You should have received a copy of the GNU General Public License
16 .\" along with Octave; see the file COPYING. If not, see 16 .\" along with Octave; see the file COPYING. If not, see
17 .\" <http://www.gnu.org/licenses/>. 17 .\" <http://www.gnu.org/licenses/>.
18 .\" 18 .\" --------------------------------------------------------------------
19 .TH Octave 1 "Jan 8 1996" 19 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
20 .ft CW
21 .nf
22 ..
23 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
24 .ft R
25 .fi
26 ..
27 .\" --------------------------------------------------------------------
28 .TH OCTAVE 1 "4 February 2011" "GNU Octave"
20 .SH NAME 29 .SH NAME
21 octave \- A high-level interactive language for numerical computations. 30 octave \- A high-level interactive language for numerical computations.
22 .SH SYNOPSIS 31 .SH SYNOPSIS
23 .nf 32 \fBoctave\fP [\fIoptions\fP]... [\fIfile\fP]
24 octave [options]
25 .fi
26 .SH OPTIONS
27 The complete set of command-line options for octave is available by
28 running the command
29 .nf
30
31 octave \-\-help
32
33 .fi
34 .SH DESCRIPTION 33 .SH DESCRIPTION
35 Octave is a high-level language, primarily intended for numerical 34 Octave is a high-level language, primarily intended for numerical
36 computations. It provides a convenient command line interface for 35 computations. It provides a convenient command line interface for
37 solving linear and nonlinear problems numerically. 36 solving linear and nonlinear problems numerically.
37 .SH OPTIONS
38 The complete set of command-line options for \fBoctave\fP is available by
39 running the following command from the shell.
40 .Vb
41
42 octave \-\-help
43 .Ve
38 .SH DOCUMENTATION 44 .SH DOCUMENTATION
39 The primary documentation for Octave is written using Texinfo, the GNU 45 The primary documentation for Octave is written using Texinfo, the GNU
40 documentation system, which allows the same source files to be used to 46 documentation system, which allows the same source files to be used to
41 produce on-line and printed versions of the manual. 47 produce on-line and printed versions of the manual.
42 .PP 48 .PP
43 You can read the on-line copy of the Octave documentation by issuing 49 You can read the on-line copy of the Octave documentation by issuing
44 the command 50 the following command from within \fBoctave\fP.
45 .nf 51 .Vb
46 52
47 octave:13> help \-i 53 octave:1> doc
48 54
49 .fi 55 .Ve
50 while running Octave interactively, by using the GNU Emacs info mode, 56 The Info files may also be read with a stand-alone program such as
51 or by running standalone programs like info or xinfo. 57 \fBinfo\fP or \fBxinfo\fP. HTML, Postscript, or PDF versions of the
58 documentation are installed on many systems as well.
52 .SH BUGS 59 .SH BUGS
53 The best way to submit a bug report for Octave is to use the command 60 The Octave project maintains a bug tracker at http://bugs.octave.org.
54 .nf 61 Before submitting a new item please read the instructions at
55 62 http://www.octave.org/bugs.html on how to submit a useful report.
56 octave:13> bug_report 63 .SH FILES
57 64 Upon startup Octave looks for four initialization files. Each file
58 .fi 65 may contain any number of valid Octave commands.
59 while running Octave interactively. This will create a template bug 66 .TP
60 report file and start an editor on that file. Your 67 \fIoctave-home\fP/share/octave/site/m/startup/octaverc
61 message will be sent to the bug-octave mailing list 68 Site-wide initialization file which changes options for all users.
62 once you are finished editing the template. 69 \fIoctave-home\fP is the directory where Octave was installed such as
63 .PP 70 \fB/usr/local\fP.
64 If you are unable to use the bug_report command, send your message 71 .TP
65 to the 72 \fIoctave-home\fP/share/octave/\fIversion\fP/m/startup/octaverc
66 .B bug@octave.org 73 Site-wide initialization file for Octave version \fIversion\fP.
67 mailing list by some other means. Please read the `Bugs' chapter in 74 .TP
68 the Octave manual to find out how to submit a bug report that will 75 ~/.octaverc
69 enable the Octave maintainers to fix the problem. 76 User's personal initialization file.
77 .TP
78 \&\.octaverc
79 Project-specific initialization file located in the current directory.
70 .SH AUTHOR 80 .SH AUTHOR
71 .nf 81 John W. Eaton <jwe@octave.org>
72 John W. Eaton
73 <jwe@octave.org>
74 .fi