1swappy(1)                   General Commands Manual                  swappy(1)
2
3
4

NAME

6       swappy - grab and edit on the fly snapshots of a Wayland compositor
7

SYNOPSIS

9       swappy [options...]
10

DESCRIPTION

12       swappy is a command-line utility to take and edit screenshots of Way‐
13       land desktops. Works great with grim, slurp and sway. But can easily
14       work with other screen copy tools that can output a final image to std‐
15       out.
16
17       swappy will save the annotated images to the config save_dir, see be‐
18       low.
19
20       If absent, then if it will try to default to a Desktop folder following
21       this pattern: $XDG_DESKTOP_DIR. If this variable is not set, it will
22       revert to: $XDG_CONFIG_HOME/Desktop. If $XDG_CONFIG_HOME is not set, it
23       will revert to: $HOME/Desktop.
24

OPTIONS

26       -h, --help
27           Show help message and quit.
28
29       -v, --version
30           Show version and quit.
31
32       -f, --file <file>
33           An image file to load for editing.
34
35           If set to -, read the file from standard input instead. This is
36           grim friendly.
37
38       -o, --output-file <file>
39           Print the final surface to <file> when exiting the application.
40
41           If set to -, prints the final surface to stdout.
42
43           Note that the Save button will save the image to the config
44           save_dir parameter, as described in the DESCRIPTION section.
45

CONFIG FILE

47       The config file is located at $XDG_CONFIG_HOME/swappy/config or at
48       $HOME/.config/swappy/config. The file follows the GLib conf format.
49
50                [Section]
51                key=value
52
53       The following lines can be used as swappy's default:
54
55                [Default]
56                save_dir=$HOME/Desktop
57                save_filename_format=swappy-%Y%m%d-%H%M%S.png
58                show_panel=false
59                line_size=5
60                text_size=20
61                text_font=sans-serif
62                paint_mode=brush
63                early_exit=false
64                fill_shape=false
65
66save_dir is where swappshots will be saved, can contain env vari‐
67           ables, when it does not exist, swappy attempts to create it first,
68           but does not abort if directory creation fails
69save_filename_format is the filename template, if it contains a
70           date format, this will be parsed into a timestamp. Format is de‐
71           tailed in strftime(3). If this date format is missing, filename
72           will have no timestamp
73show_panel is used to toggle the paint panel on or off upon startup
74line_size is the default line size (must be between 1 and 50)
75text_size is the default text size (must be between 10 and 50)
76text_font is the font used to render text, its format is pango
77           friendly
78paint_mode is the mode activated at application start (must be one
79           of: brush|text|rectangle|ellipse|arrow|blur, matching is case-in‐
80           sensitive)
81early_exit is used to make the application exit after saving the
82           picture or copying it to the clipboard
83fill_shape is used to toggle shape filling (for the rectangle and
84           ellipsis tools) on or off upon startup
85
86

KEY BINDINGS

88   LAYOUT
89Ctrl+b: Toggle Paint Panel
90
91
92   PAINT MODE
93b: Switch to Brush
94t: Switch to Text
95r: Switch to Rectangle
96o: Switch to Ellipse
97a: Switch to Arrow
98d: Switch to Blur (d stands for droplet)
99
100
101R: Use Red Color
102G: Use Green Color
103B: Use Blue Color
104C: Use Custom Color
105Minus: Reduce Stroke Size
106Plus: Increase Stroke Size
107Equal: Reset Stroke Size
108f: Toggle Shape Filling
109k: Clear Paints (cannot be undone)
110
111
112   MODIFIERS
113Ctrl: Center Shape (Rectangle & Ellipse) based on draw start
114
115
116   HEADER BAR
117Ctrl+z: Undo
118Ctrl+Shift+z or Ctrl+y: Redo
119Ctrl+s: Save to file (see man page)
120Ctrl+c: Copy to clipboard
121Escape or q or Ctrl+w: Quit swappy
122
123

AUTHORS

125       Written and maintained by jtheoof <contact@jtheoof.me>. See
126       https://github.com/jtheoof/swappy.
127
128
129
130                                  2023-01-21                         swappy(1)
Impressum