USAGE:(1)

💖 USAGE:(1) — the manual page for gfxrecon-capture 💖

okay bestie, listen. this is the manual page for gfxrecon-capture, and it lives in section 1 of the manual (that's the (1) bestie, user commands, the fun section ✨). let's get into it 🫶

---

🌸 NAME 🌸

gfxrecon-capture — create a capture of a Vulkan program. that's it, that's the whole job, and she does it flawlessly 💅

---

✨ DESCRIPTION ✨

so the usage line is literally:

usage: gfxrecon-capture.py [-h]

[-w dir]
       [-o captureFile] [-f captureFrames] [--no-file-timestamp]
       [--trigger {F1-F12,TAB,CTRL}] [--compression-type
       {LZ4,ZLIB,ZSTD,NONE}] [--file-flush] [--log-level
       {debug,info,warn,error,fatal}] [--log-file <file>]
       [--memory-tracking-mode {page_guard,assisted,unassisted}]
       <program> [<programArgs>]

and what does she actually do? Create a capture of a Vulkan program. simple as that. she's the main character, you're just running a program, and she's taking the receipts 📸

---

🎀 positional arguments: 🎀

• <program> [<program args>] — the program you wanna capture, and if you want, you can tack the program's arguments on after it too 🦋

---

💜 optional arguments: 💜

• -h, --help — shows this help message and dips. classic. iconic. no notes 👑
• -w <dir>, --working-dir <dir> — sets the CWD (current working directory, bestie) to this directory before running the program. like moving house but for one process 🏠
• -o <captureFile>, --capture-file <captureFile> — the name of the capture file. the default? gfxrecon_capture.gfxr ✨
• -f <captureFrames>, --capture-frames <captureFrames> — a list of frames to capture. default is all frames — yes, all of them, she's not shy 💅
• --no-file-timestamp — don't add a timestamp to the capture file name. sometimes you just want the plain name, and that's valid 🕐❌
• --trigger {F1,F2,F3,F4,F5,F6,F7,F8,F9,F10,F11,F12,TAB,CTRL} — pick a hotkey that starts and stops the capture. your very own secret combo 🎮
• --compression-type {LZ4,ZLIB,ZSTD,NONE} — the type of compression used in the capture file. default is LZ4 🗜️
• --file-flush — flushes the output stream after each packet gets written to the capture file. every. single. packet. commitment 🫡
• --log-level {debug,info,warn,error,fatal} — the highest level message that gets logged. default is info 📝
• --log-file logFile — the name of the log file. want to disable logging entirely? pass an empty string. default is stdout/stderr 🪵
• --memory-tracking-mode {page_guard,assisted,unassisted} — the method used to track changes to memory mapped objects. here are the three, bestie, read carefully:
  • page_guard: use pageguard to track changes (this is the default) 🛡️
  • assisted: the application will call vkFlushMappedMemoryRanges for memory to be written to the capture file 📞
  • unassisted: all mapped memory will be written to the capture file during VkQueueSubmit and VkUnmapMemory 🫠

and then the usage block gets repeated at you one more time, because apparently once was not enough, so here it is again in all her glory:

[-w dir]
       [-o captureFile] [-f captureFrames] [--no-file-timestamp]
       [--trigger {F1-F12,TAB,CTRL}] [--compression-type
       {LZ4,ZLIB,ZSTD,NONE}] [--file-flush] [--log-level
       {debug,info,warn,error,fatal}] [--log-file <file>]
       [--memory-tracking-mode {page_guard,assisted,unassisted}]
       <program> [<programArgs>]

---

🔥 SEE ALSO 🔥

the full documentation for usage: is maintained as a Texinfo manual 📚. if the info and usage: programs are properly installed at your site, then this command:

info usage:

should give you access to the complete manual. go forth and read, bestie 🧚

---

fr fr, that's the whole page. no cap. 💀

later, legend 🫶 — this page is gfxrecon-capture, dated June 2021, and it says USAGE:(1) up top and gfxrecon-capture + June 2021 + USAGE:(1) at the bottom, which we have now lovingly folded into this sign-off so nothing gets lost 💖✨🎀