Mercurial > hg > octave-lyh

annotate doc/interpreter/octave-config.1 @ 17483:bddb9688e41c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
feather.m: Overhaul function for Matlab visual compatibility. * scripts/plot/feather.m: Reduce length of arrowhead size to 0.20 of arrow shaft. Change arrow head angle with shaft from 45 to 30 degrees. Use variable 'h' instead of 'retval' to match documentation. Redo input validation. Add %!error input validation tests.
author Rik <rik@octave.org>
date Tue, 24 Sep 2013 13:17:04 -0700
parents 72c96de7a403
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12341
diff changeset
1 .\" Copyright (C) 2003-2012 Dirk Eddelbuettel
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
2 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
3 .\" This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
4 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
5 .\" Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
6 .\" under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
7 .\" Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
8 .\" your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
9 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
10 .\" Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
13 .\" for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
14 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
15 .\" You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
16 .\" along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
17 .\" <http://www.gnu.org/licenses/>.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
18 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
19 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org>.
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
20 .\" This page was completely re-written by Rik <octave@nomad.inbox5.com>
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
21 .\" --------------------------------------------------------------------
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
22 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 .ft CW
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 .nf
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 ..
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 .ft R
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
28 .fi
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
29 ..
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
30 .\" --------------------------------------------------------------------
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
31 .TH OCTAVE-CONFIG 1 "4 February 2011" "GNU Octave"
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
32 .SH NAME
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
33 octave-config - GNU Octave component and library information retrieval
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
34 .SH SYNOPSIS
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
35 \fBoctave-config\fP [\fIOPTION\fP]...
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
36 .SH DESCRIPTION
5457
c6dc1ccd83a9 [project @ 2005-09-19 19:23:35 by jwe]
jwe
parents: 4781
diff changeset
37 .B octave-config
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
38 is a tool to obtain directory information for \fB.oct\fP and \fB.m\fP files for
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
39 .BR octave (1).
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
40 .SH OPTIONS
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
41 .TP 8
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 .B \-\-m-site-dir
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 Display the main directory for local, or site-specific, \fB.m\fP script files.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 .B \-\-oct-site-dir
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46 Display the main directory for local, or site-specific, \fB.oct\fP dynamic-link libraries.
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 .B \-p \fIVAR\fP\fR,\fB \-\-print \fIVAR\fP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49 Print the default value of the Octave configuration variable \fIVAR\fP.
4444
9a2206207402 [project @ 2003-07-07 20:04:53 by jwe]
jwe
parents: 4339
diff changeset
50 Recognized variables are:
9a2206207402 [project @ 2003-07-07 20:04:53 by jwe]
jwe
parents: 4339
diff changeset
51 .RS
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 .Vb
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 API_VERSION LOCALAPIOCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54 ARCHLIBDIR LOCALARCHLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 BINDIR LOCALFCNFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 CANONICAL_HOST_TYPE LOCALOCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 DATADIR LOCALSTARTUPFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 DATAROOTDIR LOCALVERARCHLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
59 DEFAULT_PAGER LOCALVERFCNFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 EXEC_PREFIX LOCALVEROCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 FCNFILEDIR MAN1DIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 IMAGEDIR MAN1EXT
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 INCLUDEDIR MANDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 INFODIR OCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
65 INFOFILE OCTINCLUDEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
66 LIBDIR OCTLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 LIBEXECDIR PREFIX
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68 LOCALAPIARCHLIBDIR STARTUPFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 LOCALAPIFCNFILEDIR VERSION
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
70 .Ve
4444
9a2206207402 [project @ 2003-07-07 20:04:53 by jwe]
jwe
parents: 4339
diff changeset
71 .RE
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
72 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
73 .B \-v\fR,\fB \-\-version
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
74 Display the version number of
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
75 .BR octave (1).
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
76 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
77 \fB\-h\fP, \fB\-?\fP, \fB\-\-help\fP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
78 Print help message.
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
79 .SH AUTHOR
9322
66fdc831c580 fix jwe email address
John W. Eaton <jwe@octave.org>
parents: 7018
diff changeset
80 John W. Eaton <jwe@octave.org>
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
81
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
82 This manual page was contributed by Dirk Eddelbuettel <edd@debian.org>
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
83 for the Debian GNU/Linux distribution but may be used by others.