Mercurial > octave
annotate doc/interpreter/octave-config.1 @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
rev | line source |
---|---|
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
1 .\" Copyright (C) 2003-2020 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
|
2 .\" |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
3 .\" See the file COPYRIGHT.md in the top-level directory of this distribution |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 .\" or <https://octave.org/COPYRIGHT.html/>. |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
5 .\" |
7018 | 6 .\" |
7 .\" This file is part of Octave. | |
8 .\" | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
9 .\" 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
|
10 .\" 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
|
11 .\" 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
|
12 .\" (at your option) any later version. |
7018 | 13 .\" |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
14 .\" 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
|
15 .\" WITHOUT ANY WARRANTY; without even the implied warranty of |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 .\" GNU General Public License for more details. |
7018 | 18 .\" |
19 .\" You should have received a copy of the GNU General Public License | |
20 .\" 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
|
21 .\" <https://www.gnu.org/licenses/>. |
7018 | 22 .\" |
12341
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
23 .\" -------------------------------------------------------------------- |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
24 .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
|
25 .ft CW |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
26 .nf |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
27 .. |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
28 .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
|
29 .ft R |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
30 .fi |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
31 .. |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
32 .\" -------------------------------------------------------------------- |
18214
8d7e45ea11fa
doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
33 .TH OCTAVE-CONFIG 1 "3 January 2014" "GNU Octave" |
4339 | 34 .SH NAME |
35 octave-config - GNU Octave component and library information retrieval | |
36 .SH SYNOPSIS | |
12341
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
37 \fBoctave-config\fP [\fIOPTION\fP]... |
4339 | 38 .SH DESCRIPTION |
5457 | 39 .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
|
40 is a tool to obtain directory information for \fB.oct\fP and \fB.m\fP files for |
4339 | 41 .BR octave (1). |
42 .SH OPTIONS | |
43 .TP 8 | |
12341
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
44 .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
|
45 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
|
46 .TP |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
47 .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
|
48 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
|
49 .TP |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
50 .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
|
51 Print the default value of the Octave configuration variable \fIVAR\fP. |
4444 | 52 Recognized variables are: |
53 .RS | |
12341
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 .Vb |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
55 API_VERSION LOCALAPIOCTFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
56 ARCHLIBDIR LOCALARCHLIBDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 BINDIR LOCALFCNFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
58 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
|
59 DATADIR LOCALSTARTUPFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
60 DATAROOTDIR LOCALVERARCHLIBDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
61 DEFAULT_PAGER LOCALVERFCNFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
62 EXEC_PREFIX LOCALVEROCTFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
63 FCNFILEDIR MAN1DIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
64 IMAGEDIR MAN1EXT |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
65 INCLUDEDIR MANDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
66 INFODIR OCTFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
67 INFOFILE OCTINCLUDEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
68 LIBDIR OCTLIBDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
69 LIBEXECDIR PREFIX |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
70 LOCALAPIARCHLIBDIR STARTUPFILEDIR |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
71 LOCALAPIFCNFILEDIR VERSION |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
72 .Ve |
4444 | 73 .RE |
12341
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
74 .TP |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
75 .B \-v\fR,\fB \-\-version |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18214
diff
changeset
|
76 Display the version number of |
4339 | 77 .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
|
78 .TP |
402456ba3f61
Overhaul usage strings and man pages for octave, octave-config, mkoctfile.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
79 \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
|
80 Print help message. |
4339 | 81 .SH AUTHOR |
9322 | 82 John W. Eaton <jwe@octave.org> |
4339 | 83 |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18214
diff
changeset
|
84 This manual page was contributed by Dirk Eddelbuettel <edd@debian.org> |
4339 | 85 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
|
86 .SH "SEE ALSO" |
8d7e45ea11fa
doc: Add new octave-cli man page (bug #41085).
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
87 octave (1). |