CUBEMAP(1)

💖 CUBEMAP 💖

okay bestie, welcome to the cubemap manual page — it's a General Commands Manual and honestly? she's that girl. sit down, grab a boba, and let's get into it 🧋✨

🌸 NAME 🌸

cubemap — scalable video reflector, designed to be used with VLC

✨ SYNOPSIS ✨

cubemap [options] [FILE]

🦋 DESCRIPTION 🦋

cubemap is a high-performance, high-availability video reflector, specifically made for use with VLC. no cap. she was literally built for this 💅

• High-performance, through a design with multiple worker threads, epoll and sendfile (yes, sendfile — the way she said sendfile like it's nothing 😭). a 2GHz quadcore can saturate 10 gigabit Ethernet, given a modern kernel, a modern NIC and the right kernel tuning. like?? iconic behavior 👑
• High-availability. You can change any part of the configuration (and even upgrade to a newer version of Cubemap) by changing cubemap.config and sending a SIGHUP; all clients will continue as if nothing had happened (unless you delete the stream they are watching, of course 🙈). Cubemap also survives the encoder dying and reconnecting. she's resilient fr fr 🫶
• Support for setting max pacing rate through the fq packet scheduler (depends on Linux 3.13 or newer). old kernels need not apply 💀
• Reflects anything VLC can reflect over HTTP, even the muxes VLC has problems reflecting itself (in particular, FLV). she does what VLC can't, lowkey 💅
• Multicast support, both for sending and receiving (supports only protocols that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM. very demure, very multicast 🎀
• IPv4 support. Yes, Cubemap even supports (some) legacy protocols. she's inclusive like that 🌈

🎀 OPTIONS 🎀

• --test-config, -t — tests the config and exits. vibe check the config and then dip ✌️
• FILE — configuration file (defaults to cubemap.config in the current directory). she'll look in the current directory if you don't tell her otherwise 🍓

👑 AUTHOR 👑

cubemap was written by Steinar H. Gunderson <steinar+cubemap@gunderson.no>. king behavior honestly 💜

📜 LICENSE 📜

cubemap is licensed under the GNU General Public License, version 2. read it, bestie, it's giving legally binding ✨

🌈 SEE ALSO 🌈

vlc(1) — the other main character in this story 💖

okay that's the whole page!! this one was April 27, 2014 energy and she's still serving. stay hydrated, test your config with -t, and don't forget to SIGHUP responsibly 🧚💜 mwah!