ESCROTUM(1)

πŸ“¦ version 1.0.1-unstable-2020-12, in nixpkgs unstable

ESCROTUM(1) πŸ’…

okay so this is a User Commands manual page, bestie β€” buckle up πŸŽ€


✨ NAME ✨

escrotum β€” a minimalist screenshot capture and screen recording program, inspired by scrot. yes. that's the whole vibe. minimalist. iconic. πŸ¦‹


🌸 DESCRIPTION 🌸

okay so here's the usage, literally exactly as it appears, no cap:

usage: escrotum [-h] [-v] [-s] [-x XID] [-d DELAY]
              [--selection-delay SELECTION_DELAY] [-c] [-C] [-e COMMAND] [-r]
              [FILENAME]

Minimalist screenshot capture and screen recording program inspired by scrot. that's the whole pitch and honestly? it ate. πŸ”₯


πŸŽ€ positional arguments πŸŽ€

  • FILENAME β€” the image filename, bestie. and if you don't give one, it defaults to %Y-%m-%d-%H%M%S_$wx$h_escrotum.png β€” which lowkey looks like a keyboard smash but trust, it makes sense once you read the special strings section below πŸ‘‘

πŸ’– optional arguments πŸ’–

  • -h, --help β€” shows this help message and then dips. exit stage left. 🫢
  • -v, --version β€” spits out the version info and leaves. ✨
  • -s, --select β€” interactively pick a window or draw a rectangle with your mouse. and if you change your mind? cancel with Esc or right click. no drama πŸ–±οΈ
  • -x XID, --xid XID β€” takes a screenshot of the window with that specific xid. targeting, but make it X11 πŸ’…
  • -d DELAY, --delay DELAY β€” waits DELAY seconds before taking the shot. gives you time to fix your hair πŸ’β€β™€οΈ
  • --selection-delay SELECTION_DELAY β€” the delay in milliseconds between the selection and the screenshot. tiny pause, big difference ⏱️
  • -c, --countdown β€” shows a countdown before the shot. requires delay β€” so don't come at it with no -d, it will not work, iykyk πŸ™ˆ
  • -C, --clipboard β€” stores the image on the clipboard. paste-ready, main character energy πŸ“‹
  • -e COMMAND, --exec COMMAND β€” runs your command after the image is taken. automation slay πŸ€–
  • -r, --record β€” screen recording mode!! and Alt+Ctrl+s stops the recording, write that down πŸ“

πŸ¦‹ SPECIAL STRINGS πŸ¦‹

okay bestie this part is actually so cool. both the --exec parameter and the filename parameter can take format specifiers, and escrotum expands them when it encounters them. 🧚

there are two kinds of format specifier:

  1. characters preceded by a % get interpreted by strftime(2). go see man strftime for examples. these ones can refer to the current date and time. ⭐
  2. the second kind is internal to escrotum and prefixed by $. the following specifiers are recognised:
  • $f β€” image path/filename (ignored when used in the filename)
  • $w β€” image width
  • $h β€” image height

Example:

escrotum '%Y-%m-%d-%H%M%S_$wx$h_escrotum.png'

creates a file called something like 2013-06-17-082335_263x738_escrotum.png. see?? it all comes together πŸ’œ

πŸ’€ EXIT STATUS CODES πŸ’€

so if something goes sideways, here's what the numbers mean:

  • 1 β€” can't get the window by xid
  • 2 β€” invalid pixbuf
  • 3 β€” can't save the image
  • 4 β€” user canceled selection
  • 5 β€” can't grab the mouse
  • 6 β€” error with ffmpeg

πŸ‘‘ SEE ALSO πŸ‘‘

The full documentation for escrotum is maintained as a Texinfo manual. If the info and escrotum programs are properly installed at your site, the command

info escrotum

should give you access to the complete manual. 🌈


fr fr, that's the whole page β€” every flag, every specifier, every exit code, nothing skipped πŸ’–

signing off: this was escrotum 0.2.1, dated January 2020, from the User Commands section β€” stay slay, take screenshots πŸŽ€βœ¨πŸ¦‹

πŸ“¦ where this page comes from