Navigation

Operators and Keywords

Function List:

C++ API

Command: mkoctfile [-options] file …
Function File: [output, status] = mkoctfile (…)

The mkoctfile function compiles source code written in C, C++, or Fortran. Depending on the options used with mkoctfile, the compiled code can be called within Octave or can be used as a stand-alone application.

mkoctfile can be called from the shell prompt or from the Octave prompt. Calling it from the Octave prompt simply delegates the call to the shell prompt. The output is stored in the output variable and the exit status in the status variable.

mkoctfile accepts the following options, all of which are optional except for the file name of the code you wish to compile:

‘-I DIR’

Add the include directory DIR to compile commands.

‘-D DEF’

Add the definition DEF to the compiler call.

‘-l LIB’

Add the library LIB to the link command.

‘-L DIR’

Add the library directory DIR to the link command.

‘-M’
‘--depend’

Generate dependency files (.d) for C and C++ source files.

‘-R DIR’

Add the run-time path to the link command.

‘-Wl,…’

Pass flags though the linker like "-Wl,-rpath=…". The quotes are needed since commas are interpreted as command separators.

‘-W…’

Pass flags though the compiler like "-Wa,OPTION".

‘-c’

Compile but do not link.

‘-g’

Enable debugging options for compilers.

‘-o FILE’
‘--output FILE’

Output file name. Default extension is .oct (or .mex if ‘--mex’ is specified) unless linking a stand-alone executable.

‘-p VAR’
‘--print VAR’

Print the configuration variable VAR. Recognized variables are: 

   ALL_CFLAGS                  INCFLAGS
   ALL_CXXFLAGS                INCLUDEDIR
   ALL_FFLAGS                  LAPACK_LIBS
   ALL_LDFLAGS                 LD_CXX
   AR                          LDFLAGS
   BLAS_LIBS                   LD_STATIC_FLAG
   CC                          LFLAGS
   CFLAGS                      LIBDIR
   CPICFLAG                    LIBOCTAVE
   CPPFLAGS                    LIBOCTINTERP
   CXX                         LIBS
   CXXFLAGS                    OCTAVE_HOME
   CXXPICFLAG                  OCTAVE_LIBS
   DEPEND_EXTRA_SED_PATTERN    OCTAVE_LINK_DEPS
   DEPEND_FLAGS                OCTAVE_LINK_OPTS
   DL_LD                       OCTAVE_PREFIX
   DL_LDFLAGS                  OCTINCLUDEDIR
   F77                         OCTLIBDIR
   F77_INTEGER8_FLAG           OCT_LINK_DEPS
   FFLAGS                      OCT_LINK_OPTS
   FFTW3F_LDFLAGS              RANLIB
   FFTW3F_LIBS                 RDYNAMIC_FLAG
   FFTW3_LDFLAGS               READLINE_LIBS
   FFTW3_LIBS                  SED
   FFTW_LIBS                   SPECIAL_MATH_LIB
   FLIBS                       XTRA_CFLAGS
   FPICFLAG                    XTRA_CXXFLAGS
‘--link-stand-alone’

Link a stand-alone executable file.

‘--mex’

Assume we are creating a MEX file. Set the default output extension to ".mex".

‘-s’
‘--strip’

Strip the output file.

‘-v’
‘--verbose’

Echo commands as they are executed.

‘file’

The file to compile or link. Recognized file types are 

   .c    C source
   .cc   C++ source
   .C    C++ source
   .cpp  C++ source
   .f    Fortran source (fixed form)
   .F    Fortran source (fixed form)
   .f90  Fortran source (free form)
   .F90  Fortran source (free form)
   .o    object file
   .a    library file

Package: octave