docs/kf5options/man-kf5options.7.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <title>&frameworks; Command Line Documentation</title>
0009 <author>&Lauri.Watts; &Lauri.Watts.mail;</author>
0010 <date>2016-05-13</date>
0011 <releaseinfo>Frameworks 5.22</releaseinfo>
0012 <productname>KDE Frameworks</productname>
0013 </refentryinfo>
0014
0015 <refmeta>
0016 <refentrytitle>kf5options</refentrytitle>
0017 <manvolnum>7</manvolnum>
0018 </refmeta>
0019
0020 <refnamediv>
0021 <refname>kf5options</refname>
0022 <refpurpose>Common commandline options for all applications based on &kf5-full;</refpurpose>
0023 </refnamediv>
0024
0025 <refsynopsisdiv>
0026 <cmdsynopsis>
0027 <command><replaceable>KDE application</replaceable></command>
0028 <arg choice="opt"><option>-h, --help</option></arg>
0029 <arg choice="opt"><option>-v, --version</option></arg>
0030 <arg choice="opt"><option>--author</option></arg>
0031 <arg choice="opt"><option>--license</option></arg>
0032 <arg choice="opt"><option>--desktopfile</option> <replaceable>file name</replaceable></arg>
0033 </cmdsynopsis>
0034 </refsynopsisdiv>
0035
0036 <refsect1>
0037 <title>Options</title>
0038
0039 <para>The following options apply to all &kde; applications:</para>
0040
0041 <variablelist>
0042 <varlistentry>
0043 <term><option>-h</option> <option>--help</option></term>
0044 <listitem><para>This lists the options available at the command line.</para>
0045 </listitem>
0046 </varlistentry>
0047
0048 <varlistentry>
0049 <term><option>-v</option> <option>--version</option></term>
0050 <listitem>
0051 <para>Lists version information for <replaceable>KDE application</replaceable>.</para></listitem>
0052 </varlistentry>
0053
0054 <varlistentry>
0055 <term><option>--author</option></term>
0056 <listitem><para>Lists <replaceable>KDE application</replaceable> authors in the terminal window.</para></listitem>
0057 </varlistentry>
0058
0059 <varlistentry>
0060 <term><option>--license</option></term>
0061 <listitem><para>Shows license information.</para></listitem>
0062 </varlistentry>
0063
0064 <varlistentry>
0065 <term><option>--desktopfile</option> <replaceable>file name</replaceable></term>
0066 <listitem><para>The base file name of the desktop entry for this application.</para>
0067 <para>This is in particular useful for wrapper applications and
0068 applications having in general multiple desktop files. Thus each desktop
0069 file can put its own name into the exec command.
0070 </para></listitem>
0071 </varlistentry>
0072
0073 </variablelist>
0074
0075 </refsect1>
0076
0077 <refsect1>
0078 <title>See Also</title>
0079 <para>qt5options(7)</para>
0080
0081 </refsect1>
0082
0083 <refsect1>
0084 <title>Authors</title>
0085 <para>Man page originally written by &Lauri.Watts; &Lauri.Watts.mail; for kdelibs4</para>
0086 <para>Updated to &frameworks; 5 by &Burkhard.Lueck; &Burkhard.Lueck.mail;</para>
0087 </refsect1>
0088
0089 </refentry>