STORAGE2DOT(1p)

✨ storage2dot — bestie, let's make your storage PRETTY 💅

okay so this is the 1p manual page for storage2dot, from the User Contributed Perl Documentation section, and we're on version 2.06 🎀

---

🌸 NAME 🌸

storage2dot — analyse and generate a graphical view of a machine storage ✨

like, it looks at your storage and then DRAWS it. it's giving data-viz main character energy 👑

---

🦋 VERSION 🦋

version 2.06 💖

---

💫 SYNOPSIS 💫

storage2dot [OPTIONS]

  Options:
    --remote|-r MACHINE   collect data on MACHINE (through SSH)
    --collect-only|-c     generate plain data instead of dot file
    --data|-d FILE        use FILE as data source
    --output|-o FILE      write output into FILE
    --record-file FILE    record shell commandsinto FILE [for tests]
    --replay-file FILE    collect data from FILE [for tests]
    --help|-h             brief documentation
    --man                 full documentation

so basically, this program can go collect data about the storage state from your local machine or from a remote machine (over SSH, no cap) and then use all that to generate a DOT graphic that represents it 🫶

---

🎀 OPTIONS 🎀

• --remote MACHINE, -r MACHINE — go collect storage data on MACHINE through SSH. if you don't pass this, the default is that local storage data get collected, no SSH involved 💻
• --collect-only, -c — by default a DOT file gets generated from the storage data. with this option the program does NOT make the DOT file, it only outputs the raw collected data so you can analyse it later 📦
• --data FILE, -d FILE — if you wanna generate the DOT file, use the data you're providing here instead. FILE has to have been created with the help of the previous option (--collect-only). when you use this, no new data are collected 🙅♀️
• --output FILE, -o FILE — write the generated data (DOT by default) into FILE instead of dumping it to standard output ✍️
• --record-file FILE — write the shell commands (and their output) that are used to collect data into FILE. this is mostly for reproducibility during tests 🧪
• --replay-file FILE — use the info from FILE instead of running real shell commands to collect data. and then the original sentence just… ends?? "FILE must have been" and that's it bestie 😭 we don't know what it must have been. it is what it is. anyway: this is mainly used for reproducibility during tests 🧪
• --help, -h — prints a brief help message and exits 👋
• --man — prints the manual page and exits 📖

---

🌈 EXAMPLES 🌈

• storage2dot -o state.dot — generate a DOT file representing the state of the storage on the local machine 💾

storage2dot -o state.dot

• storage2dot -r host -o state.dot — generate a DOT file representing the state of the storage on the remote host. only perl (and its standard modules) are required on the remote machine. and of course you also need an SSH account, obviously 🔐

storage2dot -r host -o state.dot

• storage2dot -c -o state.data — just collect data on the current machine without generating a DOT file. only perl (and its standard modules) are required on the current machine 🌱

storage2dot -c -o state.data

• storage2dot --data state.data -o state.dot — generate a DOT file representing the state of the storage recorded in the state.data file. extra perl modules are required for this command ⚠️

storage2dot --data state.data -o state.dot

• dot -Tpdf state.dot > state.pdf — generate a PDF from the DOT file using dot(1) 📄

dot -Tpdf state.dot > state.pdf

---

💖 AUTHOR 💖

Vincent Danjean <Vincent.Danjean@ens-lyon.org> 👑

---

🫶 COPYRIGHT AND LICENSE 🫶

This software is copyright (c) 2014-2023 by Vincent Danjean.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, open source periodt 💅

---

okay bestie that's the whole page 🎀 shoutout to perl v5.38.2 and the date 2024-05-23 for being the footer energy at the very bottom of this whole thing. now go draw your storage, it's gonna eat 🔥🦋