annotate doc/interpreter/mkoctfile.1 @ 12254:23385f2c90b7 release-3-4-x

whitespace fixes
author John W. Eaton <jwe@octave.org>
date Wed, 26 Jan 2011 23:49:42 -0500
parents fd0a3ac60b0e
children 402456ba3f61
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9322
diff changeset
1 .\" Copyright (C) 2000-2011 Dirk Eddelbuettel
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
2 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
3 .\" This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
4 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
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: 6294
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: 6294
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: 6294
diff changeset
8 .\" your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
9 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
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: 6294
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: 6294
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: 6294
diff changeset
13 .\" for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
14 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
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: 6294
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: 6294
diff changeset
17 .\" <http://www.gnu.org/licenses/>.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
18 .\"
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
19 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org>
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6294
diff changeset
20 .\"
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
21 .TH MKOCTFILE 1 "1 November 2002" "GNU Octave"
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
22 .SH NAME
7595
90ad1f69ca9d Escape "-" signs that mean the "minus" character
Rafael Laboissiere <rafael@debian.org>
parents: 7018
diff changeset
23 mkoctfile \- Compile dynamic-load modules for GNU Octave
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
24 .SH SYNOPSIS
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
25 .BR mkoctfile\ [\-IDIR]\ [\-DDEF]\ [\-lLIB]\ [\-LDIR]\ [\-M|\-\-depend]
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
26 \ [\-c]\ [\-o FILE|\-\-output FILE]\ [\-p VAR|\-\-print VAR]\ [\-s|\-\-strip]
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
27 \ [\-v|\-\-verbose]\ [\-h|\-?|\-\-help]\ \fIfile\fP .\|.\|.
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
28 .SH DESCRIPTION
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
29 .PP
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
30 \fImkoctfile\fP is used to compile source C, C++ or Fortran source code in
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
31 dynamically loadable
4672
2c5adf308c84 [project @ 2003-12-09 19:42:24 by jwe]
jwe
parents: 4149
diff changeset
32 .I .oct
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
33 file for
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
34 .BR octave (1).
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
35 .SH OPTIONS
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
36 \fImkoctfile\fP accepts the following options:
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
37 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
38 .B \-IDIR
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
39 Add include directory DIR to compile commands.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
40 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
41 .B \-DDEF
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
42 Add definition DEF to compiler call.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
43 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
44 .B \-lLIB
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
45 Add library LIB to link command.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
46 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
47 .B \-LDIR
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
48 Add library directory DIR to link command.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
49 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
50 .B \-M|\-\-depend
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
51 Generate dependency files (.d) for C and C++ source files.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
52 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
53 .B \-c
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
54 Compile but do not link.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
55 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
56 .B \-o FILE|\-\-output FILE
7595
90ad1f69ca9d Escape "-" signs that mean the "minus" character
Rafael Laboissiere <rafael@debian.org>
parents: 7018
diff changeset
57 Output file name; default extension is .oct (or .mex if \-\-mex is
5864
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5745
diff changeset
58 specified) unless linking a stand-alone executable.
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
59 .TP
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
60 .B \-p VAR|\-\-print VAR
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
61 Print configuration variable VAR. Recognized variables are:
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
62 .RS
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
63 ALL_CFLAGS FFTW_LIBS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
64 ALL_CXXFLAGS FLIBS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
65 ALL_FFLAGS FPICFLAG
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
66 ALL_LDFLAGS INCFLAGS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
67 BLAS_LIBS LDFLAGS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
68 CC LD_CXX
5669
602d084346b2 [project @ 2006-03-15 17:15:01 by jwe]
jwe
parents: 4781
diff changeset
69 CFLAGS LD_STATIC_FLAG
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
70 CPICFLAG LFLAGS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
71 CPPFLAGS LIBCRUFT
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
72 CXX LIBOCTAVE
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
73 CXXFLAGS LIBOCTINTERP
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
74 CXXPICFLAG LIBREADLINE
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
75 DEPEND_EXTRA_SED_PATTERN LIBS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
76 DEPEND_FLAGS OCTAVE_LIBS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
77 DL_LD RDYNAMIC_FLAG
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
78 DL_LDFLAGS RLD_FLAG
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
79 F2C SED
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
80 F2CFLAGS XTRA_CFLAGS
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
81 F77 XTRA_CXXFLAGS
5669
602d084346b2 [project @ 2006-03-15 17:15:01 by jwe]
jwe
parents: 4781
diff changeset
82 FFLAGS
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
83 .RE
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
84 .TP 8
5745
0559ebb94bf0 [project @ 2006-04-06 20:33:40 by jwe]
jwe
parents: 5669
diff changeset
85 .B \-\-link-stand-alone
0559ebb94bf0 [project @ 2006-04-06 20:33:40 by jwe]
jwe
parents: 5669
diff changeset
86 Link a stand-alone executable file.
6024
500d884ae373 [project @ 2006-10-03 14:27:33 by jwe]
jwe
parents: 5864
diff changeset
87 .TP 8
5864
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5745
diff changeset
88 .B \-\-mex
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5745
diff changeset
89 Assume we are creating a MEX file. Set the default output extension
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5745
diff changeset
90 to .mex.
5745
0559ebb94bf0 [project @ 2006-04-06 20:33:40 by jwe]
jwe
parents: 5669
diff changeset
91 .TP 8
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
92 .B \-s|--strip
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
93 Strip the output file.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
94 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
95 .B \-v|--verbose
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
96 Echo commands as they are executed.
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
97 .TP 8
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
98 .B file
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
99 Compile or link file. Recognised file types are
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
100 .RS
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
101 .c C source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
102 .cc C++ source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
103 .C C++ source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
104 .cpp C++ source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
105 .f Fortran source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
106 .F Fortran source
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
107 .o object file
6294
fa02b0b467b5 [project @ 2007-02-09 22:01:37 by jwe]
jwe
parents: 6024
diff changeset
108 .a library file
7647
7b382848a18f Remove spurious whitespace before macros
Rafael Laboissiere <rafael@debian.org>
parents: 7595
diff changeset
109 .SH SEE ALSO
7b382848a18f Remove spurious whitespace before macros
Rafael Laboissiere <rafael@debian.org>
parents: 7595
diff changeset
110 .BR octave (1).
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
111 .RE
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
112 .SH AUTHOR
9322
66fdc831c580 fix jwe email address
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
113 John W. Eaton <jwe@octave.org>
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
114
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
115 This manual page was contributed by Dirk Eddelbuettel
12254
23385f2c90b7 whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
116 <edd@debian.org> for the Debian GNU/Linux distribution but
4149
5d9f4688590a [project @ 2002-11-02 04:35:17 by jwe]
jwe
parents:
diff changeset
117 may be used by others.