[kaffeine] doc: man page: document the arguments that are mutually exclusive

Mauro Carvalho Chehab null at kde.org
Tue May 8 15:00:50 UTC 2018


Git commit 47ec550150a7c34b865a6b6de1df954e27c5550b by Mauro Carvalho Chehab.
Committed on 08/05/2018 at 15:00.
Pushed by mauroc into branch 'master'.

man page: document the arguments that are mutually exclusive

As some args are mutually exclusive, document them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung at kernel.org>

M  +7    -2    doc/man-kaffeine.1.docbook

https://commits.kde.org/kaffeine/47ec550150a7c34b865a6b6de1df954e27c5550b

diff --git a/doc/man-kaffeine.1.docbook b/doc/man-kaffeine.1.docbook
index 477a66d..42a6df9 100644
--- a/doc/man-kaffeine.1.docbook
+++ b/doc/man-kaffeine.1.docbook
@@ -42,8 +42,13 @@
 <arg choice="opt"><option>--channel <replaceable>name</replaceable> / <replaceable>number</replaceable></option></arg>
 <arg choice="opt"><option>--tv <replaceable>channel</replaceable></option></arg>
 <arg choice="opt"><option>--lastchannel</option></arg>
-<arg choice="opt"><option><replaceable>file</replaceable></option></arg>
+<arg choice="opt"><option><replaceable>files</replaceable></option></arg>
 </cmdsynopsis>
+
+<para>Please notice that <option>--channel</option>, <option>--tv</option>,
+<option>--lastchannel</option>, <option>--audiocd</option>,
+<option>--videocd</option>, <option>--dvd</option> and
+<option><replaceable>files</replaceable></option> are mutually exclusive.</para>
 </refsynopsisdiv>
 
 
@@ -196,7 +201,7 @@ mouse button and deselecting the always on top button box.</para>
 </varlistentry>
 
 <varlistentry>
-<term><option><replaceable>file</replaceable></option></term>
+<term><option><replaceable>files</replaceable></option></term>
 <listitem><para>Files or URLs to play</para>
 </listitem>
 </varlistentry>


More information about the kde-doc-english mailing list