MURPHI‐FORMAT(1)

✨ MURPHI-FORMAT(1) ✨

okay bestie, pull up a chair 💖 this is murphi-format, from the General Commands Manual, and she's here to fix your Murphi model's whole look.

---

🎀 NAME 🎀

murphi-format — reformat Murphi models. that's it, that's the job 💅

---

🦋 SYNOPSIS 🦋

murphi-format options [FILE]

---

🌸 DESCRIPTION 🌸

so murphi-format is a lil utility that ships bundled with the Rumur model checker. her whole thing? reflowing the text of a Murphi model into one consistent indentation style. slay.

and here's the tea: murphi-format intentionally has very few options. like, on purpose. she's not here to be configurable, she's here to end the discourse — by simply mandating a universally disliked format. iconic behaviour honestly 😌 no more style debates, periodt.

No line length limit is applied. and the content within comments is not reflowed. so if your input has long expressions, bestie, those are gonna show up as long lines in the output. why would she do this? the intention behind this choice is to gently (lovingly) encourage you to outline long expressions into functions. it's giving tough love 💀

if you want more info about Rumur or Murphi, go check out rumur(1).

---

💖 OPTIONS 💖

• --debug or -d — turn on debug mode. this produces some extra output, meant for developers who are debugging murphi-format itself. not for the faint of heart, it's giving behind-the-scenes 🫶
• --help or 0 — show this documentation. yes, the option is literally the digit 0. we love a quirky queen 👑
• --in-place or -i — write the output of reformatting back into the same path as the source. ⚠️ this is only valid when one or more paths are given — it cannot be used when reformatting stdin. no cap.
• --output=FILE or -o FILE — write output to the given path. by default, output goes to stdout.
• --tab=STRING or -t STRING — the text to use as one tab worth of indentation. by default, this is two spaces. simple as that 🌈
• --version — print the murphi-format version and then exit. bye bestie 👋

---

🔥 NOTES 🔥

wanna disable formatting for a specific section of code? say less — there are special comments that get recognised:

rule begin
     x := y;
     y := z;
     -- murphi-format: off
     z := w; w := x;
     -- murphi-format: on
end;

code sitting between the murphi-format: off and murphi-format: on comments will be preserved as-is. preserved. untouched. protected. 💜

⚠️ but listen — these must be line comments, not multi-line comments. and they must have the exact spacing shown, not arbitrary white space between, like, the : and off. she's strict about this, okay? the vibes must be exact 🙈

---

🧚 SEE ALSO 🧚

rumur(1)

---

👑 AUTHOR 👑

all comments, questions and complaints should be directed to Matthew Fernandez <matthew.fernandez@gmail.com>. he said complaints. we're holding him to that 💅

---

⭐ LICENSE ⭐

this is free and unencumbered software released into the public domain. periodt.

anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. go off, honestly 🌈

in jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. we make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. we intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. that's a lot of words but basically: it's yours now 🫶

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

💀 yeah that part is all caps and scary but it's just saying: no refunds, no takebacks, she is not responsible for your chaos.

for more information, please refer to <http://unlicense.org> ✨

---

and that's the whole page, bestie!! this was MURPHI-FORMAT(1) from the General Commands Manual — go forth and let her reformat your models. mwah 💖🎀🦋