vimivrc man page

vimivrc — configuration files for the vimiv image viewer

Synopsis

/etc/vimiv/vimivrc, $XDG_CONFIG_HOME/vimiv/vimivrc, ~/.vimiv/vimivrc

/etc/vimiv/keys.conf, $XDG_CONFIG_HOME/vimiv/keys.conf, ~/.vimiv/keys.conf

Description

Vimiv is configured via two files:

Per default these files are installed to /etc/vimiv/. It is considered best practice to copy them to $XDG_CONFIG_HOME/vimiv/ and configure the copied files.

More information in a nicer format is available at:

http://karlch.github.io/vimiv/documentation/configuration/

Settings

Settings are configured in the vimivrc file. This file is separated into four sections:

The first three sections group settings, the fourth is used to define aliases. What each setting means and what values are possible is explained below:

General

start_fullscreen, Bool

If yes, start fullscreen.

start_slideshow, Bool

If yes, start slideshow at startup.

slideshow_delay, Float

Specify the delay for the slideshow.

shuffle, Bool

If yes, shuffle the images in the filelist randomly.

display_bar, Bool

If yes, show the statusbar at the bottom. Else hide it.Note that error messages are still displayed, even if the statusbar is hidden.

default_thumbsize, Tuple

Size for the thumbnails in the form of (x, y).

geometry, String

String in the form of "WIDTHxHEIGHT" specifying the default size for the window. Note that not all window managers respect this setting.

recursive, Bool

If yes, search the given directory recursively for images at startup.

rescale_svg, Bool

If yes, rescale vector graphics automatically by reloading the image. Otherwise simply zoom as if they were a normal image.

overzoom, Float

Float defining the maximum amount to scale images up by trying to fit the window when first loading the image.

search_case_sensitive, Bool

If yes, search case sensitively. Ignore case otherwise.

incsearch, Bool

If yes, search incrementally when typing.

copy_to_primary, Bool

If yes, copy to primary selection instead of clipboard.

commandline_padding, Int

Padding to use in the command line and statusbar.

thumb_padding, Int

Padding to use between thumbnails. Note: Additionally to the padding column spacing gets updated dynamically to best fit the current window width.

completion_height, Int

Height of the completion menu when showing command line completions.

play\_animations, Bool

If yes, animated gif are played. Otherwise stay at the first/current frame.

Library

start_show_library, Bool

If yes, always show library at start-up.

library_width, Int

Default width of the library when an image is open.

expand_lib, Bool

If yes, automatically expand the library to full window size if no image is open.

border_width, Int

Width of the border separating library and image.

markup, String

Markup used to highlight search results. This must be a correct markup opening in the form of one <span ...> element as it gets closed with </span>

show_hidden, Bool

If yes, show hidden files in the library and open hidden images.

desktop_start_dir, String

The directory in which vimiv should start if opened via the .desktop file.

file_check_amount, Int

The amount of files vimiv should check in a directory for whether they are images or not. This affects the size column of directories in the library. As soon as this number is reached, checks are stopped and a + is appended, e.g. 30+. A higher number increases precision and information at the cost of speed.

tilde_in_statusbar, Bool

If yes, collapse $HOME to ~ in the statusbar in the library.

Edit

autosave_images, Bool

If yes, automatically save rotated/flipped images to disk. Otherwise to keep changes :w must be called explicitly.

Aliases

It is possible to configure aliases for the command line in this section. An alias is defined in the form of:

aliasname: command

See also: the alias command.

Keybindings

Keybindings are defined in the keys.conf file. Similar to the vimivrc, this file is split up into sections:

Keybindings are defined in the form of:

keyname: command [arguments]

keyname has to be a valid key symbol like "a" or "b", but also e.g. "colon" for ":". A useful tool in X to check for these names interactively is xev.

Supported modifiers are:

command [arguments] has to be a valid vimiv command with correct arguments. For a complete list of commands with explanations check the commands documentation.

Mouse bindings are defined in the same form. Simply use "Button" and the corresponding number like "Button1" as keyname.

Commands

accept_changes

Accept changes made in manipulate.

alias

Add an alias for a command.

autorotate

Rotate all images in the current filelist according to exif data.

center

Scroll to the center of the image.

copy_abspath

Copy the absolute path of the currently selected file to the clipboard.

copy_basename

Copy the base name of the currently selected file to the clipboard.

delete

Delete the current image.

discard_changes

Discard any changes made in manipulate mode and leave it.

edit

Edit brightness, contrast or saturation of the current image.

first

Move to the first image of the filelist in image/thumbnail mode.

first_lib

Move to the first file of the filelist in the library.

fit

Fit the image to the current window size..

fit_horiz

Fit the image horizontally to the current window size.

fit_vert

Fit the image vertically to the current window size.

flip

Flip the current image.

focus_library

Focus the library.

format

Format all currently open filenames.

fullscreen

Toggle fullscreen mode.

last

Move to the last image of the filelist in image/thumbnail mode.

last_lib

Move to the last file of the filelist in the library.

library

Toggle the library.

manipulate

Enter manipulate mode.

mark

Mark the currently selected image.

mark_all

Mark all images in the current filelist.

mark_between

Mark all images between the last two marked images.

mark_toggle

Toggle the current mark status.

move_up

Move up one directory in the library.

next

Move to the next image in the filelist of image mode.

next!

Force moving to the next image in the filelist of image mode.

prev

Move to the previous image in the filelist of image mode.

prev!

Force moving to the previous image in the filelist of image mode.

q

Quit vimiv.

q!

Force quitting vimiv.

reload_lib

Reload the library.

rotate

Rotate the image counter-clockwise.

set

Change the value of a setting.

slideshow

Toggle the slideshow.

tag_write

Write the names of all currently marked images to a tagfile.

tag_load

Load all images in a tagfile into image mode.

tag_remove

Delete a tagfile.

thumbnail

Toggle thumbnail mode.

undelete

Undelete an image.

unfocus_library

Focus the widget last focused before the library.

version

Display pop-up with version information.

w

Explicitly save changed images to disk.

wq

Same as :w but also quit vimiv.

zoom_in

Zoom in.

zoom_out

Zoom out.

zoom_to

Zoom image to a given percentage.

Hidden Commands

The following commands can only be bound to keys and are not accessible from the command line.

clear_status

Clear any numbers or messages from the statusbar and reset search.

command

Enter the command line.

scroll

Scroll image or thumbnail.

scroll_lib

Scroll the library.

search

Search for text in the current filelist.

search_next

Navigate to the next search result.

search_prev

Navigate to the previous search result.

history_down

Go down by one in command history.

history_up

Go up by one in command history.

discard_command

Leave the command line discarding currently entered text.

complete

Start command line completion.

complete_inverse

Start command line completion selecting items inversely.

slider

Change the value of the currently focused slider.

focus_slider

Focus one of the manipulate sliders.

See Also

vimiv(1), date(1)

Referenced By

vimiv(1).

May 2017 Linux vimiv