'\" t
.\"     Title: imvr
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 05/07/2018
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "IMVR" "5" "05/07/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
imv \- imv configuration file
.SH "DESCRIPTION"
.sp
imv can be customised with this configuration file, changing its default behaviour, key bindings, and appearance\&.
.sp
The imv configuration file is an ini\-style file, with multiple \fIkey = value\fR settings, separated into several \*(Aq[section]\*(Aqs\&.
.SH "OPTIONS"
.sp
The \fB[options]\fR section accepts the following settings:
.PP
\fBbackground\fR = <hex\-code|\fIchecks\fR>
.RS 4
Set the background in imv\&. Can either be a 6\-digit hexadecimal colour code, or
\fIchecks\fR
for a chequered background\&. Defaults to
\fI000000\fR
.RE
.PP
\fBfullscreen\fR = <true|false>
.RS 4
Start imv fullscreen\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBwidth\fR = <width>
.RS 4
Initial width of the imv window\&. Defaults to 1280\&.
.RE
.PP
\fBheight\fR = <height>
.RS 4
Initial height of the imv window\&. Defaults to 720\&.
.RE
.PP
\fBlist_files_at_exit\fR = <true|false>
.RS 4
Print open files to stdout at exit, each on a separate line\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBloop_input\fR = <true|false>
.RS 4
Return to first image after viewing the last one\&. Defaults to
\fItrue\fR\&.
.RE
.PP
\fBoverlay\fR = <true|false>
.RS 4
Start with the overlay visible\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBoverlay_font\fR = <typeface:size>
.RS 4
Use the specified font in the overlay\&. Defaults to
\fIMonospace:24\fR\&.
.RE
.PP
\fBoverlay_text\fR = <text>
.RS 4
Use the given text as the overlay\(cqs text\&. The provided text is shell expanded, so the output of commands can be used:
\fI$(ls)\fR
as can environment variables, including the ones accessible to imv\(cqs
\fIexec\fR
command\&.
.RE
.PP
\fBrecursively\fR = <true|false>
.RS 4
Load input paths recursively\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBscaling_mode\fR = <none|shrink|full>
.RS 4
Set scaling mode to use\&.
\fInone\fR
will show each image at its actual size\&.
\fIshrink\fR
will scale down the image to fit inside the window\&.
\fIfull\fR
will both scale up and scale down the image to fit perfectly inside the window\&. Defaults to
\fIfull\fR\&.
.RE
.PP
\fBslideshow_duration\fR = <duration>
.RS 4
Start imv in slideshow mode, and set the amount of time to show each image for in seconds\&. Defaults to
\fI0\fR, i\&.e\&. no slideshow\&.
.RE
.PP
\fBstay_fullscreen_on_focus_loss\fR = <true|false>
.RS 4
Stay full screen even when imv loses focus\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBsuppess_default_binds\fR = <true|false>
.RS 4
Disable imv\(cqs built\-in binds so they don\(cqt conflict with custom ones\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBtitle_text\fR = <text>
.RS 4
Use the given text as the window\(cqs title\&. The provided text is shell expanded, so the output of commands can be used:
\fI$(ls)\fR
as can environment variables, including the ones accessible to imv\(cqs
\fIexec\fR
command\&.
.RE
.PP
\fBupscaling_method\fR = <linear|nearest_neighbour>
.RS 4
Use the specified method to upscale images\&. Defaults to
\fIlinear\fR\&.
.RE
.SH "ALIASES"
.sp
The \fB[aliases]\fR section allows imv\(cqs commands to be aliases\&. For example: \fIq = quit\fR would add a \fIq\fR command that simply executes the \fIquit\fR command\&. And \fInext = select_rel 1\fR would add a \fInext\fR command to imv\&.
.SH "BINDS"
.sp
The \fB[binds]\fR section allows custom key bindings to be added to imv\&.
.sp
Binds are in the format \fIkey combination = command\fR\&. A key combination can consist of multiple keys in succession\&.
.sp
Single keys such as \fIq\fR are just that: \fIq = quit\fR will bind the \fIq\fR key to the \fIquit\fR command\&.
.sp
Modifier keys can be specified by prefixing them: \fICtrl+q\fR, \fIMeta+f\fR, \fIShift+g\fR\&. If multiple modifier keys are desired, they are specified in the order \fICtrl+Meta+Shift\fR\&. When a key\(cqs name is more than a single character, or a modifier is used it must be wrapped in \fI<\fR and \fI>\fR, for example: \fI<Ctrl+q>\fR\&.
.sp
Multiple keys in succession can be specified by listing them in order: \fIgg = select_abs 0\fR will bind two presses of the \fIg\fR key to jump to the first image, and \fI<Ctrl+a>p = exec echo hi\fR will bind the key sequence of \fICtrl+a\fR followed by \fIp\fR to executing the shell command \fIecho hi\fR\&.
.sp
N\&.B\&. Special characters such as \fI!\fR are not named directly, and are accessed by their regular key, combined with the shift modifier: \fIShift+1\fR\&.
.sp
Some keys, such as \fI<\fR, and \fI>\fR have special names, to avoid conflits with the bind syntax, or the config file format\&. Other keys with no character associated with them, such as the \fIReturn\fR key or the arrow keys also have special names\&. These are as follows:
.PP
\fBApplication\fR
.RS 4
The Application / Compose / Context Menu / Alt Gr key\&.
.RE
.PP
\fBAudioMute\fR
.RS 4
The mute volume key\&.
.RE
.PP
\fBAudioNext\fR
.RS 4
The next track media key\&.
.RE
.PP
\fBAudioPlay\fR
.RS 4
The play media key\&.
.RE
.PP
\fBAudioPrev\fR
.RS 4
The previous track media key\&.
.RE
.PP
\fBAudioStop\fR
.RS 4
The stop media key\&.
.RE
.PP
\fBBackspace\fR
.RS 4
The backspace key\&.
.RE
.PP
\fBBrightnessDown\fR
.RS 4
The brightness down key\&.
.RE
.PP
\fBBrightnessUp\fR
.RS 4
The brightness up key\&.
.RE
.PP
\fBCancel\fR
.RS 4
The cancel key\&.
.RE
.PP
\fBClear\fR
.RS 4
The clear key\&.
.RE
.PP
\fBDelete\fR
.RS 4
The delete key\&.
.RE
.PP
\fBDown\fR
.RS 4
The down arrow key\&.
.RE
.PP
\fBEject\fR
.RS 4
The eject key\&.
.RE
.PP
\fBEnd\fR
.RS 4
The end key\&.
.RE
.PP
\fBEscape\fR
.RS 4
The Esc / escape key\&.
.RE
.PP
\fBEquals\fR
.RS 4
The = key\&.
.RE
.PP
\fBF<1\-24>\fR
.RS 4
The F keys\&.
.RE
.PP
\fBHome\fR
.RS 4
The home key\&.
.RE
.PP
\fBKeypad <00|000|0\-9>\fR
.RS 4
The numeric keypad number keys\&.
.RE
.PP
\fBKeypad Backspace\fR
.RS 4
The numeric keypad backspace key\&.
.RE
.PP
\fBKeypad Clear\fR
.RS 4
The numeric keypad clear key\&.
.RE
.PP
\fBKeypad Enter\fR
.RS 4
The numeric keypad enter key\&.
.RE
.PP
\fBKeypad \-\fR
.RS 4
The numeric keypad subtract key\&.
.RE
.PP
\fBKeypad +\fR
.RS 4
The numeric keypad add key\&.
.RE
.PP
\fBLeft\fR
.RS 4
The left arrow key\&.
.RE
.PP
\fBLeftSquareBracket\fR
.RS 4
The [ key\&.
.RE
.PP
\fBMute\fR
.RS 4
The mute key\&.
.RE
.PP
\fBPageDown\fR
.RS 4
The page down key\&.
.RE
.PP
\fBPageUp\fR
.RS 4
The page down key\&.
.RE
.PP
\fBPause\fR
.RS 4
The pause key\&.
.RE
.PP
\fBReturn\fR
.RS 4
The return / enter key\&.
.RE
.PP
\fBRight\fR
.RS 4
The right arrow key\&.
.RE
.PP
\fBRightSquareBracket\fR
.RS 4
The ] key\&.
.RE
.PP
\fBSpace\fR
.RS 4
The space bar\&.
.RE
.PP
\fBUp\fR
.RS 4
The up arrow key\&.
.RE
.PP
\fBVolumeDown\fR
.RS 4
The volume down key\&.
.RE
.PP
\fBVolumeUp\fR
.RS 4
The volume up key\&.
.RE
.SH "SEE ALSO"
.sp
\fBimvr\fR(1)