Skip to content

Commit

Permalink
Fixed documentation of mklib
Browse files Browse the repository at this point in the history
  • Loading branch information
GiovanniBussi committed May 13, 2024
1 parent dfe0657 commit 0520704
Showing 1 changed file with 28 additions and 16 deletions.
44 changes: 28 additions & 16 deletions scripts/mklib.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,30 @@ if [ "$1" = --description ] ; then
echo "compile one or more *.cpp files into a shared library"
fi

if [ "$1" = --help ] ; then
echo "compile one or more *.cpp files into a shared library"
echo " you can create and export the variable PLUMED_MKLIB_CFLAGS with some extra compile time flags to be used"
echo " you can create and export the variable PLUMED_MKLIB_LDFLAGS with some extra link time flags (and libraries) to be used"
exit 0
fi
MANUAL='Compile one or more *.cpp files into a shared library.
if [ "$1" = --options ] ; then
echo "--description --options --help -o -n"
exit 0
fi
Usage:
plumed mklib [options] files1.cpp [file2.cpp ...]
Options:
-h, --help
Print this help and exit
-o LIBNAME, --out LIBNAME
Name of the output library. If missing, the name
of the first input file will me used, with its
suffix properly adjusted.
-n No-clobber mode, similar to `mv -n`.
Does not overwrite an existing library.
If the library exists when the command is started,
skip also the compilation phase.
Environment variables:
PLUMED_MKLIB_CFLAGS Extra compile time flags to be used
PLUMED_MKLIB_LDFLAGS Extra link time flags (and libraries) to be used
'

OPTIONS="--description --options -h --help -o --out -n"

if [ $# == 0 ]
then
Expand All @@ -34,12 +47,11 @@ do
prefixopt="$prefix$opt"
prefix=""
case "$prefixopt" in
(-o)
prefix="--out=";;
(--out=*)
lib="${prefixopt#--out=}";;
(-n)
no_clobber=yes;;
(-o|--out) prefix="--out=";;
(-h|--help) echo "$MANUAL" ; exit ;;
(--options) echo "$OPTIONS" ; exit ;;
(--out=*) lib="${prefixopt#--out=}";;
(-n) no_clobber=yes;;
(-*)
echo "ERROR: Unknown option $opt. Use --help for help."
exit 1 ;;
Expand Down

1 comment on commit 0520704

@PlumedBot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found broken examples in automatic/ANGLES.tmp
Found broken examples in automatic/ANN.tmp
Found broken examples in automatic/CAVITY.tmp
Found broken examples in automatic/CLASSICAL_MDS.tmp
Found broken examples in automatic/CLUSTER_DIAMETER.tmp
Found broken examples in automatic/CLUSTER_DISTRIBUTION.tmp
Found broken examples in automatic/CLUSTER_PROPERTIES.tmp
Found broken examples in automatic/CONSTANT.tmp
Found broken examples in automatic/CONTACT_MATRIX.tmp
Found broken examples in automatic/CONTACT_MATRIX_PROPER.tmp
Found broken examples in automatic/COORDINATIONNUMBER.tmp
Found broken examples in automatic/DFSCLUSTERING.tmp
Found broken examples in automatic/DISTANCE_FROM_CONTOUR.tmp
Found broken examples in automatic/EDS.tmp
Found broken examples in automatic/EMMI.tmp
Found broken examples in automatic/ENVIRONMENTSIMILARITY.tmp
Found broken examples in automatic/FIND_CONTOUR.tmp
Found broken examples in automatic/FIND_CONTOUR_SURFACE.tmp
Found broken examples in automatic/FIND_SPHERICAL_CONTOUR.tmp
Found broken examples in automatic/FOURIER_TRANSFORM.tmp
Found broken examples in automatic/FUNCPATHGENERAL.tmp
Found broken examples in automatic/FUNCPATHMSD.tmp
Found broken examples in automatic/FUNNEL.tmp
Found broken examples in automatic/FUNNEL_PS.tmp
Found broken examples in automatic/GHBFIX.tmp
Found broken examples in automatic/GPROPERTYMAP.tmp
Found broken examples in automatic/HBOND_MATRIX.tmp
Found broken examples in automatic/INCLUDE.tmp
Found broken examples in automatic/INCYLINDER.tmp
Found broken examples in automatic/INENVELOPE.tmp
Found broken examples in automatic/INTERPOLATE_GRID.tmp
Found broken examples in automatic/LOCAL_AVERAGE.tmp
Found broken examples in automatic/MAZE_OPTIMIZER_BIAS.tmp
Found broken examples in automatic/MAZE_RANDOM_ACCELERATION_MD.tmp
Found broken examples in automatic/MAZE_SIMULATED_ANNEALING.tmp
Found broken examples in automatic/MAZE_STEERED_MD.tmp
Found broken examples in automatic/MULTICOLVARDENS.tmp
Found broken examples in automatic/OUTPUT_CLUSTER.tmp
Found broken examples in automatic/PAMM.tmp
Found broken examples in automatic/PCA.tmp
Found broken examples in automatic/PCAVARS.tmp
Found broken examples in automatic/PIV.tmp
Found broken examples in automatic/PLUMED.tmp
Found broken examples in automatic/PYCVINTERFACE.tmp
Found broken examples in automatic/PYTHONFUNCTION.tmp
Found broken examples in automatic/Q3.tmp
Found broken examples in automatic/Q4.tmp
Found broken examples in automatic/Q6.tmp
Found broken examples in automatic/QUATERNION.tmp
Found broken examples in automatic/SPRINT.tmp
Found broken examples in automatic/TETRAHEDRALPORE.tmp
Found broken examples in automatic/TORSIONS.tmp
Found broken examples in automatic/WHAM_WEIGHTS.tmp
Found broken examples in AnalysisPP.md
Found broken examples in CollectiveVariablesPP.md
Found broken examples in MiscelaneousPP.md

Please sign in to comment.