clm - perform various computations on graphs and clusterings
clm <mode> [mode-options] [mode-files]
implements a variety of computations on graphs and clusterings. The
first argument to clm
should be a mode
, which is a string
establishing the type of computation to invoke. Each mode mode
described in the clm mode
manual page. The currently available modes
are clm dist
, clm info
, clm meet
, clm close
, clm order
, clm vol
, and clm residue
mode is thus described in the clmdist
without arguments causes it to print out a list of available
modes with a short description of the type of command line expected by that
with just a mode will print out a longer listing of options
available for that particular mode. Modes that are able to function normally
without arguments can be invoked by adding the --nop
Several options are shared between all clm
modes. Note that these options
are specified after the mode
. See OPTIONS
option causes clm
to print out version and license
Issuing clm help mode
will cause clm
to look for a manual page
and display it if found. This requires that the MANPATH
environment variable contains the directory in which the MCL-edge manual pages
were installed. This will usually be PREFIX/share, where PREFIX is the path
with which the software was configured.
These are options that pertain to all modes. They should be specified
the mode argument.
List available options.
Not an option. This option has no effect then to increment the argument count.
This can be useful for clm
modes which are able to function without any
options. Such a mode typically reads from STDIN, writes to STDOUT, and uses
default settings. However, simply specifying a mode without options leads
to output a list of available options for that mode. This can be
averted by using the --nop
key=val (set key-value pair
Sets the key key
to value val
in the environment.
Some modes allow adjustment of settings in this manner.
<int> (set debug level/flags
(turn default debugging on
(turn default testing on
The first two turn on debugging, the last is for testing. The effect of these
options is otherwise undocumented.
(enable progress reporting
This will enable some kind of progress reporting, by writing to STDERR.
Stijn van Dongen.
for an overview of all the documentation and the utilities
in the mcl family.