Description of the configure module.

doc/scsh-manual/miscprocs.tex

@@ -392,6 +392,65 @@ C library written by Colin Plum.
   the digest.
 \end{desc}
 
+\section{Configuration variables}
+\label{sec:configure}
+
+This section describes procedures to access the configuration
+parameters used to compile scsh and flags needed to build C extensions
+for scsh.
+
+\defun{host}{}{string}
+\defunx{machine}{}{string}
+\defunx{vendor}{}{string}
+\defunx{guess}{}{string}
+\begin{desc}
+  These procedures return the description of the host, scsh was built
+  on, as determined by the script \texttt{config.guess}.
+\end{desc}
+%
+\defun{prefix}{}{string}
+\defunx{exec-prefix}{}{string}
+\defunx{bin-dir}{}{string}
+\defunx{lib-dir}{}{string}
+\defunx{include-dir}{}{string}
+\defunx{man-dir}{}{string}
+\begin{desc}
+  These procedures return the various directories of
+  the scsh installation.
+\end{desc}
+%
+\defun{lib-dir-list}{}{symbol list}
+\begin{desc}
+  Returns the default list of library directories. See
+  Section~\ref{sec:scsh-switches} for more information about the
+  library search facility.
+\end{desc}
+%
+\defun{libs}{}{string}
+\defunx{defs}{}{string}
+\defunx{cflags}{}{string}
+\defunx{cppflags}{}{string}
+\defunx{ldflags}{}{string}
+\begin{desc}
+  The values returned by these procedures correspond to the values
+\texttt{make} used to compile scsh's C files.
+\end{desc}
+%
+\defunx{compiler-flags}{}{string}
+\begin{desc}
+  The procedure \var{compiler-flags} returns flags suitable for
+  running the C compiler when compiling a C file that uses scsh's
+  foreign function interface.
+\end{desc}
+
+\defun{linker-flags}{}{string}
+\begin{desc}
+  Scsh also comes as a library that can be linked into other programs.
+  The procedure \var{linker-flags} returns the appropriate flags to
+  link the scsh library to another program.
+\end{desc}
+
+
 %%% Local Variables: 
 %%% mode: latex
 %%% TeX-master: "man"