RUBIKROTATION(1)

💅 RUBIKROTATION — like, the manual, but make it cute

okay bestie, sit DOWN, we're learning rubikrotation (v5.0) and honestly? it's giving legendary. 🎀

---

👑 AUTHORS

brought to you by the absolute icons A. Syropoulos and R.W.D. Nickalls, dated 25 February 2018 🗓️✨

want to slide into their inboxes? here's the deets:

• dick[at]<nickalls><org>
• asyropoulos[at]<yahoo><com>

---

🌈 DESCRIPTION

so rubikrotation is a Perl script that does the absolute most with Rubik cube rotations — and we're talking both 3x3x3 and 2x2x2, no gatekeeping here 💖

it lives inside the LaTeX rubikrotation package, and it's typically CALLed by rubikrotation.sty, responding to the RubikRotation{} command. want the full tea? the package manual (rubikrotation.pdf) has all of it. and btw the rubikrotation package is part of the LaTeX Rubik bundle — a whole family, we love a supportive household 🫶

want the freshest version? download it from:

CTAN: mirror.ctan.org/macros/latex/contrib/rubik/

here's the vibe: rubikrotation reads Rubik state data and commands (aka a sequence of rotations) from an input file, and writes the new state data to an output file. and the input + output filenames? you can just pass them as command-line arguments (see: command-line use) 💅

oh and — if a configuration file exists (rubikrotation.cfg), it will automatically be read by rubikrotation.sty. no cap, it just does that. ✨

---

⭐ COMMAND-LINE USE

here's the whole thing, look at her:

rubikrotation [-h|--help|-v|--version] [-o <outfile>] -i <infile>

and now the options, one by one, because we don't skip:

• -h — displays the help info and exits. the "bestie help me" button 🥺
• -v — displays the version info and exits. the "who even are you" button 👑
• -i — defines the input filename. the default input filename set by the rubikrotation package is rubikstate.dat, and that one gets generated by the LaTeX RubikRotation{} command (peep the rubikrotation LaTeX package manual rubikrotation.pdf for that). ⚠️ heads up though: the rubikrotation perl script expects the input file to have a certain structure, and that structure is described in rubikrotation.pdf and rubikrotationPL.pdf. don't freestyle the format, bestie, it will not slay. 💀
• -o — defines the output filename. and if you don't give it one? the default filename rubikOUT.txt is used. periodt. 🌸

---

🦋 SEE ALSO

the whole friend group, assembled:

• the rubikrotation Perl script manual (rubikrotationPL.pdf)
• the rubikrotation LaTeX package manual (rubikrotation.pdf)
• the examples (rubikexamples.pdf)
• the rubikcube LaTeX package manual (rubikcube.pdf)
• the rubikpatterns LaTeX package manuals (rubikpatterns.pdf and rubikpatternsLIST.pdf)

and here's how you actually open each one, copy-paste ready 🎀

to view rubikrotation.pdf, type: texdoc rubikrotation

to view rubikrotationPL.pdf, type: texdoc rubikrotationPL

to view rubikcube.pdf, type: texdoc rubikcube

to view rubiktwocube.pdf, type: texdoc rubiktwocube

to view rubikexamples.pdf, type: texdoc rubikexamples

to view rubikpatterns.pdf, type: texdoc rubikpatterns

to view rubikpatternsLIST.pdf, type: texdoc rubikpatternsLIST

---

🙈 BUGS

found a bug? don't suffer in silence, bestie 😭 please report bugs to Dick Nickalls or to Apostolos Syropoulos. they want to know, fr fr.

---

ok that's the whole page, you ate that 💅 go rotate some cubes.

---

signing off from the rubikrotation.1 manual page — this lil gem is from 25 February 2018, version vibes brought to you by the LaTeX Rubik bundle, and honestly? iconic. 🧚💜