clm(1)

💖 clm — the graph-glow-up command 💖

okay so bestie, welcome to clm from the USER COMMANDS corner of the manual-verse ✨ she performs various computations on graphs and clusterings, and she's literally so versatile it's giving main character energy 💅

---

✨ SYNOPSIS ✨

clm <mode> [mode-options] [mode-files]

---

🦋 DESCRIPTION 🦋

so clm implements a whole variety of computations on graphs and clusterings — like, a lot of them. The first argument you hand her should be a mode, which is a string that establishes the type of computation to invoke. Every single mode is described in the clmmode manual page (iykyk, that's the template name 🎀).

The modes available rn are:

• clm dist
• clm info
• clm meet
• clm mate
• clm close
• clm order
• clm imac
• clm vol
• clm residue

and the dist mode specifically is described over in the clmdist manual page 🌸

---

okay now the fun part, the ~behaviour~:

• Invoke clm with no arguments at all and she'll print out a list of available modes, plus a short description of the type of command line that each mode expects. cute, right? 💖
• Invoke clm with just a mode and she prints a longer listing of the options available for that particular mode.
• Modes that can function normally without arguments? You can invoke those by adding the --nop argument. (Yes bestie, we'll get to what that is. Patience 🫶)

Several options are shared between all clm modes. Important vibe check: these options are specified after the mode. See OPTIONS below 👑

The --version option causes clm to print out version and license information. slay.

Also: issuing clm help mode will cause clm to go look for a manual page describing mode 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. no cap 📚

---

💅 OPTIONS 💅

These are options that pertain to all modes. They should be specified after the mode argument. (say it with me: after the mode.)

• -h (synopsis)
• --help (synopsis)

List available options. that's it, that's the whole thing ✨

• --nop (no-op)

Not an option, actually 😭 This option has no effect other than to increment the argument count. That sounds useless but bestie it's so 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. BUT — and this is the plot twist — simply specifying a mode without options leads clm to output a list of available options for that mode instead of doing the thing. This can be averted by using the --nop option. iconic behaviour tbh 🎀

• -set 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. lowkey powerful 💜

• -debug <int> (set debug level/flags)
• --debug (turn default debugging on)
• --test (turn default testing on)

The first two turn on debugging, the last is for testing. The effect of these options is otherwise undocumented 🙈 (yes, really. we don't know either.)

• --progress (enable progress reporting)

This will enable some kind of progress reporting, by writing to STDERR. so you can watch her work 👑

---

👑 AUTHOR 👑

Stijn van Dongen. (the legend herself, we stan 🫶)

---

🌈 SEE ALSO 🌈

mclfamily(7) for an overview of all the documentation and the utilities in the mcl family. go read it, it's the whole friend group 💖

---

and that's the tea, bestie 🍓 this page was served to you by clm 22-282, dated 9 Oct 2022, living her best life as clm(1) in section one. go forth and cluster ✨💅🦋