kaffeine/doc/man-kaffeine.1.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>Kaffeine User's Manual</title>
0009 <author><personname>
0010 <firstname>Burkhard</firstname>
0011 <surname>Lück</surname>
0012 </personname>
0013 <email>lueck@hube-lueck.de</email></author>
0014
0015 <date>2018-05-01</date>
0016 <releaseinfo>Kaffeine 2.0.15</releaseinfo>
0017
0018 </refentryinfo>
0019
0020 <refmeta>
0021 <refentrytitle><command>Kaffeine</command></refentrytitle>
0022 <manvolnum>1</manvolnum>
0023 </refmeta>
0024
0025 <refnamediv>
0026 <refname><command>kaffeine</command></refname>
0027 <refpurpose>A media player by KDE with digital TV support</refpurpose>
0028 </refnamediv>
0029
0030 <refsynopsisdiv>
0031 <cmdsynopsis>
0032 <command>kaffeine</command>
0033 <arg choice="opt"><option>-d, --debug</option></arg>
0034 <arg choice="opt"><option>--tempfile</option></arg>
0035 <arg choice="opt"><option>-f, --fullscreen</option></arg>
0036 <arg choice="opt"><option>-m, --minimal</option></arg>
0037 <arg choice="opt"><option>-t, --alwaysontop</option></arg>
0038 <arg choice="opt"><option>--audiocd</option></arg>
0039 <arg choice="opt"><option>--videocd</option></arg>
0040 <arg choice="opt"><option>--aspectratio <replaceable>aspect_ratio</replaceable></option></arg>
0041 <arg choice="opt"><option>--dvd</option></arg>
0042 <arg choice="opt"><option>--dumpdvb</option></arg>
0043 <arg choice="opt"><option>--channel <replaceable>name</replaceable> / <replaceable>number</replaceable></option></arg>
0044 <arg choice="opt"><option>--tv <replaceable>channel</replaceable></option></arg>
0045 <arg choice="opt"><option>--lastchannel</option></arg>
0046 <arg choice="opt"><option><replaceable>files</replaceable></option></arg>
0047 </cmdsynopsis>
0048
0049 <para>Please notice that <option>--channel</option>, <option>--tv</option>,
0050 <option>--lastchannel</option>, <option>--audiocd</option>,
0051 <option>--videocd</option>, <option>--dvd</option> and
0052 <option><replaceable>files</replaceable></option> are mutually exclusive.</para>
0053 </refsynopsisdiv>
0054
0055
0056 <refsect1>
0057 <title>Description</title>
0058 <para>Kaffeine is a media player. What makes it different from the others is
0059 its excellent support of digital TV (DVB). Kaffeine has user-friendly interface,
0060 so that even first time users can start immediately playing their movies:
0061 from DVD (including DVD menus, titles, chapters, etc.), VCD, or a file.</para>
0062
0063 <para>Kaffeine uses libVLC as video/audio play backend.</para>
0064
0065 </refsect1>
0066
0067 <refsect1>
0068 <title>Options</title>
0069
0070 <variablelist>
0071
0072 <varlistentry>
0073 <term><option>-d</option> <option>--debug</option></term>
0074 <listitem><para>Enable all debug messages. Please notice that Kaffeine also
0075 allows fine-tuning debug messages, by enabling messages per category, by using the environment
0076 var:</para>
0077 <para><emphasis role="bold">
0078 QT_LOGGING_RULES=kaffeine.<emphasis>category</emphasis>.debug=true
0079 </emphasis></para>
0080 <para>where <emphasis>category</emphasis> can be:</para>
0081
0082 <variablelist>
0083 <varlistentry>
0084 <term><option>cam</option></term>
0085 <listitem><para>for dvb CAM logs</para></listitem>
0086 </varlistentry>
0087 <varlistentry>
0088 <term><option>dev</option></term>
0089 <listitem><para>for dvb device and libdvbv5 logs</para></listitem>
0090 </varlistentry>
0091 <varlistentry>
0092 <term><option>dvbsi</option></term>
0093 <listitem><para>for dvb MPEG-TS SI parsing logs</para></listitem>
0094 </varlistentry>
0095 <varlistentry>
0096 <term><option>epg</option></term>
0097 <listitem><para>for dvb EPG logs</para></listitem>
0098 </varlistentry>
0099 <varlistentry>
0100 <term><option>dvb</option></term>
0101 <listitem><para>for other dvb logs</para></listitem>
0102 </varlistentry>
0103 <varlistentry>
0104 <term><option>config</option></term>
0105 <listitem><para>for configuration logs</para></listitem>
0106 </varlistentry>
0107 <varlistentry>
0108 <term><option>mediawidget</option></term>
0109 <listitem><para>for media widget logs</para></listitem>
0110 </varlistentry>
0111 <varlistentry>
0112 <term><option>playlist</option></term>
0113 <listitem><para>for playlist logs</para></listitem>
0114 </varlistentry>
0115 <varlistentry>
0116 <term><option>sql</option></term>
0117 <listitem><para>for SQL lite logs</para></listitem>
0118 </varlistentry>
0119 <varlistentry>
0120 <term><option>vlc</option></term>
0121 <listitem><para>for libVlc logs</para></listitem>
0122 </varlistentry>
0123 </variablelist>
0124
0125 </listitem>
0126 </varlistentry>
0127
0128 <varlistentry>
0129 <term><option>--tempfile</option></term>
0130 <listitem><para>The files/URLs opened by the application will be deleted after use</para>
0131 </listitem>
0132 </varlistentry>
0133
0134 <varlistentry>
0135 <term><option>-f</option> <option>--fullscreen</option></term>
0136 <listitem><para>Start in full screen mode. When in full screen mode, all
0137 menus are hidden by default. In order to unhide the menus, move the mouse
0138 to the menu locations, e. g. to the top/bottom or left position of the
0139 screen.</para>
0140 </listitem>
0141 </varlistentry>
0142
0143 <varlistentry>
0144 <term><option>-m</option> <option>--minimal</option></term>
0145 <listitem><para>Start in minimal mode. In minimal mode, the window
0146 decoration with the title bar is shown. All other menus are hidden by default.
0147 In order to unhide the menus, move the mouse to the menu locations, e. g. to
0148 the top/bottom or left position of the &kaffeine; window.</para>
0149 <para>Starts in minimal mode</para>
0150 </listitem>
0151 </varlistentry>
0152
0153 <varlistentry>
0154 <term><option>-t</option> <option>--alwaysontop</option></term>
0155 <listitem><para>Tells the window manager to start &kaffeine; main window
0156 always on top of other windows. This option can be disabled later via
0157 the window manager, usually by clicking the title bar with the right
0158 mouse button and deselecting the always on top button box.</para>
0159 </listitem>
0160 </varlistentry>
0161
0162 <varlistentry>
0163 <term><option>--aspectratio</option> <replaceable>aspect_ratio</replaceable></term>
0164 <listitem><para>Forces &kaffeine; to start with an specific aspect
0165 ratio, disabling the automatic mode. This can be useful on wide
0166 and ultra-wide monitors, where the user always want to see video
0167 in full screen mode using the maximum possible resolution.
0168 Valid values are: 1:1, 4:3, 5:4, 16:9, 16:10, 2.21:1, 2.35:1
0169 and 2.39:1. If an invalid value is passed, or if this option is not
0170 used, it will default to automatic mode.</para>
0171 </listitem>
0172 </varlistentry>
0173
0174 <varlistentry>
0175 <term><option>--audiocd</option></term>
0176 <listitem><para>Play Audio CD</para>
0177 </listitem>
0178 </varlistentry>
0179
0180 <varlistentry>
0181 <term><option>--videocd</option></term>
0182 <listitem><para>Play Video CD</para>
0183 </listitem>
0184 </varlistentry>
0185
0186 <varlistentry>
0187 <term><option>--dvd</option></term>
0188 <listitem><para>Play DVD</para>
0189 </listitem>
0190 </varlistentry>
0191
0192 <varlistentry>
0193 <term><option>--dumpdvb</option></term>
0194 <listitem><para>Dump dvb data (debug option)</para>
0195 </listitem>
0196 </varlistentry>
0197
0198 <varlistentry>
0199 <term><option>--channel</option> <replaceable>name</replaceable> / <replaceable>number</replaceable></term>
0200 <listitem><para>Play TV channel</para>
0201 </listitem>
0202 </varlistentry>
0203
0204 <varlistentry>
0205 <term><option>--tv</option> <replaceable>channel</replaceable></term>
0206 <listitem><para>(deprecated option)</para>
0207 </listitem>
0208 </varlistentry>
0209
0210 <varlistentry>
0211 <term><option>--lastchannel</option> </term>
0212 <listitem><para>Play last tuned TV channel</para>
0213 </listitem>
0214 </varlistentry>
0215
0216 <varlistentry>
0217 <term><option><replaceable>files</replaceable></option></term>
0218 <listitem><para>Files or URLs to play</para>
0219 </listitem>
0220 </varlistentry>
0221
0222 </variablelist>
0223 </refsect1>
0224
0225 <refsect1>
0226 <title>Files</title>
0227 <para>
0228 Kaffeine uses the file <filename>scanfile.dvb</filename> with a list of known channels
0229 per locality and per Satellite (for DVB-S).</para>
0230 <para>
0231 When either new channels are added on some City, or when new Satellite beams are added,
0232 which are not available in Kaffeine, either use dvbv5-scan or w_scan to generate a new file
0233 (in the latter case, converted to the proper format using dvb-format-convert),
0234 and submit it to <email>linux-media@vger.kernel.org</email>, with the subject
0235 <quote>[PATCH] dtv-scan-tables: <replaceable>some description</replaceable></quote>.
0236 The new patch will be added to <filename>scanfile.dvb</filename> and the updated
0237 file will be available to be updated from the Internet in the Kaffeine application.
0238 </para>
0239 </refsect1>
0240
0241 <refsect1>
0242 <title>See Also</title>
0243 <simplelist>
0244 <member>More detailed user documentation is available from <ulink
0245 url="help:/kaffeine ">help:/kaffeine</ulink>
0246 (either enter this &URL; into &konqueror;, or run
0247 <userinput><command>khelpcenter</command>
0248 <parameter>help:/kaffeine</parameter></userinput>).</member>
0249 <member>kf5options(7)</member>
0250 <member>qt5options(7)</member>
0251 <member>dvbv5-scan(1)</member>
0252 <member>w-scan(1)</member>
0253 <member>There is also further information available at the
0254 <ulink url="https://www.kde.org/applications/multimedia/kaffeine/">Kaffeine Page</ulink></member>
0255 </simplelist>
0256 </refsect1>
0257
0258 <refsect1>
0259 <title>Authors</title>
0260 <para>To list the authors of Kaffeine use <userinput><command>kaffeine</command> <option>--author</option></userinput> in a terminal.</para>
0261 </refsect1>
0262
0263 </refentry>