Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 2.73 KB

grimblast.1.scd

File metadata and controls

115 lines (80 loc) · 2.73 KB

grimblast(1)

NAME

grimblast - a helper for screenshots within hyprland

SYNOPSIS

grimblast [--notify] [--cursor] [--freeze] [--wait N] [--scale ] (copy|save|copysave|edit) [TARGET] [FILE]++ grimblast check++ grimblast usage

OPTIONS

--notify Show notifications to the user that a screenshot has been taken.

--cursor Include cursors in the screenshot.

--freeze Freezes the screen before area selection.

--wait N Wait for N seconds before taking a screenshot. Waits after any manual selection is made. Recommended to combine with --notify in order to know when the screenshot has been taken.

--scale Passes the -s argument to grim.

save Save the screenshot into a regular file. Grimblast will write image files to XDG_SCREENSHOTS_DIR if this is set (or defined in user-dirs.dir), or otherwise fall back to XDG_PICTURES_DIR. Set FILE to '-' to pipe the output to STDOUT.

copy Copy the screenshot data (as image/png) into the clipboard.

copysave Combine the previous 2 options.

edit Open screenshot in the image editor of your choice. The default is gimp, but you can set a different one with the enviroment variable $GRIMBLAST_EDITOR. Example: export GRIMBLAST_EDITOR=gimp.

check Verify whether the required tools are installed.

usage Show help message.

DESCRIPTION

Grimblast is an easy-to-use screenshot utility for hyprland, based on grimshot. It provides a convenient interface over grim, slurp and jq, and supports storing the screenshot either directly to the clipboard using wl-copy or to a file.

TARGETS

grimblast can capture the following named targets:

active Captures the currently active window.

screen Captures the entire screen. This includes all visible outputs.

area Allows manually selecting a rectangular region or window (by clicking on it), and captures that. Slurp can be customized by setting its arguments in the SLURP_ARGS environment variable.

output Captures the currently active output.

OUTPUT

Grimblast will print the filename of the captured screenshot to stdout if called with the save subcommand.

EXAMPLES

An example usage pattern is to add these bindings to your hyprland config:

# Screenshots:
# Super+P: Current window
# Super+Shift+p: Select area
# Super+Alt+p Current output
# Super+Ctrl+p All outputs

# Optionally, customize slurp's appearance
env = SLURP_ARGS, -d -b -B F050F022 -b 10101022 -c ff00ff

bind = SUPER, p, exec, grimblast save active
bind = SUPER SHIFT, p, exec, grimblast save area
bind = SUPER ALT, p, exec, grimblast save output
bind = SUPER CTRL, p, exec, grimblast save screen

EXIT CODES

0 - Normal exit++ 2 - Another instance of grimblast is running

SEE ALSO

grim(1) slurp(1) grimshot(1)