okular/doc/man-okular.1.docbook
2024-04-04 03:13:41 +02:00

144 lines
4.5 KiB
XML

<?xml version="1.0" ?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY % English "INCLUDE">
]>
<!-- Please keep this man page content in sync with Command Line Options sections of Okular handbook -->
<refentry lang="&language;">
<refentryinfo>
<title>Okular User's Manual</title>
<author><firstname>Yuri</firstname><surname>Chornoivan</surname>
<contrib>Okular man page.</contrib>
<email>yurchor@ukr.net</email></author>
<date>2022-02-19</date>
<releaseinfo>Okular 22.04</releaseinfo>
<productname>KDE Gear</productname>
</refentryinfo>
<refmeta>
<refentrytitle><command>okular</command></refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>okular</refname>
<refpurpose>a universal document viewer</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>okular</command>
<arg choice="opt"><replaceable>Okular options</replaceable></arg>
<arg choice="opt"><replaceable>URL</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description"><title>Description</title>
<para><command>okular</command>
is aimed to show documents in different formats.</para>
</refsect1>
<refsect1 id="options"><title>Okular options</title>
<variablelist>
<varlistentry>
<term><option>-p, --page <replaceable>number</replaceable></option></term>
<listitem>
<para>Open a page with a given number in the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--presentation</option></term>
<listitem>
<para>Start the document in presentation mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--print</option></term>
<listitem>
<para>Start with print dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--print-and-exit</option></term>
<listitem>
<para>Start with print dialog and exit after printing.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--unique</option></term>
<listitem>
<para>Unique instance control.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noraise</option></term>
<listitem>
<para>Allows to prevent Okular window raising after the start.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--find <replaceable>string</replaceable></option></term>
<listitem>
<para>Tries to find and highlight a given string in the document. Only works if just one document is given as an argument of the okular command.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--editor-cmd <replaceable>string</replaceable></option></term>
<listitem>
<para>Sets the external editor command. You cannot set the editor command in an already running Okular instance. Please note that <option>--unique</option> is not supported when setting the editor command at the commandline.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="arguments"><title>Arguments</title>
<variablelist>
<varlistentry>
<term><option>URL</option></term>
<listitem>
<para>An address of the document to be opened. For PDF, 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>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="feedback"><title>Feedback</title>
<para>On IRC, irc.libera.chat #okular or via email, okular-devel@kde.org or on the web, &lt;<ulink url="https://okular.kde.org/">https://okular.kde.org/</ulink>&gt;.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist>
<member>More detailed user documentation is available from <ulink
url="help:/okular">help:/okular</ulink>
(either enter this <acronym>URL</acronym> into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>help:/okular</parameter></userinput>).</member>
<member>kf6options(7)</member>
<member>qt6options(7)</member>
<member>There is also further information available at
<ulink url="https://okular.kde.org/">https://okular.kde.org/</ulink></member>
</simplelist>
</refsect1>
<refsect1 id="copyright"><title>Copyright</title>
<para>Copyright &copy; 2002 Wilco Greven, Christophe Devriese</para>
<para>Copyright &copy; 2004-2005 Enrico Ros</para>
<para>Copyright &copy; 2005 Piotr Szymanski</para>
<para>Copyright &copy; 2004-2012 Albert Astals Cid</para>
<para>Copyright &copy; 2006-2009 Pino Toscano</para>
<para>License: GNU General Public Version 2 &lt;<ulink url="https://www.gnu.org/licenses/gpl-2.0.html">https://www.gnu.org/licenses/gpl-2.0.html</ulink>&gt;</para>
</refsect1>
</refentry>