annotate doc/interpreter/mkoctfile.1 @ 7948:af10baa63915 ss-3-1-50

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