BYZANZ-RECORD(1)

💖 BYZANZ-RECORD 💖

bestie. you're looking at the byzanz-record manual page, section 1 of the General Commands Manual, and it's literally about recording your desktop session into an animated GIF. yes. the whole screen. periodt.

✨ NAME ✨

byzanz-record — record your desktop session to an animated GIF 🎀

🌸 SYNOPSIS 🌸

byzanz-record [options] FILENAME

🦋 DESCRIPTION 🦋

okay so here's the vibe: Byzanz records your desktop session to an animated GIF. that's it, that's the whole thing, and it's iconic.

you can record:

• your entire screen 👑
• a single window 🪟
• or an arbitrary region ✂️

byzanz-record is the version that lets you make recordings from the command line, which is giving main character energy for sure. and if you're more of a graphical girlie? you may want to use the panel applet instead. no judgement, we support all paths here 💅

🔥 OPTIONS 🔥

Application Options: 💜

• -a, --audio — Record audio from the default input device. > ⚠️ heads up bestie: this only works if the output format supports it, and will otherwise cause an error. so like, know before you go.
• -c, --cursor — Record mouse cursor 🖱️ (yes, the little arrow gets to be famous too)
• -d, --duration=SECS — Duration of animation. default: 10 seconds ⏱️
• -e, --exec=COMMAND — Instead of specifying the duration of the animation, execute the given COMMAND and record until the command exits. this is useful both for benchmarking and to use more complex ways to stop the recording, like writing scripts that listen on dbus. very galaxy brain fr fr 🧠
• --delay=SECS — Delay before start. default: 1 second 🫶 (breathe, girl, you got a sec)
• --display=DISPLAY — X display to use 🖥️
• -h, --height=PIXEL — Height of recording rectangle 📐 (and no, -h is not help here, she's height. stay woke)
• -v, --verbose — be verbose 🗣️
• -w, --width=PIXEL — Width of recording rectangle 📏
• -x, --x=PIXEL — X coordinate of rectangle to record ➡️
• -y, --y=PIXEL — Y coordinate of rectangle to record ⬇️

Help Options: 🆘

• -?, --help — Show help options
• --help-all — Show all help options
• --help-gtk — Show GTK+ Options

🎀 OUTPUT FILE 🎀

After byzanz-record is finished, the recording is written to FILENAME. and how does it know what you want?? the format is determined by the filename extension. the following formats are supported:

• byzanz — Record to Byzanz' internal debugging format. This is useful for benchmarking Byzanz or if you want to convert the recording to multiple formats later. You can use byzanz-playback(1) to convert the file. 🧪
• flv — Record to a Flash Screen video. This recording method is lossless. Use it if you want to postprocess the file in other applications. ✨
• gif — Record to an animated GIF image. Use this if you want to record a mostly static screen with a limited amount of colors, such as using a file manager or an office application. This is the default and will be used if an unrecognized extension is used. 💖 (the moment an extension is unrecognized and it just defaults to gif anyway... she's flexible, she's forgiving, she's gif)
• ogg, ogv — Record to an Ogg Theora video. This format supports audio. Use this if you want to record dynamic contents, such as video playback. 🎬
• webm — Record to a WebM video. This format consists of VP8 video and Vorbis audio streams. Use this if you want to record dynamic contents, e.g. for a HTML5 video. 🌈

👀 SEE ALSO 👀

byzanz-playback(1)

💜 AUTHOR 💜

Byzanz was written by Benjamin Otte <otte@gnome.org>. absolute legend behavior honestly 🙌

This manual page was last updated for version 0.2.1. 📅

okay that's the whole page bestie, go forth and record something iconic 🦋✨

— from the BYZANZ-RECORD(1) page, General Commands Manual, version 0.2.1 — 🌸