<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&okular;">
<!ENTITY latex "L<superscript>A</superscript>T<subscript>E</subscript>X">
<!ENTITY package "kdegraphics">
<!ENTITY kpdf "<application>KPDF</application>">
<!ENTITY PDF "<acronym>PDF</acronym>">
<!ENTITY % English "INCLUDE">
<!ENTITY % addindex "IGNORE">
]>
<!-- TODO
add chapter about navigation panel
Show/Hide Contens/Thumbnails/Reviews/Bookmarks bar to save screen space
Use Small Icons and deselct Show Text to minimize the navigation panel
Describe all actions only possible in the navigation bars:
Switching between documents using bookmarks
Context menu actions like Rename Bookmarks etc)
-->
<book id="okular" lang="&language;">
<bookinfo>
<title>The &okular; Handbook</title>
<authorgroup>
<author>
<firstname>Albert</firstname>
<surname>Astals Cid</surname>
<affiliation>
<address><email>aacid@kde.org</email></address>
</affiliation>
</author>
<author>
<firstname>Pino</firstname>
<surname>Toscano</surname>
<affiliation>
<address><email>pino@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<date>2012-09-09</date>
<releaseinfo>0.15.70 (&kde; 4.10)</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>&okular; is a &kde; universal document viewer based on &kpdf; code.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>okular</keyword>
<keyword>pdf</keyword>
<keyword>ps</keyword>
<keyword>postscript</keyword>
<keyword>tiff</keyword>
<keyword>djvu</keyword>
<keyword>dvi</keyword>
<keyword>chm</keyword>
<keyword>xps</keyword>
<keyword>comicbook</keyword>
<keyword>fictionbook</keyword>
<keyword>mobipocket</keyword>
<keyword>plucker</keyword>
<keyword>annotation</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&okular; is a &kde; universal document viewer based on the code of the &kpdf; application.
Although being based on &kpdf; code, &okular; has some unique features such as overview mode,
improved presentation support and annotation support.
</para>
<para>
&okular; supports a lot of different formats like PDF, Postscript, Tiff, CHM, DjVU, Images (png, jpg, &etc;)
XPS, Open Document (ODT), Fiction Books, Comic Book, Plucker, EPub and Fax.
For all supported formats and their features see <ulink url="http://okular.kde.org/formats.php">
&okular; Document Format Handlers</ulink>.
</para>
<screenshot>
<screeninfo>&okular;s Main Window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainwindow.png" format="PNG" />
</imageobject>
<textobject>
<phrase>&okular;s Main Window</phrase>
</textobject>
</mediaobject>
</screenshot>
<!--
<para>
The PDF format is widely used for publishing documents that are
mostly not meant to be edited again. &okular; is only a viewer
for these files and therefore it doesn't provide any functionality
to edit or create PDF documents.
</para>
-->
</chapter>
<chapter id="use">
<title>Basic Usage</title>
<sect1 id="opening">
<title>Opening Files</title>
<para>
To view any supported file in &okular;, select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem>
</menuchoice>, choose a supported file in the dialog and click <guibutton>Open</guibutton>.
Your file should now be displayed in the main window.
</para>
<para>
If you have already opened files in &okular; before, you can quickly access them by selecting them in
the <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent</guisubmenu></menuchoice> menu.
</para>
<para>&okular; is the default &kde; application for PDF and Postscript files, launched when you click with the
&LMB; on such a file type in the filemanager. If you want to open any file whose format is supported by &okular;
use <menuchoice><guimenu>Open with...</guimenu><guimenuitem>&okular;</guimenuitem> </menuchoice> from context
menu in the filemanager.
</para>
<para>
After having a file opened you probably want to read it and therefore navigate through it. Go to the
<link linkend="navigating">next section</link> to learn more about this.
</para>
</sect1>
<sect1 id="navigating">
<title>Navigating</title>
<para>This section describes how you can navigate through a document in &okular;.</para>
<!--
Presentation mode: add Up (previous page) and Down (next page) keys
Add a 'Find Previous' entry
-->
<para>
There are multiple ways of scrolling the viewing area. One is to use the
<keycap>Up Arrow</keycap> and <keycap>Down Arrow</keycap> keys. You may also use
the scrollbar, your mousewheel or the <keycap>Page Up</keycap> and <keycap>Page Down</keycap>
keys.
</para>
<para>
Another way is to hold the &LMB; down at any place on the document while dragging the mouse in the
opposite direction of where you want to move. This procedure only works if the Browse Tool is
enabled, which you can select by choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Browse Tool
</guimenuitem></menuchoice>.
</para>
<para>If you want to read a document with several pages use the automatic scrolling feature of &okular;.
Start automatic scrolling with <keycombo action="simul">&Shift;<keysym>Down Arrow</keysym></keycombo> or
<keycombo action="simul">&Shift;<keysym>Up Arrow</keysym></keycombo>. Then use these keys to increase and
decrease the scrolling speed. You can start or stop automatic scrolling temporarily by pressing the &Shift; key;
pressing any other key deactivates this feature.
</para>
<para>Another way to navigate through a document with several pages is to use the mouse pointer. Drag the page up or down, continue to drag even while reaching the bottom or top of the screen and behold.
Once you cross the border of a page, the mouse cursor appears on top or bottom of the screen again and you can just continue to drag.
</para>
<para>
The navigation panel on the left side of the screen enables two more ways of navigating
through a document:
</para>
<itemizedlist>
<listitem>
<para>
If you click on a page thumbnail the viewing area will be brought to
that page.
</para>
</listitem>
<listitem>
<para>
If the document has a table of contents, clicking on a table
of contents item will bring the document to the page linked to that
item.
</para>
</listitem>
<listitem>
<para>
If the document has bookmarks, enable the <guilabel>Bookmarks</guilabel> view
and click them to go to the associated page.
If bookmarks are not only shown for the current document, you can quickly
switch to bookmarks in all recently opened files.
</para>
</listitem>
<listitem>
<para>
If the document has annotations, enable the <guilabel>Reviews</guilabel> view
and click the annotations or select them with the <keycap>Up Arrow</keycap> and <keycap>Down Arrow</keycap> keys and press <keycap>Return</keycap> to go to the associated page.
</para>
</listitem>
</itemizedlist>
<para>
Some documents have links. In this case you can click on them and the view will
change to the page it links to. If the link is to a web page or some
other document the default &kde; handler for that format will be invoked.
For example, clicking on a link pointing to <quote>http://www.kde.org</quote>
will open the web page in the default &kde;'s web browser.
</para>
<para>
Additionally, you may use the following functionality to quickly move to specific places
in the document:
</para>
<itemizedlist>
<listitem>
<para>
You can go to the beginning of the document using
<keycombo action="simul">&Ctrl;<keycap>Home</keycap></keycombo> or
using
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Beginning of the document</guimenuitem>
</menuchoice>.
</para>
</listitem>
<listitem>
<para>
You can go to the end of the document using
<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo> or
using
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>End of the document</guimenuitem>
</menuchoice>.
</para>
</listitem>
<listitem>
<para>
You can go forward in the document using <keycap>Space</keycap> or <keycap>Page Down</keycap>.
To go to the next page of the document use the <guibutton>Next Page</guibutton> Toolbar
button or
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Next Page</guimenuitem>
</menuchoice> in the menubar.
</para>
</listitem>
<listitem>
<para>
You can go back in the document using &Backspace; or <keycap>Page Up</keycap>.
To go to the previous page of the document use <guibutton>Previous Page</guibutton> Toolbar
button or
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Previous Page</guimenuitem>
</menuchoice> in the menubar.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="presentationMode">
<title>Presentation Mode</title>
<para>
The Presentation mode represents another way to view documents in &okular;. It can be
enabled in
<menuchoice><guimenu>View</guimenu><guimenuitem>Presentation</guimenuitem></menuchoice>.
It shows the document on a page per page basis. The pages are shown with
zoom to page, that means all the page is visible.
</para>
<note>
<para>
&PDF; documents can even specify that they are always opened in presentation mode.
</para>
</note>
<para>
When in presentation mode, you have an helper bar located on the top of the screen. Just move
the mouse cursor to the top of the screen to make it appear.
</para>
<screenshot>
<screeninfo>&okular; in Presentation Mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="presentation.png" format="PNG" />
</imageobject>
<textobject>
<phrase>&okular; in Presentation Mode</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
To navigate between
pages you may use the &LMB; (next page) and the &RMB; (previous page), the mouse
wheel, the arrow icons or the line edit in the top bar,
or the keys specified in the <link linkend="navigating">Navigating</link>
section.
</para>
<para>
You can exit presentation mode at any time by pressing the &Esc; key or clicking
the <guiicon>Quit</guiicon> icon in the top bar.
</para>
<para>
You can also draw on the current page with a pencil. Click on the
<guilabel>Toggle Drawing Mode</guilabel> icon in the top bar to enable or disable the possibility
to draw in the presentation mode. The drawings are cleared automatically when leaving the presentation
mode. You can also click on the <guilabel>Erase Drawings</guilabel> icon to remove the
drawings in the current page.
</para>
<para>
The presentation mode has support for more than one screen in a multi-monitor configuration.
With more than one screen a new button will appear in the top bar, with the icon of a screen:
this is a drop down box that allows you to move the presentation to any of the other available screens.
</para>
<para>
Presentation mode has some configuration options, you can find their
description in the chapter <link linkend="configpresentation">Configuring &okular;</link>.
</para>
</sect1>
<sect1 id="inverse_search">
<title>Inverse Search between &latex; Editors and &okular;</title>
<para>Inverse search is a very useful feature when you are writing a &latex; document yourself. If everything is set up properly, you can
click into &okular;'s window with the <mousebutton>left</mousebutton> mouse button while pressing &Shift;. After that editor loads the &latex; source file and jumps to
the proper paragraph.</para>
<para>Inverse search cannot work unless:</para>
<itemizedlist>
<listitem><para>The source file has been compiled successfully.</para></listitem>
<listitem><para>&okular; knows which editor you would like to use.</para></listitem>
<listitem><para>The Browse Tool has to be enabled, which you can select by choosing
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Browse Tool
</guimenuitem></menuchoice>.</para></listitem>
</itemizedlist>
<para>With this feature of &okular;, a left mouse click while pressing &Shift; in the &DVI; or &PDF; document will
result in editor opening the corresponding &latex; document and attempt to go to the
corresponding line. Remember to tell &okular; to use proper editor, in &okular;'s
menu item <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Okular...</guimenuitem></menuchoice>
(on the page <guimenuitem>Editor</guimenuitem>).</para>
<para>For more details on editor configuration please refer to the <link linkend="configeditor">corresponding section of this manual</link>.</para>
<screenshot>
<screeninfo>Configuring &okular;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="configure-editor.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Configuring editor in &okular;</phrase>
</textobject>
<caption><para>Configuring editor in &okular;</para></caption>
</mediaobject>
</screenshot>
</sect1>
</chapter>
<chapter id="advanced">
<title>&okular; Advanced Features</title>
<sect1 id="embedded-files">
<title>Embedded Files</title>
<para>
If the current document has some files embedded in it, when you open it a yellow bar
will appear above the page view to notify you about the embedded files.
</para>
<screenshot>
<screeninfo>The embedded files bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="embedded-files-bar.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The embedded files bar</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
In this case, you can either click on the link in the text of the bar or choose
<menuchoice><guimenu>File</guimenu><guimenuitem>Embedded Files</guimenuitem></menuchoice>
to open the embedded files dialog. The dialog allows you to view the embedded files and
to extract them.
</para>
</sect1>
<sect1 id="forms">
<title>Forms</title>
<para>
If the current document has forms, when you open it a bar
will appear above the page view where you can enable the forms.
</para>
<screenshot>
<screeninfo>The forms bar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="forms-bar.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The forms bar</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
In this case, you can either click on <guilabel>Show Forms</guilabel> in the bar or choose
<menuchoice><guimenu>View</guimenu><guimenuitem>Show Forms</guimenuitem></menuchoice>
to enter data into the form fields.
</para>
</sect1>
<sect1 id="annotations">
<title>Annotations</title>
<para>
&okular; allows you to review and annotate your documents.
Annotations created in &okular; are automatically saved in the internal local data folder
for each user.
&okular; does not implicitly change any document it opens.
</para>
<screenshot>
<screeninfo>&okular;'s Annotations</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="annotations.png" format="PNG" />
</imageobject>
<textobject>
<phrase>&okular;'s Annotations</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>&okular; has two different kind of annotations:</para>
<para>Text annotations like <guilabel>Yellow Highlighter</guilabel> and <guilabel>Black Underlining</guilabel>
for files with text like ⪚ PDF.</para>
<para>Graphic annotations like <guilabel>Note</guilabel>, <guilabel>Inline Note</guilabel>, <guilabel>Green Freehand Line</guilabel>, <guilabel>Straight Yellow Line</guilabel>, <guilabel>Blue Polygon</guilabel>, <guilabel>Stamp</guilabel> and <guilabel>Cyan Ellipse</guilabel> for all formats supported by &okular;.</para>
<para>Using the context menu either in the <guilabel>Reviews</guilabel> view of the navigation panel or in the main window you can open a <guilabel>Pop up Note</guilabel> for any kind of annotation and add or edit comments.</para>
<para>Annotations are not only limited to PDF files, they can be used for any format &okular; supports.</para>
<para>
Since &kde; 4.2, &okular; has the "document archiving" feature. This is an &okular;-specific format for carrying the document plus various metadata related to it (currently only annotations). You can save a "document archive" from the open document by choosing <menuchoice><guimenu>File</guimenu><guisubmenu>Export As</guisubmenu><guimenuitem>Document Archive</guimenuitem></menuchoice>. To open an &okular; document archive, just open it with &okular; as it would be ⪚ a &PDF; document.
</para>
<para>
Since &okular; 0.15 you can <emphasis>also</emphasis> save annotations directly into PDF files. This feature is only available if &okular; has been built with version 0.20 or later of <ulink url="http://poppler.freedesktop.org/">Poppler rendering library</ulink>. You can use <menuchoice><guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem></menuchoice> to save the copy of &PDF; file with annotations.
</para>
<note>
<para>
It is not possible to save annotations into &PDF; file if original file was encrypted and &okular; uses Poppler libraries of version which is lower than 0.22.
</para>
</note>
<note>
<para>
If you open a &PDF; with existing annotations, your annotation changes are not automatically saved in the internal local data folder, and you need to save the modified document (using <menuchoice><guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem></menuchoice>) before closing it. Should you forget to do this &okular; will show confirmation window that allows you to save the document.
</para>
</note>
<note>
<para>
Due to DRM limitations (typically with &PDF; documents), adding, editing some properties
or removing annotations could not be possible.
</para>
</note>
<sect2 id="annotations-add">
<title>Adding annotations</title>
<para>
To add some annotations to the document, you have to activate the annotating toolbar.
This is done by either selecting
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Review</guimenuitem></menuchoice> or
pressing <keycap>F6</keycap>. Once the annotating toolbar is shown, just press one of
its buttons to start constructing that annotation.</para>
<para>
With a single &LMB; click on an annotation tool button you can use a tool once.
If you ⪚ want to highlight all important parts of a text, activate that tool
permanently by double clicking on the tool button.
Press the <keycap>Esc</keycap> key or click the tool button again to leave the permanent mode.
</para>
<note>
<para>
The annotating toolbar can be docked in any side of the viewing area: just drag it to
move it to another place.
</para>
</note>
<note>
<para>
Activating the annotating toolbar will make you switch to the Browse Tool Mode.
</para>
</note>
<para>
You can stop the construction any time by pressing again on the button of the
annotation you are constructing, or by pressing the &Esc; key.
</para>
<para>
The newly constructed annotation will have as author the author you set in the
<guilabel>Identity</guilabel> page in &okular;s
<link linkend="configure">configuration</link> dialog.
</para>
<note>
<para>Using stamps a single click just places a square stamp (useful for icons).
To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point,
then drag to place the bottom-right one.</para>
</note>
</sect2>
<sect2 id="annotations-remove">
<title>Removing annotations</title>
<para>
To remove an annotation, just click on it with the &RMB;, and select
<guimenuitem>Delete</guimenuitem>.
</para>
<para>
When removing the annotation, its window will be closed if open.
</para>
<note>
<para>
This option could not be enabled because the document does not allow removing
annotations.
</para>
</note>
</sect2>
<sect2 id="annotations-edit">
<title>Editing annotations</title>
<para>
To edit an annotation, click on it with the &RMB; and select
<guimenuitem>Properties</guimenuitem>. A dialog will appear with the general
annotation settings (like color and opacity, author, &etc;) and the settings specific
to that annotation type.
</para>
<screenshot>
<screeninfo>Annotation Property Dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="annotation-properties.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Annotation Property Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
To move an annotation, hold down the &Ctrl; key, move the mouse pointer on it and
then start dragging with the &LMB;.
</para>
<note>
<para>
Depending on the document permissions (typically with &PDF; documents), some options
can be disabled.
</para>
</note>
</sect2>
</sect1>
<sect1 id="bookmark-management">
<title>Bookmark Management</title>
<para>
&okular; has a very flexible bookmark system. &okular; saves the position on the page in bookmark and allows you to define more than one bookmark per page.
</para>
<para>
To manage bookmarks in &okular; you can use <guilabel>Bookmarks</guilabel> view from <guilabel>Navigation Panel</guilabel>, <link linkend="menubookmarks">Bookmarks menu</link> or context menu of document view (click with &RMB; to open it).
</para>
<sect2 id="bookmarks-view">
<title>Bookmarks view</title>
<para>
To open <guilabel>Bookmarks</guilabel> view click on <guilabel>Bookmarks</guilabel> item on the <guilabel>Navigation Panel</guilabel>. If the <guilabel>Navigation Panel</guilabel> is not shown, use <menuchoice><shortcut><keycap>F7</keycap></shortcut> <guimenu>Settings</guimenu><guimenuitem>Show Navigation Panel</guimenuitem>
</menuchoice> main menu item to make it visible.
</para>
<screenshot>
<screeninfo>Bookmark view context menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="bookmark-management.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Bookmark view context menu</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The filter bar at the top of <guilabel>Bookmarks</guilabel> view can be used to filter the content of bookmark list pane according to the text in the box.
</para>
<para>
The list pane permits to view the bookmark list in a tree-like fashion: each document in the list can be <quote>expanded</quote> or <quote>collapsed</quote> by clicking on the <guiicon><</guiicon> or <guiicon>v</guiicon> icon next to it.
</para>
<para>
Click on <inlinemediaobject><imageobject><imagedata fileref="rating.png" format="PNG"/></imageobject></inlinemediaobject> icon below the list to show only the bookmarks from the current document.
</para>
<para>
Right-click menu of document item can be used to open document, rename its item or remove it from the list. Remember that the removal of a document item leads to the removal of all bookmarks in the corresponding document.
</para>
<para>
Right-click menus of individual bookmark items allow you to go to the bookmark, rename or remove it.
</para>
</sect2>
</sect1>
<!-- Please keep this section content in sync with man page (man-okular.1.docbook) -->
<sect1 id="command-line-options">
<title>Command Line Options</title>
<para>
Though &okular; may most often be started from the &kde; program menu, or a desktop icon, it can also be opened at the command line prompt of a terminal window. There are a few useful options that are available when doing this.
</para>
<sect2 id="specify-a-file">
<title>Specify a File</title>
<para>
By specifying the path and name of a particular file the user can have &okular; open that file immediately upon startup. This option might look something like the following:
</para>
<informalexample><screen><prompt>%</prompt> <userinput><command>okular</command> <option><replaceable>/home/myhome/docs/mydoc.pdf</replaceable></option> </userinput> </screen>
</informalexample>
<note>
<para>
For &PDF; documents, the name can be given as <replaceable>document_name</replaceable>#<replaceable>named_destination</replaceable> where <replaceable>named_destination</replaceable> is a particular named destination embedded in the document.
</para>
</note>
</sect2>
<sect2 id="other-command-line-options">
<title>Other Command Line Options</title>
<para>
The following command line help options are available
</para>
<variablelist>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help</option></userinput></term>
<listitem><para>This lists the most basic options available at the command line.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-qt</option></userinput></term>
<listitem><para>This lists the options available for changing the way &okular; interacts with &Qt;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-kde</option></userinput></term>
<listitem><para>This lists the options available for changing the way &okular; interacts with &kde;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--help-all</option></userinput></term>
<listitem><para>This lists all of the command line options.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--author</option></userinput></term>
<listitem><para>Lists &okular;'s authors in the terminal window</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>-v, --version</option></userinput></term>
<listitem><para>Lists version information for &Qt;, &kde;, and &okular;. Also available through <userinput><command>okular</command> <option>-v</option></userinput> </para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--license</option></userinput></term>
<listitem><para>Shows license information.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--page <replaceable>number</replaceable></option></userinput></term>
<listitem><para>Open a page with a given number in the document. Also available through <userinput><command>okular</command> <option>-p <replaceable>number</replaceable></option></userinput></para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--presentation</option></userinput></term>
<listitem><para>Start the document in presentation mode.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--unique</option></userinput></term>
<listitem><para>Unique instance control.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>okular</command>
<option>--</option></userinput></term>
<listitem><para>End of options.</para></listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
</chapter>
<chapter id="primary-menu-items">
<title>The Menubar</title>
<sect1 id="menufile">
<title>The File Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Open</action> a supported file or &okular; archive. If there is already an opened file it will be closed. For more information, see the section about <link linkend="opening">Opening Files</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
<action>Open</action> a file which was used previously from a
submenu. If a file is currently being displayed it
will be closed. For more information, see the section about
<link linkend="opening">Opening Files</link>.
</para>
</listitem>
</varlistentry>
<!--
<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>G</keycap></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Get Books From Internet...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>to be written</para>
</listitem>
</varlistentry>
<-->
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Import PostScript as &PDF;...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Open</action> a PostScript file and convert it to &PDF;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Save</action> the currently open file under a different name using the document backend. With the &PDF; backend (Poppler >= 0.8 required) it is possible to save the document with the changed values of the form fields.<!--Only useful for pdf? what happens with other formats/backends?--> It can be possible (provided that the data were not secured using DRM) to save annotations with &PDF; files (Poppler >= 0.22 required).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save Copy As...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Save</action> a copy of the currently open file under a different name
without using the current document backend.</para>
<!-- does not save the annotations, they are still coupled to the original file-->
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Reload</action> the currently open file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Print</action> the currently displayed document.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print Preview...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Show a preview</action> of how the currently displayed
document would be printed with the default options.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Properties</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Display some basic information</action> about the document, such as
title, author, creation date, and details about the fonts used. The available information
depends on the type of document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Embedded Files...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Show the files embedded</action> in the document, if the document has any.
For more information, see the section about the
<link linkend="embedded-files">Embedded Files</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Export As</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>This item contains the export formats the current document can be exported to.
The first entry for all kind of documents is always <guimenuitem>Plain Text...</guimenuitem></para>
<para>The second entry is <guimenuitem>Document Archive</guimenuitem>, which allows you to save the document with your annotations into an &okular;-specific archive format. Thus it is easily possible to share the original document and your annotations with other &okular; users or work with them collaboratively.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Close</action> &okular;.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="menuedit">
<title>The Edit Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Copy</action> the currently selected text in
<guibutton>Text Selection</guibutton> mode to the clipboard.</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Select All</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Selects</action> all the text (if the document provides it). This works only in
<guibutton>Text Selection</guibutton> mode.</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Find...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Show the find bar on the bottom of the viewing area that allows you to
<action>search for a string in the document</action>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>F3</keycap></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Find Next</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Try to <action>find the previous searched string again</action> in the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Find Previous</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Goes to the previous occurrence of the search string</action> in the document.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="menuview">
<title>The View Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Presentation</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Activates</action> the Presentation Mode. For more information, see the
section about <link linkend="presentationMode">Presentation Mode</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom In</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Increase the magnification</action> of the document view.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom Out</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Decrease the magnification</action> of the document view.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Fit Width</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Change the magnification</action> of the document
view to a value that makes the pages' width equal to the document
view's width.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Fit Page</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Change the magnification</action> of the document view
to a value that makes at least one whole page visible.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Continuous</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Enable the continuous page mode</action>. In continuous mode,
all pages of the document are shown, and you can scroll through
them without having to use the <menuchoice><guimenu>Go</guimenu>
<guimenuitem>Previous Page</guimenuitem></menuchoice> and
<menuchoice><guimenu>Go</guimenu><guimenuitem>Next Page</guimenuitem>
</menuchoice> options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guisubmenu>View Mode</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>This submenu makes you choose the view mode for the pages. The possible
options are: <guimenuitem>Single Page</guimenuitem> (only one page per row),
<guimenuitem>Facing Pages</guimenuitem> (two pages per row, in a book style),
<guimenuitem>Facing Pages (Center First Page)</guimenuitem> and
<guimenuitem>Overview</guimenuitem> (the number of columns is the one
specified in the <link linkend="configure">&okular; settings</link>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Orientation</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
This submenu allows you to <action>changes the orientation</action>
of the pages of the document.
</para>
<note>
<para>
The rotation is applied to the orientation of every page.
</para>
</note>
<para>
You can select <guimenuitem>Original Orientation</guimenuitem> to restore
the orientation of the document, discarding all the rotations applied
manually.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Page Size</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
<action>Changes the size of the pages</action> of the document.
</para>
<note>
<para>
This submenu is active only if the current type of document
supports different page sizes.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Trim Margins</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Remove the white border of pages when viewing pages.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show/Hide Forms</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Show or hides the display</action> of the form fields of the
document.
</para>
<note>
<para>
This menu item is active only if the current document has form
fields.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
<!-- Crtl + mouse wheel zoom in + out-->
</sect1>
<sect1 id="menugo">
<title>The Go Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Previous Page</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>View the previous page</action> of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Next Page</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>View the next page</action> of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Home</keycap></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Beginning of the document</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the beginning</action> of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>End of the document</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the end</action> of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Alt;&Shift;<keysym>Left</keysym></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Back</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go back to the previous view</action> of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Alt;&Shift;<keysym >Right</keysym></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Forward</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Move forward to the next view</action> of the document. This only works if you have already moved back before.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Go to Page...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Open a dialog which allows you to <action>go to any page</action> of the document.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="menubookmarks">
<title>The Bookmarks Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Add/Remove Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Add or remove a bookmark for the current position</action>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Rename Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Rename a bookmark for the current position</action>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Previous Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the previous bookmark</action>, or do nothing if there
are no bookmarks prior to the current one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Next Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the next bookmark</action>, or do nothing if there
are no bookmarks after the current one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>No Bookmarks</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>This is an always disabled action that appears in this menu only if the current document has
no bookmarks. Otherwise a list of all bookmarks is displayed here. Clicking on these bookmarks
allows you to go directly to the associated position.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="menutools">
<title>The Tools Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Browse Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The mouse will have its normal behavior, &LMB; for dragging the document and following links and &RMB; for adding bookmarks and fit to width.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Zoom Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The mouse will work as a zoom tool. Clicking &LMB; and dragging will zoom the view to the selected area, clicking &RMB; will bring the document back to the previous zoom.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>3</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Selection Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The mouse will work as a select tool. In that mode clicking &LMB; and dragging will give the option of copying the text/image of current selected area to the clipboard, speak a text or to save an image to a file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>4</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Text Selection Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The mouse will work as a text selection tool. In that mode clicking &LMB; and
dragging will give the option of selecting the text of the document. Then, just
click with the &RMB; to copy to the clipboard or speak the current selection.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>5</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Table Selection Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Draw a rectangle around the text for the table, then use the click with the &LMB;
to divide the text block into rows and columns. A &LMB; click on a existing line removes it and merges the adjacent rows or columns.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>F6</keycap></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Review</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open the review toolbar</action>. The review toolbar allows you to add
annotations on the document you are reading. For more information, please see the
section about <link linkend="annotations">Annotations</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Speak Whole Document</guimenuitem>
</menuchoice>
</term>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Speak Current Page</guimenuitem>
</menuchoice>
</term>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Stop Speaking</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>These items allow you to speak the whole document or just the current page and stop speaking using the &kde; Text-to-Speech system <application>Jovie</application>.</para>
<para>The <guilabel>Speak ...</guilabel> actions are enabled only if &jovie; is available in the system.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="settings-menu">
<title>The Settings Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Show Menubar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Toggle the Menubar display</action> on and off. Once
hidden it can be made visible using the shortcut
<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> again.
If the menubar is hidden, the context menu opened with a right mouse button
click anywhere in the view area has an extra entry <guimenuitem>Show Menubar</guimenuitem>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Toggle the Toolbar display</action> on and off.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>F7</keycap></shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Show Navigation Panel</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Toggle the navigation panel</action> on and off.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Page Bar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Toggle the page bar</action> at the bottom of document area on and off to save vertical place in &okular; window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Full Screen Mode</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Enables the full screen mode</action>. Note that
full screen mode is different from <link
linkend="presentationMode">presentation mode</link> insofar as the
only peculiarity of full screen mode is that it hides the window
decorations, the menubar and the toolbar.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens a window that lets you <action>configure the keyboard
shortcuts</action> for many menu commands.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens a window that lets you choose which icons are visible
in the toolbar.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Backends...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens the <link linkend="configure">Backend Configuration</link>
window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &okular;...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens the <link linkend="configure">Configure</link>
window.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="menuhelp">
<title>The Help Menu</title>
&help.menu.documentation;
</sect1>
</chapter>
<chapter id="configure">
<title>Configuring &okular;</title>
<sect1 id="configindex">
<title>General configuration</title>
<para>
You can configure &okular; by choosing <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &okular;...</guimenuitem></menuchoice>.
The configuration dialog is split into six sections. This chapter describes the available
options in detail.
</para>
<itemizedlist>
<listitem>
<para><link linkend="configgeneral">General</link></para>
</listitem>
<listitem>
<para><link linkend="configaccessibility">Accessibility</link></para>
</listitem>
<listitem>
<para><link linkend="configperformance">Performance</link></para>
</listitem>
<listitem>
<para><link linkend="configpresentation">Presentation</link></para>
</listitem>
<listitem>
<para><link linkend="configidentity">Identity</link></para>
</listitem>
<listitem>
<para><link linkend="configeditor">Editor</link></para>
</listitem>
</itemizedlist>
<screenshot>
<screeninfo>The configuration dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="configure.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The configuration dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
Depending on the currently installed backends, the <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Backends...</guimenuitem></menuchoice> menu item could be enabled.
This particular configuration dialog holds the configurations of the backends that can
actually be configured.
</para>
</sect1>
<sect1 id="configgeneral">
<title>General</title>
<variablelist>
<varlistentry>
<term><guilabel>Show scrollbars</guilabel></term>
<listitem>
<para>Whether to show scrollbars for the document view.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Link the thumbnails with the page</guilabel></term>
<listitem>
<para>Whether the thumbnails view should always display the current
page or not.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show hints and info messages</guilabel></term>
<listitem>
<para>Whether to show some informative messages on startup, file
load, &etc;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Display document title in title bar if available</guilabel></term>
<listitem>
<para>Whether to show the current document title in the title bar of &okular; window. If no metadata for title
found in the document or this item is unchecked &okular; shows filename of the document.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>When not displaying document title</guilabel></term>
<listitem>
<para>You can choose any of two options, <guilabel>Display file name only</guilabel> or <guilabel>Display full file path</guilabel>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Obey DRM limitations</guilabel></term>
<listitem>
<para>Whether &okular; should obey <firstterm>DRM</firstterm>
(Digital Rights Management) restrictions. DRM limitations are used
to make it impossible to perform certain actions with &PDF; documents,
such as copying content to the clipboard. Note that in some configurations
of &okular;, this option is not available.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Reload document on file change</guilabel></term>
<listitem>
<para>Whether opened files should be automatically checked for
changes and updated, if necessary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show backend selection dialog</guilabel></term>
<listitem>
<para>Whether &okular; should ask the user which backend to use in case of more
than one backend able to open the current file. If unchecked, &okular; will
use the backend with the highest priority.</para>
</listitem>
</varlistentry>
<!--varlistentry>
<term><guilabel>Center first page</guilabel></term>
<listitem>
<para>Whether the first page should be centered or aligned to the left when
displaying the pages in facing and overview mode.</para>
</listitem>
</varlistentry-->
<varlistentry>
<term><guilabel>Overview columns</guilabel></term>
<listitem>
<para>
This option represents the number of columns to use in the overview mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Page Up/Down overlap</guilabel></term>
<listitem>
<para>
Here you can define the percentage of the current viewing area that should be visible after pressing <keycap>Page Up</keycap>/<keycap>Page Down</keycap> keys.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Default Zoom</guilabel></term>
<listitem>
<para>
This options specifies the default zoom mode for file which were never
opened before. For those files which were opened before the previous zoom mode
is applied.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configaccessibility">
<title>Accessibility</title>
<variablelist>
<varlistentry>
<term><guilabel>Draw border around links</guilabel></term>
<listitem>
<para>Whether to draw a border around links.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Change colors</guilabel></term>
<listitem>
<para><action>Enables</action> the color changing options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Invert Colors</guilabel></term>
<listitem>
<para><action>Inverts</action> colors on the view, &ie; black objects will be shown white.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Change Paper Color</guilabel></term>
<listitem>
<para><action>Changes</action> the paper's color, &ie; the document's background.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Change Dark & Light Colors</guilabel></term>
<listitem>
<para><action>Changes</action> the dark and light color to your preference, that means
black will not be rendered as black but as the selected dark color and white
will not be rendered as white but as the selected light color.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Convert to Black & White</guilabel></term>
<listitem>
<para><action>Converts</action> the document to black and white. You can set the
threshold and the contrast. Setting the threshold to a higher value
by moving it to the right will result in lighter grays used.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configperformance">
<title>Performance</title>
<variablelist>
<varlistentry>
<term><guilabel>Enable transparency effects</guilabel></term>
<listitem>
<para>Draw selections and other special graphics using
transparency effects. Disable the option to draw them using
outline or opaque fill styles and increase speed on selections.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Memory Usage</guilabel></term>
<listitem>
<para>&okular; can achieve best performance by tuning the memory usage, based on your system and your tastes.
The more memory you let it to use, the faster the program will behave. The Default profile is good
for every system, but you can prevent &okular; from using more memory than necessary by selecting the Low
profile, or let it get the most out of your system using Aggressive. Use Greedy profile to preload all
pages without risk of system memory overfull (only 50% of total memory or free memory will be used).</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configpresentation">
<title>Presentation</title>
<variablelist>
<varlistentry>
<term><guilabel>Advance every</guilabel></term>
<listitem>
<para>Enables automatic advancing of pages given a time period.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Loop after last page</guilabel></term>
<listitem>
<para>When navigating on presentation mode and going past the last page the first page will appear.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Background color</guilabel></term>
<listitem>
<para>The color that will fill the part of the screen not covered by the page when on presentation mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Pencil color</guilabel></term>
<listitem>
<para>The color of the pencil used when drawing on the pages during the presentation mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Mouse cursor</guilabel></term>
<listitem>
<para>Whether the mouse should be always hidden, always shown or hidden after a small time of inactivity.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show progress indicator</guilabel></term>
<listitem>
<para>Whether to show a progress circle that shows the current page and the total number of pages on the upper
right corner of the presentation screen every time you change the page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show summary page</guilabel></term>
<listitem>
<para>Whether to show a summary page at the beginning of the presentation with the title, author and number of pages of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Enable transitions</guilabel></term>
<listitem>
<para>Use this checkbox to enable or disable transition effects between pages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Default transition</guilabel></term>
<listitem>
<para>The transition effect between page and page if the document does not specify one. Set this to <guilabel>Random
Transition</guilabel> to make &okular; randomly choose one of the available effects.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Placement</guilabel></term>
<listitem>
<para>In this section you can select the <guilabel>Screen</guilabel> used to display the presentation.</para>
<para><guilabel>Current Screen</guilabel> is same screen of the &okular; window that starts the presentation mode.</para>
<para><guilabel>Default Screen</guilabel> is the screen marked as default in the xinerama configuration.</para>
<para><guilabel>Screen 0</guilabel>, <guilabel>Screen 1</guilabel> &etc; are the available screens.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configidentity">
<title>Identity</title>
<variablelist>
<varlistentry>
<term><guilabel>Author</guilabel></term>
<listitem>
<para>The author of the contents added on a document.
Default is the name from the <guilabel>Password & User Account</guilabel> page of the &systemsettings; module <guilabel>Account Details</guilabel>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configeditor">
<title>Editor</title>
<variablelist>
<varlistentry>
<term><guilabel>Editor</guilabel></term>
<listitem>
<para>Choose the editor you want to launch when &okular; wants to open a source file.
This is the case when the document has references to the various points (usually row and column number) of sources it was generated from. The &DVI; format supports natively the addition of the information about the sources the LaTeX document was generated from. A similar system exists for &PDF; documents, called <acronym>pdfsync</acronym>, which stores these extra information in an external file named after the &PDF; file itself (for example <filename>mydocument.pdfsync</filename> for <filename>mydocument.pdf</filename>).
</para>
<para>
&okular; ships with preconfigured settings for the following editors: <ulink url="http://kate-editor.org/">&kate;</ulink>, <ulink url="http://kile.sourceforge.net/">Kile</ulink>, <ulink url="http://www.scintilla.org/SciTE.html">SciTE</ulink>, <ulink url="http://www.gnu.org/software/emacs/">Emacs client</ulink>, and <ulink url="http://www.lyx.org/">LyX client</ulink>.
</para>
<note>
<para>
To use inverse search in <application>Kile</application>, you have to compile your &latex; file with the <guilabel>Modern</guilabel> configuration.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Command</guilabel></term>
<listitem>
<para>This is the command and its parameters to invoke the selected editor with the source file of the actual document.</para>
<para>This field will be filled automatically if you use one of the preconfigured editors. Otherwise, please choose <guimenuitem>Custom Text Editor</guimenuitem> in <guilabel>Editor</guilabel> drop-down list and refer to the documentation on your favorite editor to find the proper command.
</para>
<para>You can use the following placeholders:</para>
<itemizedlist>
<listitem>
<para>%f - the file name</para>
</listitem>
<listitem>
<para>%l - the line of the file to be reached</para>
</listitem>
<listitem>
<para>%c - the column of the file to be reached</para>
</listitem>
</itemizedlist>
<para>If %f is not specified, then the document name is appended to the specified command.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<itemizedlist>
<title>Program Copyright:</title>
<listitem><para>Albert Astals Cid <email>aacid@kde.org</email> Current maintainer</para></listitem>
<listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem>
<listitem><para>Enrico Ros <email>eros.kde@email.it</email> &kpdf; developer</para></listitem>
</itemizedlist>
<itemizedlist>
<title>Documentation Copyright:</title>
<listitem><para>Albert Astals Cid <email>aacid@kde.org</email> Author</para></listitem>
<listitem><para>Titus Laska <email>titus.laska@gmx.de</email> Some updates and additions</para></listitem>
<listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem>
</itemizedlist>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &okular;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
<note>
<para>
If you are reading this help in the &khelpcenter;, &okular; has already been
installed on this system and you do not need install it anymore.
</para>
</note>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
// vim:ts=2:sw=2:tw=78:noet
-->
