1IMV(1) IMV(1)
2
6 imv - Image viewer for X11 and Wayland
7
9 imv is an image viewer for X11 and Wayland, aimed at users of tiling
10 window managers. It supports a wide variety of image file formats,
11 including animated gif files. imv will automatically reload the current
12 image, if it is changed on disk.
13
15 imv [options] [paths...]
16
18 -h
19 Show help message and quit.
20 -v
22 Show version and quit.
23 -b <background>
25 Set the background colour. Can either be a 6-digit hexadecimal
26 colour code or checks to show a chequered background.
27 -c <command>
29 Specify a command to be run on launch, after the configuration has
30 been loaded. Can be used to configure custom keys with the bind
31 command. This option can be used multiple times. Commands are run
32 in the order that they have been passed to imv.
33 -d
35 Start with overlay visible.
36 -f
38 Start fullscreen.
39 -l
41 List open files to stdout at exit.
42 -n <path|index>
44 Start with the given path, or index selected.
45 -r
47 Load directories recursively.
48 -s <none|shrink|full|crop>
50 Set scaling mode to use. none will show each image at its actual
51 size. shrink will scale down the image to fit inside the window.
52 full will both scale up and scale down the image to fit perfectly
53 inside the window. crop will scale and crop the image to fill the
54 window. Defaults to full.
55 -t <slideshow_duration>
57 Start in slideshow mode, with each image shown for the given number
58 of seconds.
59 -u <linear|nearest_neighbour>
61 Set upscaling method used by imv.
62 -w <windowtitle>
64 Set window title when starting imv.
65 -x
67 Disable looping of input paths.
68
70 Commands can be entered by pressing :. imv supports the following
71 commands:
72 quit
74 Quit imv. Aliased to q.
75 pan <x> <y>
77 Pan the view by the given amounts.
78 next <offset>
80 Move forwards by a given number of images. Aliased to n
81 prev <offset>
83 Move backwards by a given number of images. Aliased to p
84 goto <index>
86 Select an image by index. 1 is the first image, 2 the second, etc.
87 The last image can be indexed as -1, the second last as -2. Aliased
88 to g.
89 zoom <amount|actual>
91 Zoom into the image by the given amount. Negative values zoom out.
92 actual resets the zoom to 100%, showing the image at its actual
93 size. Aliased to z.
94 rotate <'to'|by> <angle>
96 Rotate image clockwise by/to the given amount in degrees.
97 flip <'horizontal'|vertical>
99 Flip image horizontally/vertically (across vertical/horizontal
100 axis).
101 open [-r] <paths ...>
103 Add the given paths to the list of open images. If the -r option is
104 specified, do so recursively. Shell expansions may be used. Aliased
105 to o.
106 close [index|all]
108 Close the currently selected image, or the image at the given
109 index, or all images.
110 fullscreen
112 Toggle fullscreen.
113 overlay
115 Toggle the overlay.
116 exec <command>
118 Execute a shell command. imv provides various environment variables
119 to the command executed. These are documented in the Environment
120 Variables section.
121 center
123 Recenter the selected image.
124 reset
126 Reset the view, centering the image and using the current scaling
127 mode to rescale it.
128 next_frame
130 If an animated gif is currently being displayed, load the next
131 frame.
132 toggle_playing
134 Toggle playback of the current image if it is an animated gif.
135 scaling <none|shrink|full|crop|next>
137 Set the current scaling mode. Setting the mode to next advances it
138 to the next mode in the list.
139 upscaling <linear|nearest_neighbour|next>
141 Set the current upscaling method. Setting the method to next
142 advances it to the next method in the list.
143 slideshow <+amount|-amount|duration>
145 Increase or decrease the slideshow duration by the given amount in
146 seconds, or set its duration directly. Aliased to ss.
147 background <checks|hexadecimal-code>
149 Set the background color. checks for a chequerboard pattern, or
150 specify a 6-digit hexadecimal color code. Aliased to bg.
151 bind <keys> <commands>
153 Binds an action to a set of key inputs. Uses the same syntax as the
154 config file, but without an equals sign between the keys and the
155 commands. For more information on syntax, see imv(5).
156
158 imv comes with several binds configured by default
159 q
161 Quit
162 Left arrow,
164 Previous image
165 Right arrow
167 Next Image
168 gg
170 Go to first image
171 G
173 Go to last image
174 j
176 Pan down
177 k
179 Pan up
180 h
182 Pan left
183 l
185 Pan right
186 x
188 Close current image
189 f
191 Toggle fullscreen
192 d
194 Toggle overlay
195 p
197 Print current image to stdout
198 Up arrow
200 Zoom in
201 Down arrow
203 Zoom out
204 i
206 Zoom in
207 o
209 Zoom out
210 +
212 Zoom in
213 -
215 Zoom out
216 Ctrl+r
218 Rotate clockwise by 90 degrees
219 c
221 Center image
222 s
224 Next scaling mode
225 S
227 Next upscaling mode
228 a
230 Zoom to actual size
231 r
233 Reset zoom and pan
234 .
236 Next frame (for animations)
237 Space
239 Pause/play animations
240 t
242 Start slideshow/increase delay by 1 second
243 T
245 Stop slideshow/decrease delay by 1 second
246
248 The path to a config file can be given via the $imv_config environment
249 variable. If not found, imv will search for it in the following
250 locations:
251 • $XDG_CONFIG_HOME/imv/config (recommended)
253 • $HOME/.config/imv/config
255 • $HOME/.imv_config
257 • $HOME/.imv/config
259 • /usr/local/etc/imv_config
261 • /etc/imv_config
263 A default config file is shipped with imv into /etc/imv_config
265 For documentation on the config file format, see imv(5).
267
269 When imv executes a shell command, it provides a number of environment
270 variables, exposing imv’s state. These environment variables are also
271 available when customising the window’s title, or the overlay text.
272 $imv_pid
274 The pid of this instance of imv. Useful for running imv-msg in
275 scripts.
276 $imv_current_file
278 Path of currently selected image.
279 $imv_scaling_mode
281 Name of the current scaling mode.
282 $imv_loading
284 1 if a new image is loading, 0 otherwise.
285 $imv_current_index
287 Index of current image, from 1-N.
288 $imv_file_count
290 Total number of files.
291 $imv_width
293 Width of the current image.
294 $imv_height
296 Height of the current image.
297 $imv_scale
299 Scaling of current image in percent.
300 $imv_slideshow_duration
302 Number of seconds each image is shown for.
303 $imv_slideshow_elapsed
305 How long the current image has been shown for.
306
308 imv can accept commands from another process over a unix socket. Each
309 instance of imv will open a unix socket named
310 $XDG_RUNTIME_DIR/imv-$PID.sock. If $XDG_RUNTIME_DIR is undefined, the
311 socket is placed into /tmp/ instead.
312 The imv-msg(1) utility is provided to simplify this from shell scripts.
314
316 imv is written and maintained by Harry Jeffery <me@harry.pm> with
317 contributions from other developers.
318 Full source code and other information can be found at
320 https://sr.ht/~exec64/imv.
321
323 imv(5) imv-msg(1) imv-dir(1)
324 07/20/2023 IMV(1)