'\" t
.\"     Title: katarakt
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 09/18/2014
.\"    Manual: Katarakt Manual
.\"    Source: Katarakt
.\"  Language: English
.\"
.TH "KATARAKT" "1" "09/18/2014" "Katarakt" "Katarakt Manual"
.\" -----------------------------------------------------------------
.\" * 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"
katarakt \- a simple PDF viewer with two layouts
.SH "SYNOPSIS"
.sp
\fBkatarakt\fR ([\fIOPTIONS\fR] \fIFILE\fR|\fIURL\fR)*
.SH "DESCRIPTION"
.sp
It\(cqs a PDF viewer\&. It views PDFs\&.
.sp
There are currently two layouts\&. The \fIpresentation layout\fR is very simple and only supports scrolling on a per page basis\&. As the name suggests the current page is displayed in the center and zoomed to fit the window\&. It is active by default\&.
.sp
The \fIgrid layout\fR is much more advanced and offers continuous (smooth, per pixel) scrolling, zooming and adjusting the column count\&. Pages keep their correct relative size and are shown in a grid\&.
.sp
For every file passed on the command line a process is spawned\&.
.SH "OPTIONS"
.PP
\fB\-p\fR, \fB\-\-page\fR \fINUM\fR
.RS 4
Start showing page
\fINUM\fR\&.
.RE
.PP
\fB\-f\fR, \fB\-\-fullscreen\fR
.RS 4
Start in fullscreen mode\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quit\fR
.RS 4
Quit on initialization failure\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print help and exit\&.
.RE
.SH "CONFIGURATION"
.sp
Variables and key bindings can be changed by modifying the katarakt\&.ini file\&. By default it is read from \fI$XDG_CONFIG_HOME\fR\&.
.SH "KEY BINDINGS"
.PP
\fBq\fR
.RS 4
Quit
\fBkatarakt\fR
.RE
.PP
\fB1\fR
.RS 4
Switch to
\fIpresentation layout\fR\&. Views a single page at a time, scaled to fit the screen
.RE
.PP
\fB2\fR
.RS 4
Switch to
\fIgrid layout\fR\&. Views pages in a continuous fashion, scaled to fit the width\&. Supports columns\&.
.RE
.PP
\fBUp\fR, \fBDown\fR, \fBLeft\fR, \fBRight\fR, \fBk\fR, \fBj\fR, \fBh\fR, \fBl\fR
.RS 4
Move around (up/down/left/right)
.RE
.PP
\fB^u\fR, \fB^d\fR
.RS 4
Scroll up/down half the screen
.RE
.PP
\fBBackSpace\fR, \fBSpace\fR, \fB^b\fR, \fB^f\fR
.RS 4
Scroll up/down the screen\&. By default scrolls 90% to create an overlapping region
.RE
.PP
\fBPgUp\fR, \fBPgDown\fR
.RS 4
Scroll up/down one page\&. Kind of swaps the pages in place
.RE
.PP
\fBHome\fR, \fBEnd\fR, \fBg\fR, \fBG\fR
.RS 4
Go to the first/last page
.RE
.PP
\fB^g\fR
.RS 4
Show
\fIgoto page\fR
bar
.RE
.PP
\fBf\fR
.RS 4
Toggle fullscreen
.RE
.PP
\fBt\fR
.RS 4
Toggle page number display
.RE
.PP
\fBr\fR
.RS 4
Reload document
.RE
.PP
\fBo\fR
.RS 4
Open a different document, shows a file dialog
.RE
.PP
\fB\-\fR, \fB+\fR, \fB=\fR
.RS 4
Adjust zoom level (\fIgrid layout\fR
only)
.RE
.PP
\fBz\fR
.RS 4
Reset zoom level to default, i\&.e\&. fit width (\fIgrid layout\fR
only)
.RE
.PP
\fB[\fR, \fB]\fR
.RS 4
Adjust column count (\fIgrid layout\fR
only)
.RE
.PP
\fB/\fR
.RS 4
Show search bar
.RE
.PP
\fBn\fR, \fBN\fR
.RS 4
Focus next/previous search hit
.RE
.PP
\fB^n\fR, \fB^N\fR
.RS 4
Focus next/previous search hit that is currently not visible
.RE
.PP
\fBu\fR, \fBi\fR
.RS 4
Rotate pages left/right
.RE
.PP
\fB^o\fR, \fB^i\fR, \fBAlt\-Left\fR, \fBAlt\-Right\fR
.RS 4
Move backward/forward through the jump list\&. Entries are added automatically when jumping
.RE
.SH "VARIABLES"
.PP
\fIint\fR \fBbackground_opacity\fR
.RS 4
223: opacity of the black background in range [0\&.\&.255]\&. Only works when using a compositor\&.
.RE
.PP
\fIstring\fR \fBdefault_layout\fR
.RS 4
presentation: the layout on startup\&. Possible values:
\fIpresentation\fR,
\fIgrid\fR
.RE
.PP
\fIint\fR \fBmouse_wheel_factor\fR
.RS 4
120: QT delta for turning the mouse wheel 1 click
.RE
.PP
\fIint\fR \fBsmooth_scroll_delta\fR
.RS 4
30: pixel offset when moving around
.RE
.PP
\fIfloat\fR \fBscreen_scroll_factor\fR
.RS 4
0\&.9: factor for scrolling the screen\&. Should be <= 1 to create an overlapping region
.RE
.PP
\fIint\fR \fBuseless_gap\fR
.RS 4
2: gap between two pages in pixels
.RE
.PP
\fIint\fR \fBmin_page_width\fR
.RS 4
150: pages can not be smaller than this
.RE
.PP
\fIint\fR \fBmin_zoom\fR
.RS 4
\-14: smallest zoom value
.RE
.PP
\fIint\fR \fBmax_zoom\fR
.RS 4
30: biggest zoom value
.RE
.PP
\fIfloat\fR \fBzoom_factor\fR
.RS 4
0\&.05: influences the number of steps between min and max
.RE
.PP
\fIint\fR \fBprefetch_count\fR
.RS 4
3: number of pages exceeding the currently visible ones to render, back\- and forwards respectively
.RE
.PP
\fIfloat\fR \fBsearch_padding\fR
.RS 4
0\&.2: factor of the area on the screen to display search hits in\&. Moves search hits towards the center
.RE
.PP
\fIbool\fR \fBsmooth_downscaling\fR
.RS 4
true: enables the higher quality downsampling filter
.RE
.PP
\fIint\fR \fBthumbnail_size\fR
.RS 4
32: one dimension of square thumbnails saved at run\-time for every page that was once rendered
.RE
.PP
\fIint\fR \fBrect_expansion\fR
.RS 4
2: number of pixels search rects are expanded by
.RE
.PP
\fIbool\fR \fBquit_on_init_fail\fR
.RS 4
false: Quit katarakt if the document fails to open
.RE
.PP
\fIstring\fR \fBicon_theme\fR
.RS 4
The name of your icon theme\&. Fill in if auto detection fails\&.
.RE
.SH "COMMUNITY"
.sp
Feel free to join the IRC channel \fI#katarakt\fR on freenode\&.
.SH "AUTHOR"
.sp
\fBkatarakt\fR is written by Philipp Erhardt\&.
.SH "RESOURCES"
.sp
Gitweb: http://git\&.cs\&.fau\&.de/?p=katarakt
.sp
Homepage: http://git\&.cs\&.fau\&.de/~go18gomu/katarakt/