RATOX(1)

💅 RATOX(1) — General Commands Manual, bestie 🎀

✨ NAME ✨

ratox — FIFO based tox client

🦋 SYNOPSIS 🦋

ratox [-4 | -6] [-E | -e] [-T | -t] [-P | -p] [-q] [savefile]

💖 DESCRIPTION 💖

okay so ratox is a client implementation of the tox protocol providing only FIFOs, files and directories as interfaces. That’s the whole interface situation, and it’s giving very “filesystem is my UI” energy. ✨

🎀 OPTIONS 🎀

• -4, -6 — use IPv4 / IPv6 only.
• -E, -e — enable / disable save file encryption.
• -T, -t — enable / disable TCP mode. Avoiding UDP in tox implies certain security considerations. ⚠️
• -P, -p — enable / disable TCP HTTP/SOCKS5 proxy as specified in config.h.
• -q — enable quiet mode. 🤫
• savefile — path of the file to load a profile from or create a new one in.

🌸 CONFIGURATION 🌸

ratox is configured with config.h at compile-time. Apart from command line options and other parameters, it contains the list of DHT-nodes.

If there is a mismatch between save file status and encryption setting, ratox writes the save file according to the latter. 🛠️

💅 INTERFACE 💅

A slot is a set of FIFOs, files and directories interfacing a single parameter. The set of slots makes up the interface. Think of it as lil interface bundles, no cap. 🫶

💫 Global slots 💫

Global slots are directories containing an in FIFO, out and err file or directory respectively. The slot parameter is set by piping data to in and accessed with out. Any errors are reported in err.

• name/ — Name slot.
• nospam/ — Nospam slot (8 digit hexadecimal).
• state/ — State slot (available | away | busy).
• status/ — Status message slot.
• request/ — Request slot. Send a friend request by piping the Tox ID to in. Incoming requests are listed as FIFOs in out/. Echo 1 | 0 to accept | reject them.
• conf/ — Conference management slot. A conference is created by writing a flag and its title to in. The flag is t | a | v for a text, audio, and video conference, followed by a space character. Only text conferences work at the moment. Invites to conferences are FIFOs in out/. Their name is id_cookie (the cookie is random data). They behave like request FIFOs.

🫶 Friend slots 🫶

Each friend is represented with a directory in the base-directory named after their Tox ID without its nospam-value. Each directory contains slots to interface with the friend. 🧚

• call_in — initiate a call by piping data to this FIFO.
• call_out — answer an incoming call by opening it for reading.
• call_state — reports the call state (none | pending | active). The sample format is mono signed 16-bit little endian at 48kHz. The call is terminated if ratox receives both an EPIPE trying to read from call_in and ENXIO trying to open call_out for writing.
• file_in — initiate a file transfer by piping data to this FIFO.
• file_out — accept an incoming file transfer by opening it for reading.
• file_pending — contains the incoming filename if transfer is pending, empty otherwise. Given ratox can’t know how much data a given pipe is going to provide, it will send until the pipe is drained or EPIPE received. That’s why it’s possible to stream arbitrary data, including audio and video transmissions, even to other clients. 🎥
• name — contains the friend’s name.
• online — contains the friend’s online status (1 | 0).
• remove — echo 1 to remove the friend.
• state — contains the friend’s state (available | away | busy).
• status — contains the friend’s status message.
• text_in — send a text message by piping data to this FIFO.
• text_out — contains text messages from the friend.

🌈 Conference slots 🌈

Each conference is represented with a directory in the directory named after the 8-digit conference number. The files in the conference directory are an interface for the respective conference. 💖

• members — contains a list of members of the conference.
• invite — write the Tox ID of a friend to this FIFO to invite them to the conference.
• leave — write to this file to leave the conference.
• title_in — write here to change the title of the conference.
• title_out — contains the title of the conference.
• text_in — echo message to send a text message to the conference.
• text_out — contains the messages send in the conference so far.

⭐ Misc files ⭐

• id — contains your Tox ID.

👑 AUTHORS 👑

• Dimitris Papastamos — <sin@2f30.org>
• Laslo Hunhold — <dev@frign.de>
• z3bra — <contact@z3bra.org>
• pranomostro — <pranomostro@posteo.net>

🎀 sign-off: this iconic page is the Debian one, dated March 10, 2017 — RATOX(1). mwah 💋