'\" t
.\"     Title: imv
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/10/2024
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "IMV" "5" "03/10/2024" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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
\fBinitial_pan\fR = <pan_factor_x> <pan_factor_y>
.RS 4
Initial pan/focus position factor of the opened images\&. A value of 50 represents the middle point of the image (50%)\&. Defaults to
\fI50 50\fR
.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 (for example,
\fI$(ls)\fR)\&. Environment variables can also be used, including the ones accessible to imv\(cqs
\fIexec\fR
command\&.
.RE
.PP
\fBoverlay_text_color\fR = <hex\-code>
.RS 4
Set the color for the text in the overlay\&. Is a 6\-digit hexadecimal color code\&. Defaults to
\fIffffff\fR\&.
.RE
.PP
\fBoverlay_text_alpha\fR = <hex\-code>
.RS 4
Set the alpha for the text in the overlay\&. Is a 2\-digit hexadecimal color code\&. Defaults to
\fIff\fR\&.
.RE
.PP
\fBoverlay_background_color\fR = <hex\-code>
.RS 4
Set the color for the background of the overlay\&. Is a 6\-digit hexadecimal color code\&. Defaults to
\fI000000\fR\&.
.RE
.PP
\fBoverlay_background_alpha\fR = <hex\-code>
.RS 4
Set the alpha for the background of the overlay\&. Is a 2\-digit hexadecimal color code\&. Defaults to
\fIc3\fR\&.
.RE
.PP
\fBoverlay_position_bottom\fR = <true|false>
.RS 4
Display the overlay at the bottom of the imv window, instead of the top\&.
.RE
.PP
\fBrecursively\fR = <true|false>
.RS 4
Load input paths recursively\&. Defaults to
\fIfalse\fR\&.
.RE
.PP
\fBscaling_mode\fR = <none|shrink|full|crop>
.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\&.
\fIcrop\fR
will scale and crop the image to fill 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
\fBsuppress_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 aliases to be added for imv\(cqs build in commands\&. For example, \fIx = close\fR would add a \fIx\fR command that simply executes the \fIclose\fR command\&. Any arguments provided to an alias are appended to the command configured by the alias\&.
.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\&. Multiple commands for a single key combination can be defined by separating each command with a \fI;\fR\&. Single and double quotes are honoured, as is escaping with a backslash, to allow the proper quoting of shell commands\&.
.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 = goto 1\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
Many keys, such as \fI<\fR, and \fI>\fR have special names\&. On X11, these can be easily found with the xev(1) command\&. For example, \fI!\fR is called \fIexclam\fR, \fI<\fR is called \fIless\fR, \fI>\fR is called \fIgreater\fR\&.
.sp
A complete list of keysyms can also be found on most systems with the \fIdumpkeys \-l\fR command\&.
.sp
\fBimv\fR(1)