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
63       •   save_dir is where swappshots will be saved, can contain env vari‐
64           ables and must exist in your filesystem
65       •   save_filename_format is the filename template, if it contains a
66           date format, this will be parsed into a timestamp. Format is de‐
67           tailed in strftime(3). If this date format is missing, filename
68           will have no timestamp
69       •   show_panel is used to toggle the paint panel on or off upon startup
70       •   line_size is the default line size (must be between 1 and 50)
71       •   text_size is the default text size (must be between 10 and 50)
72       •   text_font is the font used to render text, its format is pango
73           friendly
74
75

KEY BINDINGS

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

AUTHORS

113       Written and maintained by jtheoof <contact@jtheoof.me>. See
114       https://github.com/jtheoof/swappy.
115
116
117
118                                  2022-01-22                         swappy(1)
Impressum