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

NAME

6       imv - imv configuration file
7

DESCRIPTION

9       imv can be customised with this configuration file, changing its
10       default behaviour, key bindings, and appearance.
11
12       The imv configuration file is an ini-style file, with multiple key =
13       value settings, separated into several '[section]'s.
14

OPTIONS

16       The [options] section accepts the following settings:
17
18       background = <hex-code|checks>
19           Set the background in imv. Can either be a 6-digit hexadecimal
20           colour code, or checks for a chequered background. Defaults to
21           000000
22
23       fullscreen = <true|false>
24           Start imv fullscreen. Defaults to false.
25
26       width = <width>
27           Initial width of the imv window. Defaults to 1280.
28
29       height = <height>
30           Initial height of the imv window. Defaults to 720.
31
32       initial_pan = <pan_factor_x> <pan_factor_y>
33           Initial pan/focus position factor of the opened images. A value of
34           50 represents the middle point of the image (50%). Defaults to 50
35           50
36
37       list_files_at_exit = <true|false>
38           Print open files to stdout at exit, each on a separate line.
39           Defaults to false.
40
41       loop_input = <true|false>
42           Return to first image after viewing the last one. Defaults to true.
43
44       overlay = <true|false>
45           Start with the overlay visible. Defaults to false.
46
47       overlay_font = <typeface:size>
48           Use the specified font in the overlay. Defaults to Monospace:24.
49
50       overlay_text = <text>
51           Use the given text as the overlay’s text. The provided text is
52           shell expanded, so the output of commands can be used (for example,
53           $(ls)). Environment variables can also be used, including the ones
54           accessible to imv’s exec command.
55
56       overlay_text_color = <hex-code>
57           Set the color for the text in the overlay. Is a 6-digit hexadecimal
58           color code. Defaults to ffffff.
59
60       overlay_text_alpha = <hex-code>
61           Set the alpha for the text in the overlay. Is a 2-digit hexadecimal
62           color code. Defaults to ff.
63
64       overlay_background_color = <hex-code>
65           Set the color for the background of the overlay. Is a 6-digit
66           hexadecimal color code. Defaults to 000000.
67
68       overlay_background_alpha = <hex-code>
69           Set the alpha for the background of the overlay. Is a 2-digit
70           hexadecimal color code. Defaults to c3.
71
72       overlay_position_bottom = <true|false>
73           Display the overlay at the bottom of the imv window, instead of the
74           top.
75
76       recursively = <true|false>
77           Load input paths recursively. Defaults to false.
78
79       scaling_mode = <none|shrink|full|crop>
80           Set scaling mode to use.  none will show each image at its actual
81           size.  shrink will scale down the image to fit inside the window.
82           full will both scale up and scale down the image to fit perfectly
83           inside the window.  crop will scale and crop the image to fill the
84           window. Defaults to full.
85
86       slideshow_duration = <duration>
87           Start imv in slideshow mode, and set the amount of time to show
88           each image for in seconds. Defaults to 0, i.e. no slideshow.
89
90       suppress_default_binds = <true|false>
91           Disable imv’s built-in binds so they don’t conflict with custom
92           ones. Defaults to false.
93
94       title_text = <text>
95           Use the given text as the window’s title. The provided text is
96           shell expanded, so the output of commands can be used: $(ls) as can
97           environment variables, including the ones accessible to imv’s exec
98           command.
99
100       upscaling_method = <linear|nearest_neighbour>
101           Use the specified method to upscale images. Defaults to linear.
102

ALIASES

104       The [aliases] section allows aliases to be added for imv’s build in
105       commands. For example, x = close would add a x command that simply
106       executes the close command. Any arguments provided to an alias are
107       appended to the command configured by the alias.
108

BINDS

110       The [binds] section allows custom key bindings to be added to imv.
111
112       Binds are in the format key combination = command. A key combination
113       can consist of multiple keys in succession. Multiple commands for a
114       single key combination can be defined by separating each command with a
115       ;. Single and double quotes are honoured, as is escaping with a
116       backslash, to allow the proper quoting of shell commands.
117
118       Single keys such as q are just that: q = quit will bind the q key to
119       the quit command.
120
121       Modifier keys can be specified by prefixing them: Ctrl+q, Meta+f,
122       Shift+G. If multiple modifier keys are desired, they are specified in
123       the order Ctrl+Meta+Shift. When a key’s name is more than a single
124       character, or a modifier is used it must be wrapped in < and >, for
125       example: <Ctrl+q>.
126
127       Multiple keys in succession can be specified by listing them in order:
128       gg = goto 1 will bind two presses of the g key to jump to the first
129       image, and <Ctrl+a>p = exec echo hi will bind the key sequence of
130       Ctrl+a followed by p to executing the shell command echo hi.
131
132       Many keys, such as <, and > have special names. On X11, these can be
133       easily found with the xev(1) command. For example, ! is called exclam,
134       < is called less, > is called greater.
135
136       A complete list of keysyms can also be found on most systems with the
137       dumpkeys -l command.
138
139       imv(1)
140
141
142
143                                  07/20/2023                            IMV(5)
Impressum