screenshotter.toml.sample

# Used for desktop screenshots and when the window PID can't be determined
Fallback = 'desktop'

# The root directory where screenshots should be stored
# Screenshots will be named ScreenshotDir/application/timestamp.png or
# ScreenshotDir/application/year/timestamp.png
ScreenshotDir = '/path/to/screenshots/directory'

# Will be ignored in favour of any available children
IgnoredParents = ['kitty', 'xfce4-terminal', 'zsh']

# Comment to skip checking WINDOWID if you only use terminals that use a single
# process per window.
# Doesn't help with gnome-terminal, which is uniquely incapable and does not
# set WINDOWID.
CheckWindowID = true

# Callback to be called with the path to the screenshot.
# The final filename will be the first argument and several environment
# variables will be set. See the README for details.
# Callback = '/home/user/bin/screenshot-script'

# PNG compression level in the range of 0-9
# 0 is fastest, 9 is slowest
# 8 and 9 are slow enough to be annoying for interactive usage
# 0 compresses very poorly and saves little time over 1
Compression = 5

# Additional shaders to use with slop for region selection.
# See https://github.com/naelstrof/slop/tree/master/shaderexamples
# SlopShaders = ['boxzoom']

# Temporarily enable Mouse Keys during slop region selection.
# This will enable and then disable mouse keys unless it is already enabled.
# Requires a version of slop with Mouse Keys support
MouseKeys = false

# Overrides.
# The first matching override is used. In order for an override to match
# the Name, Regex, and Delegate are considered in that order.
#
#
# Name: Optional string.
# The application name to match against. Multiple overrides can be
# specified for a name.
#
# Regex: Optional regular expression.
# If present, the full command line is matched against this
# regular expression and the groups can be referenced in the Format string.
# Will never match in desktop mode or when the process in a window can't be
# determined.
#
# Yearly: Optional boolean.
# If present and true separate directories will be used
#
# Monthly: Optional boolean.
# If present and true, use separate directories for each
# month. If Yearly is true the directories will be nested (appname/2019/02/),
# but false or absent will result in a flatter structure (appname/2019-02/).
#
# Format: Optional printf style format string.
# The output pattern as a format string. Use %s to
# reference the groups from the regex match, if present. All special
# characters will be escaped, and this cannot be used to specify nested
# directories.
#
# Delegate: Optional executable.
# If present this executable is invoked with several environment variables set.
#
# See the README for the set of variables.
# A non-zero exit value is treated as a non-match.
# Each line of stdout is treated as a directory on a path rooted at
# ScreenshotDir. If the output is non-empty it will override any value from
# Format.
#
# Callback: Optional executable.
# If present, called before the global callback with the same arguments.
# Screenshotter makes the assumption that this callback does NOT rename or move
# the screenshot.
# This is not considered when matching overrides.


[[Overrides]]
  Name = "vimx"
  Format = "vim"

[[Overrides]]
  Name = "i3"
  Format = "desktop"

[[Overrides]]
  Name = "chromium-browser"
  Format = "chromium"

[[Overrides]]
  Name = "wine32-preloader"
  Regex = '^.*/([^/ ]+)\.exe'
  Format = "%[2]s"

[[Overrides]]
  Name = "python2-7"
  Regex = '^/usr/bin/python.*/bin/([^/ ]+)( .*)?'
  Format = "%[2]s"

[[Overrides]]
  Name = "watch"
  Regex = '^watch ([^ ]*)?'
  Format = "%[2]s"

[[Overrides]]
  Name = "firefox"
  Yearly = true

[[Overrides]]
  Name = "mcomix"
  Yearly = true

[[Overrides]]
  Name = "mpv"
  Yearly = true
  # Callback = '/home/user/bin/mpv-callback'