Mercurial > octave
comparison doc/interpreter/octave-cli.1 @ 18214:8d7e45ea11fa stable
doc: Add new octave-cli man page (bug #41085).
* octave-cli.1: New man page.
* doc/interpreter/Makefile.am: Add octave-cli.1 to build system.
* mkoctfile.1: Move "SEE ALSO" section to end of man page.
*octave-config.1: Add "SEE ALSO" section to end of man page.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 03 Jan 2014 19:30:12 -0800 |
| parents | |
| children | bac0d6f07a3e |
comparison
equal
deleted
inserted
replaced
| 18210:a0abcf377ec5 | 18214:8d7e45ea11fa |
|---|---|
| 1 .\" Copyright (C) 1996-2014 John W. Eaton | |
| 2 .\" | |
| 3 .\" This file is part of Octave. | |
| 4 .\" | |
| 5 .\" Octave is free software; you can redistribute it and/or modify it | |
| 6 .\" under the terms of the GNU General Public License as published by the | |
| 7 .\" Free Software Foundation; either version 3 of the License, or (at | |
| 8 .\" your option) any later version. | |
| 9 .\" | |
| 10 .\" Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 .\" for more details. | |
| 14 .\" | |
| 15 .\" You should have received a copy of the GNU General Public License | |
| 16 .\" along with Octave; see the file COPYING. If not, see | |
| 17 .\" <http://www.gnu.org/licenses/>. | |
| 18 .\" -------------------------------------------------------------------- | |
| 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-CLI 1 "03 January 2014" "GNU Octave" | |
| 29 .SH NAME | |
| 30 octave-cli \- A high-level interactive language for numerical computations. | |
| 31 .SH SYNOPSIS | |
| 32 \fBoctave-cli\fP [\fIoptions\fP]... [\fIfile\fP] | |
| 33 .SH DESCRIPTION | |
| 34 Octave is a high-level language, primarily intended for numerical | |
| 35 computations. It provides a convenient command line interface for | |
| 36 solving linear and nonlinear problems numerically. \fBoctave-cli\fP | |
| 37 has been compiled without any GUI support (Qt) which makes it smaller | |
| 38 than the default \fBoctave\fP executable, but also limits it to | |
| 39 providing just the command line interface (CLI). | |
| 40 .SH OPTIONS | |
| 41 The complete set of command-line options for \fBoctave-cli\fP is available | |
| 42 by running the following command from the shell. | |
| 43 .Vb | |
| 44 | |
| 45 octave-cli \-\-help | |
| 46 .Ve | |
| 47 .SH DOCUMENTATION | |
| 48 The primary documentation for Octave is written using Texinfo, the GNU | |
| 49 documentation system, which allows the same source files to be used to | |
| 50 produce online and printed versions of the manual. | |
| 51 .PP | |
| 52 You can read the online copy of the Octave documentation by issuing | |
| 53 the following command from within Octave. | |
| 54 .Vb | |
| 55 | |
| 56 octave:1> doc | |
| 57 | |
| 58 .Ve | |
| 59 The Info files may also be read with a stand-alone program such as | |
| 60 \fBinfo\fP or \fBxinfo\fP. HTML, Postscript, or PDF versions of the | |
| 61 documentation are installed on many systems as well. | |
| 62 .SH BUGS | |
| 63 The Octave project maintains a bug tracker at http://bugs.octave.org. | |
| 64 Before submitting a new item please read the instructions at | |
| 65 http://www.octave.org/bugs.html on how to submit a useful report. | |
| 66 .SH FILES | |
| 67 Upon startup Octave looks for four initialization files. Each file | |
| 68 may contain any number of valid Octave commands. | |
| 69 .TP | |
| 70 \fIoctave-home\fP/share/octave/site/m/startup/octaverc | |
| 71 Site-wide initialization file which changes options for all users. | |
| 72 \fIoctave-home\fP is the directory where Octave was installed such as | |
| 73 \fB/usr/local\fP. | |
| 74 .TP | |
| 75 \fIoctave-home\fP/share/octave/\fIversion\fP/m/startup/octaverc | |
| 76 Site-wide initialization file for Octave version \fIversion\fP. | |
| 77 .TP | |
| 78 ~/.octaverc | |
| 79 User's personal initialization file. | |
| 80 .TP | |
| 81 \&\.octaverc | |
| 82 Project-specific initialization file located in the current directory. | |
| 83 .SH AUTHOR | |
| 84 John W. Eaton <jwe@octave.org> | |
| 85 .SH SEE ALSO | |
| 86 octave (1) |