vimiv-qt/misc/vimiv.1

181 lines
4.0 KiB
Groff

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "VIMIV" "1" "Jan 08, 2022" "" "vimiv"
.SH NAME
vimiv \- an image viewer with vim-like keybindings
.SH SYNOPSIS
.sp
\fBvimiv\fP [\fBPATH\fP] [\fB\-\-help\fP|\fB\-h\fP] [\fB\-\-fullscreen\fP|\fB\-f\fP] [\fB\-\-version\fP|\fB\-v\fP] [\fB\-\-geometry\fP \fIWIDTHxHEIGHT\fP|\fB\-g\fP \fIWIDTHxHEIGHT\fP] [\fB\-\-temp\-basedir\fP] [\fB\-\-config\fP \fIFILE\fP] [\fB\-\-keyfile\fP \fIFILE\fP] [\fB\-\-set\fP \fIOPTION\fP \fIVALUE\fP|\fB\-s\fP \fIOPTION\fP \fIVALUE\fP] [\fB\-\-log\-level\fP \fILEVEL\fP] [\fB\-\-command\fP \fICOMMAND\fP] [\fB\-\-basedir\fP \fIDIRECTORY\fP|\fB\-b\fP \fIDIRECTORY\fP] [\fB\-\-output\fP \fITEXT\fP|\fB\-o\fP \fITEXT\fP] [\fB\-\-input\fP|\fB\-i\fP] [\fB\-\-debug\fP \fIMODULE\fP] [\fB\-\-qt\-args\fP \fIARGS\fP]
.SH DESCRIPTION
.sp
Vimiv is an image viewer with vim\-like keybindings. It is written in python3
using the Qt5 toolkit and is free software, licensed under the GPL. Some of the
features are:
.INDENT 0.0
.IP \(bu 2
Simple library browser
.IP \(bu 2
Thumbnail mode
.IP \(bu 2
Basic image editing
.IP \(bu 2
Command line with tab completion
.IP \(bu 2
Complete customization with style sheets
.UNINDENT
.sp
A much more complete documentation can be found under
\fI\%https://karlch.github.io/vimiv\-qt/\fP\&.
.SH OPTIONS
.SS POSITIONAL ARGUMENTS
.sp
\fBPATH\fP
.INDENT 0.0
.INDENT 3.5
Paths to open
.UNINDENT
.UNINDENT
.SS OPTIONS
.sp
\fB\-\-help\fP, \fB\-h\fP
.INDENT 0.0
.INDENT 3.5
show this help message and exit
.UNINDENT
.UNINDENT
.sp
\fB\-\-fullscreen\fP, \fB\-f\fP
.INDENT 0.0
.INDENT 3.5
Start fullscreen
.UNINDENT
.UNINDENT
.sp
\fB\-\-version\fP, \fB\-v\fP
.INDENT 0.0
.INDENT 3.5
Print version information and exit
.UNINDENT
.UNINDENT
.sp
\fB\-\-geometry\fP \fIWIDTHxHEIGHT\fP, \fB\-g\fP \fIWIDTHxHEIGHT\fP
.INDENT 0.0
.INDENT 3.5
Set the starting geometry
.UNINDENT
.UNINDENT
.sp
\fB\-\-temp\-basedir\fP
.INDENT 0.0
.INDENT 3.5
Use a temporary basedir
.UNINDENT
.UNINDENT
.sp
\fB\-\-config\fP \fIFILE\fP
.INDENT 0.0
.INDENT 3.5
Use FILE as local configuration file
.UNINDENT
.UNINDENT
.sp
\fB\-\-keyfile\fP \fIFILE\fP
.INDENT 0.0
.INDENT 3.5
Use FILE as keybinding file
.UNINDENT
.UNINDENT
.sp
\fB\-\-set\fP \fIOPTION\fP \fIVALUE\fP, \fB\-s\fP \fIOPTION\fP \fIVALUE\fP
.INDENT 0.0
.INDENT 3.5
Set a temporary setting
.UNINDENT
.UNINDENT
.sp
\fB\-\-log\-level\fP \fILEVEL\fP
.INDENT 0.0
.INDENT 3.5
Set log level to LEVEL
.UNINDENT
.UNINDENT
.sp
\fB\-\-command\fP \fICOMMAND\fP
.INDENT 0.0
.INDENT 3.5
Run COMMAND on startup, usable multiple times
.UNINDENT
.UNINDENT
.sp
\fB\-\-basedir\fP \fIDIRECTORY\fP, \fB\-b\fP \fIDIRECTORY\fP
.INDENT 0.0
.INDENT 3.5
Directory to use for all storage
.UNINDENT
.UNINDENT
.sp
\fB\-\-output\fP \fITEXT\fP, \fB\-o\fP \fITEXT\fP
.INDENT 0.0
.INDENT 3.5
Wildcard expanded string to print to standard output upon quit
.UNINDENT
.UNINDENT
.sp
\fB\-\-input\fP, \fB\-i\fP
.INDENT 0.0
.INDENT 3.5
Read paths to open from standard input
.UNINDENT
.UNINDENT
.SS DEVELOPMENT ARGUMENTS
.sp
\fB\-\-debug\fP \fIMODULE\fP
.INDENT 0.0
.INDENT 3.5
Force showing debug log messages of MODULE
.UNINDENT
.UNINDENT
.sp
\fB\-\-qt\-args\fP \fIARGS\fP
.INDENT 0.0
.INDENT 3.5
Arguments to pass to qt directly, use quotes to pass multiple arguments
.UNINDENT
.UNINDENT
.SH WEBSITE
.sp
\fI\%https://karlch.github.io/vimiv\-qt/\fP
.SH AUTHOR
Christian Karl
.SH COPYRIGHT
2017-2022, Christian Karl
.\" Generated by docutils manpage writer.
.