Mercurial > octave

annotate doc/interpreter/octave-config.1 @ 31225:3eab70385569

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sparse-xpow.cc: Use faster multiplication technique, this time for complex
author Arun Giridhar <arungiridhar@gmail.com>
date Sun, 11 Sep 2022 13:53:38 -0400
parents 796f54d4ddbf
children 597f3ee61a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 .\" --------------------------------------------------------------------
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 .\"
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
3 .\" Copyright (C) 2003-2022 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 .\"
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 .\" See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 .\" or <https://octave.org/copyright/>.
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
7 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
8 .\" This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
9 .\"
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 .\" Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
11 .\" under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 .\" the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 .\" (at your option) any later version.
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
14 .\"
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
15 .\" Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 .\" GNU General Public License for more details.
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
19 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
20 .\" 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
21 .\" along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 .\" <https://www.gnu.org/licenses/>.
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 5921
diff changeset
23 .\"
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 .\" --------------------------------------------------------------------
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
25 .\"
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 .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
27 .ft CW
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
28 .nf
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 .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
31 .ft R
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
32 .fi
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
33 ..
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
34 .\" --------------------------------------------------------------------
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents: 17744
diff changeset
35 .TH OCTAVE-CONFIG 1 "3 January 2014" "GNU Octave"
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
36 .SH NAME
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
37 octave-config - GNU Octave component and library information retrieval
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
38 .SH SYNOPSIS
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
39 \fBoctave-config\fP [\fIOPTION\fP]...
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
40 .SH DESCRIPTION
5457
c6dc1ccd83a9 [project @ 2005-09-19 19:23:35 by jwe]
jwe
parents: 4781
diff changeset
41 .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
42 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
43 .BR octave (1).
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
44 .SH OPTIONS
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
45 .TP 8
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46 .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
47 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
48 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49 .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
50 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
51 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 .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
53 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
54 Recognized variables are:
9a2206207402 [project @ 2003-07-07 20:04:53 by jwe]
jwe
parents: 4339
diff changeset
55 .RS
12341
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 .Vb
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 API_VERSION LOCALAPIOCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 ARCHLIBDIR LOCALARCHLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
59 BINDIR LOCALFCNFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 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
61 DATADIR LOCALSTARTUPFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 DATAROOTDIR LOCALVERARCHLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 DEFAULT_PAGER LOCALVERFCNFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 EXEC_PREFIX LOCALVEROCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
65 FCNFILEDIR MAN1DIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
66 IMAGEDIR MAN1EXT
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 INCLUDEDIR MANDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68 INFODIR OCTFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 INFOFILE OCTINCLUDEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
70 LIBDIR OCTLIBDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
71 LIBEXECDIR PREFIX
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
72 LOCALAPIARCHLIBDIR STARTUPFILEDIR
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
73 LOCALAPIFCNFILEDIR VERSION
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
74 .Ve
4444
9a2206207402 [project @ 2003-07-07 20:04:53 by jwe]
jwe
parents: 4339
diff changeset
75 .RE
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 .B \-v\fR,\fB \-\-version
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18214
diff changeset
78 Display the version number of
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
79 .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
80 .TP
402456ba3f61 Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
81 \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
82 Print help message.
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
83 .SH AUTHOR
9322
66fdc831c580 fix jwe email address
John W. Eaton <jwe@octave.org>
parents: 7018
diff changeset
84 John W. Eaton <jwe@octave.org>
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
85
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18214
diff changeset
86 This manual page was contributed by Dirk Eddelbuettel <edd@debian.org>
4339
05ba2a8757da [project @ 2003-02-20 01:40:58 by jwe]
jwe
parents:
diff changeset
87 for the Debian GNU/Linux distribution but may be used by others.
18214
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents: 17744
diff changeset
88 .SH "SEE ALSO"
8d7e45ea11fa doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents: 17744
diff changeset
89 octave (1).