CEREAL(1)

💖 cereal(1) — bestie edition 💖

okay so this is the manual page for cereal, living in the User Commands section of the manual (that's the (1) part, iykyk). pull up a chair, grab a boba, we're gonna go through it together 🧋✨

---

✨ NAME ✨

cereal — the client program you use to attach to a cereal session 🫶

---

🌸 SYNOPSIS 🌸

cereal command [args]

---

🦋 DESCRIPTION 🦋

so cereal is literally the client program. it's the thing that lets you attach to a running cereal session. that's the whole vibe. main character energy, minimal job description 💅

---

👑 SUBCOMMANDS 👑

cereal takes various subcommands, and bestie there are four of them, let's go:

• attach SESSION — attach to (aka take control of) cereal session SESSION. this drops you into a cereal console, which is provided by a command-restricted screen session. to detach from an attached session, hit "C-\ d" ✨. want help on the other available commands? use "C-\ ?" 🎀. cereal uses a limited instance of screen for the console — for more info on the available commands, go look at screen(1). oh and also? you can just type a instead of attach, bc we keep it short around here.
• follow [options] SESSION — follow (watch, but you can't intervene, it's giving spectator sport 👀) a cereal session SESSION. the options are:
  • -c [--cat] — cat log instead of follow
  • -p [--path] — output just the path to the log file and exit

and yes, f may be used in place of follow 💫

• list [SESSION]... — list session(s). with no arguments, it will list all sessions. the leading three characters in the list mean:
  • whether the session is running (+) or not (-) or in some unknown state (?)
  • whether the user can attach to the session (a) or not (-)
  • whether the user can follow the session (f) or not (-)

if the session state is unknown (?), it's usually because the user asking for information about the session can't read the session stat file 😭

also l may be used in place of list 🌈

• help — output a brief usage summary. h or ? may be used in place of help 🫶

---

💀 EXIT STATUS 💀

exit status is 0 if OK, 1 if minor problems, 2 if serious trouble. simple as that, no cap.

---

🎀 AUTHOR 🎀

written by Jameson Rollins and Daniel Kahn Gillmor. legends, honestly 👑

---

🙈 BUGS 🙈

if the invoking user does not have read and execute access to the cereal session's supervise directory, cereal list may not always indicate that session's status accurately. so like, it might lie to you a lil. not its fault tho, blame the permissions 🥲

---

🍓 REPORTING BUGS 🍓

report bugs to <cereal@fifthhorseman.net> 💌

---

💜 COPYRIGHT 💜

Copyright © 2007 Jameson Rollins and Daniel Kahn Gillmor

this is free software. you may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. there is NO WARRANTY, to the extent permitted by law. (that last bit is in all caps in spirit, bestie — respect it 💅)

---

🌈 SEE ALSO 🌈

• screen(1)
• cereal-admin(8)

---

and that's the whole page!! this was cereal 0.1, from March 2007, section 1 of the manual. go forth and attach responsibly 🫶💖✨