Mercurial > octave-nkf

comparison doc/interpreter/octave-config.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
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 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org>. 19 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org>.
20 .\" 20 .\" This page was completely re-written by Rik <octave@nomad.inbox5.com>
21 .TH OCTAVE-CONFIG 1 "19 February 2003" "GNU Octave" 21 .\" --------------------------------------------------------------------
22 .de Vb \" (V)erbatim (b)egin. Use fixed width font and no justification
23 .ft CW
24 .nf
25 ..
26 .de Ve \" (V)erbatim (e)nd. Return to regular font and justification
27 .ft R
28 .fi
29 ..
30 .\" --------------------------------------------------------------------
31 .TH OCTAVE-CONFIG 1 "4 February 2011" "GNU Octave"
22 .SH NAME 32 .SH NAME
23 octave-config - GNU Octave component and library information retrieval 33 octave-config - GNU Octave component and library information retrieval
24 .SH SYNOPSIS 34 .SH SYNOPSIS
35 \fBoctave-config\fP [\fIOPTION\fP]...
36 .SH DESCRIPTION
25 .B octave-config 37 .B octave-config
26 .RI [ options ] 38 is a tool to obtain directory information for \fB.oct\fP and \fB.m\fP files for
27 .SH DESCRIPTION
28 .PP
29 .B octave-config
30 is a tool to obtain directory information for
31 .I .oct
32 and
33 .I .m
34 files for
35 .BR octave (1). 39 .BR octave (1).
36 .SH OPTIONS 40 .SH OPTIONS
37 .B octave-config
38 accepts the following options:
39 .TP 8 41 .TP 8
40 .B \--m-site-dir 42 .B \-\-m-site-dir
41 Display the main directory for local, or site-specific, .m script files. 43 Display the main directory for local, or site-specific, \fB.m\fP script files.
42 .TP 8 44 .TP
43 .B \--oct-site-dir 45 .B \-\-oct-site-dir
44 Display the main directory for local, or site-specific, .oct dynamic-link libraries. 46 Display the main directory for local, or site-specific, \fB.oct\fP dynamic-link libraries.
45 .TP 8 47 .TP
46 .B \-p|\-\-print VAR 48 .B \-p \fIVAR\fP\fR,\fB \-\-print \fIVAR\fP
47 Print the default value of the Octave configuration variable VAR. 49 Print the default value of the Octave configuration variable \fIVAR\fP.
48 Recognized variables are: 50 Recognized variables are:
49 .RS 51 .RS
50 CANONICAL_HOST_TYPE LOCALFCNFILEDIR 52 .Vb
51 DEFAULT_PAGER LOCALFCNFILEPATH 53 API_VERSION LOCALAPIOCTFILEDIR
52 ARCHLIBDIR LOCALOCTFILEDIR 54 ARCHLIBDIR LOCALARCHLIBDIR
53 BINDIR LOCALOCTFILEPATH 55 BINDIR LOCALFCNFILEDIR
54 DATADIR LOCALSTARTUPFILEDIR 56 CANONICAL_HOST_TYPE LOCALOCTFILEDIR
55 EXEC_PREFIX LOCALVERARCHLIBDIR 57 DATADIR LOCALSTARTUPFILEDIR
56 FCNFILEDIR LOCALVERFCNFILEDIR 58 DATAROOTDIR LOCALVERARCHLIBDIR
57 FCNFILEPATH LOCALVEROCTFILEDIR 59 DEFAULT_PAGER LOCALVERFCNFILEDIR
58 IMAGEDIR MAN1DIR 60 EXEC_PREFIX LOCALVEROCTFILEDIR
59 IMAGE_PATH MAN1EXT 61 FCNFILEDIR MAN1DIR
60 INCLUDEDIR MANDIR 62 IMAGEDIR MAN1EXT
61 INFODIR OCTFILEDIR 63 INCLUDEDIR MANDIR
62 INFOFILE OCTINCLUDEDIR 64 INFODIR OCTFILEDIR
63 LIBDIR OCTLIBDIR 65 INFOFILE OCTINCLUDEDIR
64 LIBEXECDIR PREFIX 66 LIBDIR OCTLIBDIR
65 LIBEXECDIR STARTUPFILEDIR 67 LIBEXECDIR PREFIX
66 LOCALARCHLIBDIR VERSION 68 LOCALAPIARCHLIBDIR STARTUPFILEDIR
69 LOCALAPIFCNFILEDIR VERSION
70 .Ve
67 .RE 71 .RE
68 .TP 8 72 .TP
69 .B \-v|\-\-version 73 .B \-v\fR,\fB \-\-version
70 Display the version number of 74 Display the version number of
71 .BR octave (1). 75 .BR octave (1).
72 .TP 8 76 .TP
73 .B \-h|-?|--help 77 \fB\-h\fP, \fB\-?\fP, \fB\-\-help\fP
74 Display a help page about 78 Print help message.
75 .B octave-config
76 .SH AUTHOR 79 .SH AUTHOR
77 John W. Eaton <jwe@octave.org> 80 John W. Eaton <jwe@octave.org>
78 81
79 This manual page was contributed by Dirk Eddelbuettel <edd@debian.org> 82 This manual page was contributed by Dirk Eddelbuettel <edd@debian.org>
80 for the Debian GNU/Linux distribution but may be used by others. 83 for the Debian GNU/Linux distribution but may be used by others.