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>
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. Defaults to full.
54 -t <slideshow_duration>
56 Start in slideshow mode, with each image shown for the given number
57 of seconds.
58 -u <linear|nearest_neighbour>
60 Set upscaling method used by imv.
61 -x
63 Disable looping of input paths.
64
66 Commands can be entered by pressing :. imv supports the following
67 commands:
68 quit
70 Quit imv. Aliased to q.
71 pan <x> <y>
73 Pan the view by the given amounts.
74 next <offset>
76 Move forwards by a given number of images. Aliased to n
77 prev <offset>
79 Move backwards by a given number of images. Aliased to p
80 goto <index>
82 Select an image by index. 1 is the first image, 2 the second, etc.
83 The last image can be indexed as -1, the second last as -2. Aliased
84 to g.
85 zoom <amount|actual>
87 Zoom into the image by the given amount. Negative values zoom out.
88 actual resets the zoom to 100%, showing the image at its actual
89 size. Aliased to z.
90 open [-r] <paths ...>
92 Add the given paths to the list of open images. If the -r option is
93 specified, do so recursively. Shell expansions may be used. Aliased
94 to o.
95 close [index|all]
97 Close the currently selected image, or the image at the given
98 index, or all images.
99 fullscreen
101 Toggle fullscreen.
102 overlay
104 Toggle the overlay.
105 exec <command>
107 Execute a shell command. imv provides various environment variables
108 to the command executed. These are documented in the Environment
109 Variables section.
110 center
112 Recenter the selected image.
113 reset
115 Reset the view, centering the image and using the current scaling
116 mode to rescale it.
117 next_frame
119 If an animated gif is currently being displayed, load the next
120 frame.
121 toggle_playing
123 Toggle playback of the current image if it is an animated gif.
124 scaling <none|shrink|full|crop|next>
126 Set the current scaling mode. Setting the mode to next advances it
127 to the next mode in the list.
128 upscaling <linear|nearest_neighbour|next>
130 Set the current upscaling method. Setting the method to next
131 advances it to the next method in the list.
132 slideshow <+amount|-amount|duration>
134 Increase or decrease the slideshow duration by the given amount in
135 seconds, or set its duration directly. Aliased to ss.
136 background <checks|hexadecimal-code>
138 Set the background color. checks for a chequerboard pattern, or
139 specify a 6-digit hexadecimal color code. Aliased to bg.
140 bind <keys> <commands>
142 Binds an action to a set of key inputs. Uses the same syntax as the
143 config file, but without an equals sign between the keys and the
144 commands. For more information on syntax, see imv(5).
145
147 imv comes with several binds configured by default
148 q
150 Quit
151 Left arrow,
153 Previous image
154 Right arrow
156 Next Image
157 gg
159 Go to first image
160 G
162 Go to last image
163 j
165 Pan down
166 k
168 Pan up
169 h
171 Pan left
172 l
174 Pan right
175 x
177 Close current image
178 f
180 Toggle fullscreen
181 d
183 Toggle overlay
184 p
186 Print current image to stdout
187 Up arrow
189 Zoom in
190 Down arrow
192 Zoom out
193 i
195 Zoom in
196 o
198 Zoom out
199 +
201 Zoom in
202 -
204 Zoom out
205 c
207 Center image
208 s
210 Next scaling mode
211 S
213 Next upscaling mode
214 a
216 Zoom to actual size
217 r
219 Reset zoom and pan
220 .
222 Next frame (for animations)
223 Space
225 Pause/play animations
226 t
228 Start slideshow/increase delay by 1 second
229 T
231 Stop slideshow/decrease delay by 1 second
232
234 The path to a config file can be given via the $imv_config environment
235 variable. If not found, imv will search for it in the following
236 locations:
237 · $XDG_CONFIG_HOME/imv/config (recommended)
239 · $HOME/.config/imv/config
241 · $HOME/.imv_config
243 · $HOME/.imv/config
245 · /usr/local/etc/imv_config
247 · /etc/imv_config
249 A default config file is shipped with imv into /etc/imv_config
251 For documentation on the config file format, see imv(5).
253
255 When imv executes a shell command, it provides a number of environment
256 variables, exposing imv’s state. These environment variables are also
257 available when customising the window’s title, or the overlay text.
258 $imv_pid
260 The pid of this instance of imv. Useful for running imv-msg in
261 scripts.
262 $imv_current_file
264 Path of currently selected image.
265 $imv_scaling_mode
267 Name of the current scaling mode.
268 $imv_loading
270 1 if a new image is loading, 0 otherwise.
271 $imv_current_index
273 Index of current image, from 1-N.
274 $imv_file_count
276 Total number of files.
277 $imv_width
279 Width of the current image.
280 $imv_height
282 Height of the current image.
283 $imv_scale
285 Scaling of current image in percent.
286 $imv_slideshow_duration
288 Number of seconds each image is shown for.
289 $imv_slideshow_elapsed
291 How long the current image has been shown for.
292
294 imv can accept commands from another process over a unix socket. Each
295 instance of imv will open a unix socket named
296 $XDG_RUNTIME_DIR/imv-$PID.sock. If $XDG_RUNTIME_DIR is undefined, the
297 socket is placed into /tmp/ instead.
298 The imv-msg(1) utility is provided to simpliy this from shell scripts.
300
302 imv is written and maintained by Harry Jeffery <me@harry.pm> with
303 contributions from other developers.
304 Full source code and other information can be found at
306 https://github.com/eXeC64/imv.
307
309 imv(5) imv-msg(1)
310 03/25/2020 IMV(1)