1IMV(1)                                                                  IMV(1)
2
3
4

NAME

6       imv - Image viewer for X11 and Wayland
7

DESCRIPTION

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

SYNOPSIS

15       imv [options] [paths...]
16

OPTIONS

18       -h
19           Show help message and quit.
20
21       -v
22           Show version and quit.
23
24       -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
28       -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
34       -d
35           Start with overlay visible.
36
37       -f
38           Start fullscreen.
39
40       -l
41           List open files to stdout at exit.
42
43       -n <path|index>
44           Start with the given path, or index selected.
45
46       -r
47           Load directories recursively.
48
49       -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
56       -t <slideshow_duration>
57           Start in slideshow mode, with each image shown for the given number
58           of seconds.
59
60       -u <linear|nearest_neighbour>
61           Set upscaling method used by imv.
62
63       -x
64           Disable looping of input paths.
65

COMMANDS

67       Commands can be entered by pressing :. imv supports the following
68       commands:
69
70       quit
71           Quit imv. Aliased to q.
72
73       pan <x> <y>
74           Pan the view by the given amounts.
75
76       next <offset>
77           Move forwards by a given number of images. Aliased to n
78
79       prev <offset>
80           Move backwards by a given number of images. Aliased to p
81
82       goto <index>
83           Select an image by index.  1 is the first image, 2 the second, etc.
84           The last image can be indexed as -1, the second last as -2. Aliased
85           to g.
86
87       zoom <amount|actual>
88           Zoom into the image by the given amount. Negative values zoom out.
89           actual resets the zoom to 100%, showing the image at its actual
90           size. Aliased to z.
91
92       rotate <'to'|by> <angle>
93           Rotate image clockwise by/to the given amount in degrees.
94
95       flip <'horizontal'|vertical>
96           Flip image horizontally/vertically (across vertical/horizontal
97           axis).
98
99       open [-r] <paths ...>
100           Add the given paths to the list of open images. If the -r option is
101           specified, do so recursively. Shell expansions may be used. Aliased
102           to o.
103
104       close [index|all]
105           Close the currently selected image, or the image at the given
106           index, or all images.
107
108       fullscreen
109           Toggle fullscreen.
110
111       overlay
112           Toggle the overlay.
113
114       exec <command>
115           Execute a shell command. imv provides various environment variables
116           to the command executed. These are documented in the Environment
117           Variables section.
118
119       center
120           Recenter the selected image.
121
122       reset
123           Reset the view, centering the image and using the current scaling
124           mode to rescale it.
125
126       next_frame
127           If an animated gif is currently being displayed, load the next
128           frame.
129
130       toggle_playing
131           Toggle playback of the current image if it is an animated gif.
132
133       scaling <none|shrink|full|crop|next>
134           Set the current scaling mode. Setting the mode to next advances it
135           to the next mode in the list.
136
137       upscaling <linear|nearest_neighbour|next>
138           Set the current upscaling method. Setting the method to next
139           advances it to the next method in the list.
140
141       slideshow <+amount|-amount|duration>
142           Increase or decrease the slideshow duration by the given amount in
143           seconds, or set its duration directly. Aliased to ss.
144
145       background <checks|hexadecimal-code>
146           Set the background color.  checks for a chequerboard pattern, or
147           specify a 6-digit hexadecimal color code. Aliased to bg.
148
149       bind <keys> <commands>
150           Binds an action to a set of key inputs. Uses the same syntax as the
151           config file, but without an equals sign between the keys and the
152           commands. For more information on syntax, see imv(5).
153

DEFAULT BINDS

155       imv comes with several binds configured by default
156
157       q
158           Quit
159
160       Left arrow,
161           Previous image
162
163       Right arrow
164           Next Image
165
166       gg
167           Go to first image
168
169       G
170           Go to last image
171
172       j
173           Pan down
174
175       k
176           Pan up
177
178       h
179           Pan left
180
181       l
182           Pan right
183
184       x
185           Close current image
186
187       f
188           Toggle fullscreen
189
190       d
191           Toggle overlay
192
193       p
194           Print current image to stdout
195
196       Up arrow
197           Zoom in
198
199       Down arrow
200           Zoom out
201
202       i
203           Zoom in
204
205       o
206           Zoom out
207
208       +
209           Zoom in
210
211       -
212           Zoom out
213
214       Ctrl+r
215           Rotate clockwise by 90 degrees
216
217       c
218           Center image
219
220       s
221           Next scaling mode
222
223       S
224           Next upscaling mode
225
226       a
227           Zoom to actual size
228
229       r
230           Reset zoom and pan
231
232       .
233           Next frame (for animations)
234
235       Space
236           Pause/play animations
237
238       t
239           Start slideshow/increase delay by 1 second
240
241       T
242           Stop slideshow/decrease delay by 1 second
243

CONFIGURATION

245       The path to a config file can be given via the $imv_config environment
246       variable. If not found, imv will search for it in the following
247       locations:
248
249       •   $XDG_CONFIG_HOME/imv/config (recommended)
250
251       •   $HOME/.config/imv/config
252
253       •   $HOME/.imv_config
254
255       •   $HOME/.imv/config
256
257       •   /usr/local/etc/imv_config
258
259       •   /etc/imv_config
260
261       A default config file is shipped with imv into /etc/imv_config
262
263       For documentation on the config file format, see imv(5).
264

ENVIRONMENT VARIABLES

266       When imv executes a shell command, it provides a number of environment
267       variables, exposing imv’s state. These environment variables are also
268       available when customising the window’s title, or the overlay text.
269
270       $imv_pid
271           The pid of this instance of imv. Useful for running imv-msg in
272           scripts.
273
274       $imv_current_file
275           Path of currently selected image.
276
277       $imv_scaling_mode
278           Name of the current scaling mode.
279
280       $imv_loading
281           1 if a new image is loading, 0 otherwise.
282
283       $imv_current_index
284           Index of current image, from 1-N.
285
286       $imv_file_count
287           Total number of files.
288
289       $imv_width
290           Width of the current image.
291
292       $imv_height
293           Height of the current image.
294
295       $imv_scale
296           Scaling of current image in percent.
297
298       $imv_slideshow_duration
299           Number of seconds each image is shown for.
300
301       $imv_slideshow_elapsed
302           How long the current image has been shown for.
303

IPC

305       imv can accept commands from another process over a unix socket. Each
306       instance of imv will open a unix socket named
307       $XDG_RUNTIME_DIR/imv-$PID.sock. If $XDG_RUNTIME_DIR is undefined, the
308       socket is placed into /tmp/ instead.
309
310       The imv-msg(1) utility is provided to simpliy this from shell scripts.
311

AUTHORS

313       imv is written and maintained by Harry Jeffery <me@harry.pm> with
314       contributions from other developers.
315
316       Full source code and other information can be found at
317       https://github.com/eXeC64/imv.
318

SEE ALSO

320       imv(5) imv-msg(1) imv-folder(1)
321
322
323
324                                  08/06/2021                            IMV(1)
Impressum