Fixes for install guide page.
authorJustin Lemkul <jalemkul@vt.edu>
Fri, 8 Feb 2013 20:40:53 +0000 (15:40 -0500)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Tue, 5 Mar 2013 17:35:51 +0000 (18:35 +0100)
Editorial fixes to rename GMX_LIBS_SUFFIX and provide an example
of proper usage of adding suffixes.  These edits now keep the .tex
file in sync with the edits manually made to the wiki page.

Change-Id: Iba5b4c66ad3d0d84ddb06591d4681ff48e4de2ee

admin/installguide/installguide.tex

index 984235250b348f6dc1f02349fe47ac393cf9448c..c5b8b30bbdd6a5b3286c08185365e58a3d4f791c 100644 (file)
@@ -470,10 +470,19 @@ single and double precision, and with and without \mpi{}. By default,
 \gromacs{} will suffix binaries and libraries for such builds with
 '\verb+_d+' for double precision and/or '\verb+_mpi+' for \mpi{} (and
 nothing otherwise). This can be controlled manually with
-\verb+GMX_DEFAULT_SUFFIX+, \verb+GMX_BINARY_SUFFIX+ and
-\verb+GMX_LIBRARY_SUFFIX+. This can also be useful for resolving
-libary-naming conflicts with existing packges (\verb+GMX_PREFIX_LIBMD+
-also can be useful).
+\verb+GMX_DEFAULT_SUFFIX (ON/OFF)+, \verb+GMX_BINARY_SUFFIX+ (takes 
+a string) and \verb+GMX_LIBS_SUFFIX+ (also takes a string). 
+This can also be useful for resolving libary-naming conflicts with 
+existing packges (\verb+GMX_PREFIX_LIBMD+ also can be useful).
+For instance, to set a custom suffix for binaries and libraries, 
+one might specify:
+
+\begin{verbatim}
+cmake .. -DGMX_DEFAULT_SUFFIX=OFF -DGMX_BINARY_SUFFIX=_mod -DGMX_LIBS_SUFFIX=_mod
+\end{verbatim}
+
+Thus the names of all binaries and libraries will be appended with
+"_mod."
 
 \subsection{Building \gromacs{}}