vimivrc(5)

1VIMVRC(5)                            vimiv                           VIMVRC(5)
2
3
4

NAME

6       vimivrc - configuration files for the vimiv image viewer
7

SYNOPSIS

9       /etc/vimiv/vimivrc, $XDG_CONFIG_HOME/vimiv/vimivrc, ~/.vimiv/vimivrc
10
11       /etc/vimiv/keys.conf,                 $XDG_CONFIG_HOME/vimiv/keys.conf,
12       ~/.vimiv/keys.conf
13

DESCRIPTION

15       Vimiv is configured via two files:
16
17              · the vimivrc for basic configuration
18
19              · the keys.conf for keybindings
20
21       Per default these files are installed to /etc/vimiv/. It is  considered
22       best practice to copy them to $XDG_CONFIG_HOME/vimiv/ and configure the
23       copied files.
24
25       More information in a nicer format is available at:
26
27       ⟨http://karlch.github.io/vimiv/documentation/configuration/⟩
28

SETTINGS

30       Settings are configured in the vimivrc file.  This  file  is  separated
31       into four sections:
32
33              · GENERAL
34
35              · LIBRARY
36
37              · EDIT
38
39              · ALIASES
40
41       The  first  three sections group settings, the fourth is used to define
42       aliases.  What each setting means  and  what  values  are  possible  is
43       explained below:
44
45   GENERAL
46       start_fullscreen, Bool
47              If yes, start fullscreen.
48
49       start_slideshow, Bool
50              If yes, start slideshow at startup.
51
52       slideshow_delay, Float
53              Specify the delay for the slideshow.
54
55       shuffle, Bool
56              If yes, shuffle the images in the filelist randomly.
57
58       display_bar, Bool
59              If yes, show the statusbar at the bottom. Else hide it.Note that
60              error messages are still displayed, even  if  the  statusbar  is
61              hidden.
62
63       default_thumbsize, Tuple
64              Size for the thumbnails in the form of (x, y).
65
66       geometry, String
67              String in the form of "WIDTHxHEIGHT" specifying the default size
68              for the window. Note that not all window managers  respect  this
69              setting.
70
71       recursive, Bool
72              If  yes,  search  the  given directory recursively for images at
73              startup.
74
75       rescale_svg, Bool
76              If yes, rescale vector graphics automatically by  reloading  the
77              image. Otherwise simply zoom as if they were a normal image.
78
79       overzoom, Float
80              Float  defining  the maximum amount to scale images up by trying
81              to fit the window when first loading the image.
82
83       search_case_sensitive, Bool
84              If yes, search case sensitively. Ignore case otherwise.
85
86       incsearch, Bool
87              If yes, search incrementally when typing.
88
89       copy_to_primary, Bool
90              If yes, copy to primary selection instead of clipboard.
91
92       commandline_padding, Int
93              Padding to use in the command line and statusbar.
94
95       thumb_padding, Int
96              Padding to use between thumbnails.  Note:  Additionally  to  the
97              padding  column spacing gets updated dynamically to best fit the
98              current window width.
99
100       completion_height, Int
101              Height of the completion menu when showing command line  comple‐
102              tions.
103
104       play\_animations, Bool
105              If   yes,  animated  gif  are  played.  Otherwise  stay  at  the
106              first/current frame.
107
108   LIBRARY
109       start_show_library, Bool
110              If yes, always show library at start-up.
111
112       library_width, Int
113              Default width of the library when an image is open.
114
115       expand_lib, Bool
116              If yes, automatically expand the library to full window size  if
117              no image is open.
118
119       border_width, Int
120              Width of the border separating library and image.
121
122       markup, String
123              Markup  used to highlight search results. This must be a correct
124              markup opening in the form of one <span ...> element as it  gets
125              closed with </span>
126
127       show_hidden, Bool
128              If yes, show hidden files in the library and open hidden images.
129
130       desktop_start_dir, String
131              The  directory  in  which  vimiv  should start if opened via the
132              .desktop file.
133
134       file_check_amount, Int
135              The amount of files  vimiv  should  check  in  a  directory  for
136              whether  they are images or not. This affects the size column of
137              directories in the library. As soon as this number  is  reached,
138              checks  are stopped and a + is appended, e.g. 30+. A higher num‐
139              ber increases precision and information at the cost of speed.
140
141       tilde_in_statusbar, Bool
142              If yes, collapse $HOME to ~ in the statusbar in the library.
143
144   EDIT
145       autosave_images, Bool
146              If yes, automatically save rotated/flipped images to disk.  Oth‐
147              erwise to keep changes :w must be called explicitly.
148
149   ALIASES
150       It  is  possible to configure aliases for the command line in this sec‐
151       tion.  An alias is defined in the form of:
152
153       aliasname: command
154
155       See also: the alias command.
156

KEYBINDINGS

158       Keybindings are defined in the keys.conf file. Similar to the  vimivrc,
159       this file is split up into sections:
160
161              · IMAGE: Keybindings defined here apply in image mode.
162
163              · THUMBNAIL: Keybindings defined here apply in thumbnail mode.
164
165              · LIBRARY: Keybindings defined here apply in library mode.
166
167              · MANIPULATE: Keybindings defined here apply in manipulate mode.
168
169              · COMMAND: Keybindings defined here apply in the command line.
170
171       Keybindings are defined in the form of:
172
173       keyname: command [arguments]
174
175       keyname  has  to  be  a valid key symbol like "a" or "b", but also e.g.
176       "colon" for ":". A useful tool in X to check for these  names  interac‐
177       tively is xev.
178
179       Supported modifiers are:
180
181              · Shift via Shift+keyname
182
183              · Control via ^keyname
184
185              · Alt via Alt+keyname
186
187       command  [arguments] has to be a valid vimiv command with correct argu‐
188       ments. For a complete list of commands with explanations check the com‐
189       mands documentation.
190
191       Mouse  bindings  are  defined in the same form. Simply use "Button" and
192       the corresponding number like "Button1" as keyname.
193

COMMANDS

195       accept_changes
196              Accept changes made in manipulate.
197
198       alias  Add an alias for a command.
199
200       autorotate
201              Rotate all images in the  current  filelist  according  to  exif
202              data.
203
204       center Scroll to the center of the image.
205
206       copy_abspath
207              Copy  the  absolute  path  of the currently selected file to the
208              clipboard.
209
210       copy_basename
211              Copy the base name of the currently selected file to  the  clip‐
212              board.
213
214       delete Delete the current image.
215
216       discard_changes
217              Discard any changes made in manipulate mode and leave it.
218
219       edit   Edit brightness, contrast or saturation of the current image.
220
221       first  Move to the first image of the filelist in image/thumbnail mode.
222
223       first_lib
224              Move to the first file of the filelist in the library.
225
226       fit    Fit the image to the current window size..
227
228       fit_horiz
229              Fit the image horizontally to the current window size.
230
231       fit_vert
232              Fit the image vertically to the current window size.
233
234       flip   Flip the current image.
235
236       focus_library
237              Focus the library.
238
239       format Format all currently open filenames.
240
241       fullscreen
242              Toggle fullscreen mode.
243
244       last   Move to the last image of the filelist in image/thumbnail mode.
245
246       last_lib
247              Move to the last file of the filelist in the library.
248
249       library
250              Toggle the library.
251
252       manipulate
253              Enter manipulate mode.
254
255       mark   Mark the currently selected image.
256
257       mark_all
258              Mark all images in the current filelist.
259
260       mark_between
261              Mark all images between the last two marked images.
262
263       mark_toggle
264              Toggle the current mark status.
265
266       move_up
267              Move up one directory in the library.
268
269       next   Move to the next image in the filelist of image mode.
270
271       next!  Force moving to the next image in the filelist of image mode.
272
273       prev   Move to the previous image in the filelist of image mode.
274
275       prev!  Force  moving  to  the  previous  image in the filelist of image
276              mode.
277
278       q      Quit vimiv.
279
280       q!     Force quitting vimiv.
281
282       reload_lib
283              Reload the library.
284
285       rotate Rotate the image counter-clockwise.
286
287       set    Change the value of a setting.
288
289       slideshow
290              Toggle the slideshow.
291
292       tag_write
293              Write the names of all currently marked images to a tagfile.
294
295       tag_load
296              Load all images in a tagfile into image mode.
297
298       tag_remove
299              Delete a tagfile.
300
301       thumbnail
302              Toggle thumbnail mode.
303
304       undelete
305              Undelete an image.
306
307       unfocus_library
308              Focus the widget last focused before the library.
309
310       version
311              Display pop-up with version information.
312
313       w      Explicitly save changed images to disk.
314
315       wq     Same as :w but also quit vimiv.
316
317       zoom_in
318              Zoom in.
319
320       zoom_out
321              Zoom out.
322
323       zoom_to
324              Zoom image to a given percentage.
325

HIDDEN COMMANDS

327       The following commands can only be bound to keys and are not accessible
328       from the command line.
329
330       clear_status
331              Clear  any  numbers  or  messages  from  the statusbar and reset
332              search.
333
334       command
335              Enter the command line.
336
337       scroll Scroll image or thumbnail.
338
339       scroll_lib
340              Scroll the library.
341
342       search Search for text in the current filelist.
343
344       search_next
345              Navigate to the next search result.
346
347       search_prev
348              Navigate to the previous search result.
349
350       history_down
351              Go down by one in command history.
352
353       history_up
354              Go up by one in command history.
355
356       discard_command
357              Leave the command line discarding currently entered text.
358
359       complete
360              Start command line completion.
361
362       complete_inverse
363              Start command line completion selecting items inversely.
364
365       slider Change the value of the currently focused slider.
366
367       focus_slider
368              Focus one of the manipulate sliders.
369