mirror of
https://invent.kde.org/graphics/okular
synced 2024-09-13 05:01:30 +00:00
REVIEW: 107411\n\nAdd description of command line options to Okular documentation, add man page.
This commit is contained in:
Yuri Chornoivan
parent
aeeb463235
commit
5bbc87788e
|
|
@ -2,3 +2,4 @@
|
|||
#
|
||||
#
|
||||
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR okular)
|
||||
kde4_create_manpage(man-okular.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
|
||||
|
|
@ -556,6 +556,89 @@ Add a 'Find Previous' entry
|
|||
</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">
|
||||
|
|
|
|||
152
doc/man-okular.1.docbook
Normal file
152
doc/man-okular.1.docbook
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<?xml version="1.0" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.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>KDE User's Manual</title>
|
||||
<author><firstname>Yuri</firstname><surname>Chornoivan</surname>
|
||||
<contrib>Okular man page.</contrib>
|
||||
<email>yurchor@ukr.net</email></author>
|
||||
<date>2012-11-20</date>
|
||||
<productname>K Desktop Environment</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>Qt-options</replaceable></arg>
|
||||
<arg choice="opt"><replaceable>KDE-options</replaceable></arg>
|
||||
<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="generic_options"><title>Generic Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>--help</option></term>
|
||||
<listitem>
|
||||
<para>Show help about options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--help-qt</option></term>
|
||||
<listitem>
|
||||
<para>Show Qt specific options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--help-kde</option></term>
|
||||
<listitem>
|
||||
<para>Show KDE specific options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--help-all</option></term>
|
||||
<listitem>
|
||||
<para>Show all options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--author</option></term>
|
||||
<listitem>
|
||||
<para>Show author information.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-v, --version</option></term>
|
||||
<listitem>
|
||||
<para>Show version information.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--license</option></term>
|
||||
<listitem>
|
||||
<para>Show license information.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--</option></term>
|
||||
<listitem>
|
||||
<para>End of options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id="options"><title>Okular options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-p, --page <replaceable>number</replaceable></option></term>
|
||||
<listitem>
|
||||
<para>Open a given page 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>--unique</option></term>
|
||||
<listitem>
|
||||
<para>Unique instance control.</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.freenode.net #okular or via email, kde-graphics-devel@kde.org or on the web, <<ulink url="http://okular.kde.org/">http://okular.kde.org/</ulink>></para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>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>).</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id="copyright"><title>Copyright</title>
|
||||
<para>Copyright © 2002 Wilco Greven, Christophe Devriese</para>
|
||||
<para>Copyright © 2004-2005 Enrico Ros</para>
|
||||
<para>Copyright © 2005 Piotr Szymanski</para>
|
||||
<para>Copyright © 2004-2012 Albert Astals Cid</para>
|
||||
<para>Copyright © 2006-2009 Pino Toscano</para>
|
||||
<para>License: GNU General Public Version 2 <<ulink url="http://www.gnu.org/licenses/gpl-2.0.html">http://www.gnu.org/licenses/gpl-2.0.html</ulink>></para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
Loading…
Reference in a new issue