mcx(1)

💅 NAME 💅

okay bestie, gather round — mcx does a whole bunch of computations on graphs and matrices. that's the vibe. that's the assignment. ✨

---

🦋 SYNOPSIS 🦋

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

---

🌸 DESCRIPTION 🌸

so like, mcx is your girl for a variety of computations on graphs and matrices. but here's the thing — the first argument you give her has to be a mode. a mode is just a string that tells mcx what kind of computation you're trying to invoke, and every single mode has its own little manual page called mcxmode. iykyk.

the modes that are currently available? bestie, the roster is: convert, diameter, clcf, q and ctty. and to give you an example of how this naming situation works — the convert mode is described over in the mcxconvert manual page. cute, right? 💖

now, if you invoke mcx with no arguments at all, she's gonna print out a list of available modes plus a short description of the kind of command line each mode expects. free menu, no cap.

and if you invoke mcx with just a mode, she prints out a longer listing of the options available for that particular mode. some modes can function perfectly fine without any arguments — and those ones you can invoke by adding the --nop argument. iconic behaviour tbh.

several options are shared between all mcx modes. just a heads up though: those options get specified after the mode. check the OPTIONS section, babes. 👑

--version makes mcx print out version and license information. that's it. that's the whole job. 💅

and ooooh, here's a fun one — issuing mcx help mode causes mcx to go looking for a manual page describing mode and display it if she finds it. 🧚 but there's a catch, obviously: this requires that the MANPATH environment variable contains the directory where the MCL-edge manual pages were installed. that's usually PREFIX/share, where PREFIX is the path you configured the software with. so like, set your env up properly or she's just gonna be searching into the void 😭

---

✨ OPTIONS ✨

these are the options that pertain to all modes, bestie. and remember — they should be specified after the mode argument. not before. after. 🌈

• -h (synopsis) — list available options.
• --help (synopsis) — list available options.
• --nop (no-op) — okay so this one is not an option, technically. it has no effect other than incrementing the argument count. but it's actually useful?? because some mcx modes can function without any options at all — those ones typically read from STDIN, write to STDOUT, and use default settings. the problem is, if you just specify a mode with no options, mcx will output a list of available options for that mode instead of doing the thing. so you use --nop to prevent that. sneaky little trick, we love her. 🎀
• -set (key=val) — sets the key key to value val in the environment. some modes allow adjustment of settings in this manner. 🫶
• -progress <num> (progress interval size) — defines the interval that defines the progress frequency. (yes, it really says that. the interval defines the frequency. she said what she said.) ⭐
• --debug (turn on debugging) — turn debugging on. go off, detective. 🔍
• --version (show version) — show version.

---

👑 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 giving complete. 💀

---

and that's the whole page, bestie!! mcx version 22-282, dated 9 Oct 2022 — mwah, she ate, no crumbs left, periodt. go forth and compute on those graphs and matrices 💖✨🎀