[kdiff3] doc/en: add basic kdiff3 man page

Burkhard Lück null at kde.org
Thu May 24 04:52:18 UTC 2018


Git commit d88b7995c3443801cf6d5e522850227cd15d4fde by Burkhard Lück.
Committed on 24/05/2018 at 04:51.
Pushed by lueck into branch 'master'.

add basic kdiff3 man page

add man page written using kf5 man-docbook template and the output of kdiff3 -h in kf5

Differential Revision: https://phabricator.kde.org/D12995

M  +2    -1    doc/en/CMakeLists.txt
A  +203  -0    doc/en/man-kdiff3.1.docbook

https://commits.kde.org/kdiff3/d88b7995c3443801cf6d5e522850227cd15d4fde

diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
index 89b0c4d..79190b0 100644
--- a/doc/en/CMakeLists.txt
+++ b/doc/en/CMakeLists.txt
@@ -1 +1,2 @@
-kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kdiff3)
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kdiff3)
+kdoctools_create_manpage (man-kdiff3.1.docbook 1 INSTALL_DESTINATION ${KDE_INSTALL_MANDIR})
diff --git a/doc/en/man-kdiff3.1.docbook b/doc/en/man-kdiff3.1.docbook
new file mode 100644
index 0000000..f832741
--- /dev/null
+++ b/doc/en/man-kdiff3.1.docbook
@@ -0,0 +1,203 @@
+<?xml version="1.0" ?>
+<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+<!ENTITY % English "INCLUDE">
+]>
+
+<refentry lang="&language;">
+<refentryinfo>
+<title>KDiff3 User's Manual</title>
+<author>&Burkhard.Lueck; &Burkhard.Lueck.mail;</author>
+<date>2018-05-19</date>
+<releaseinfo>kdiff3 1.7.0</releaseinfo>
+</refentryinfo>
+
+<refmeta>
+<refentrytitle><command>kdiff3</command></refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+<refname><command>kdiff3</command></refname>
+<refpurpose>Tool for Comparison and Merge of Files and Directories</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>kdiff3</command>
+<arg choice="opt"><option>-u, --ignore</option></arg>
+<arg choice="opt"><option>--query</option></arg>
+<arg choice="opt"><option>--html</option></arg>
+<arg choice="opt"><option>--abort</option></arg>
+<arg choice="opt"><option>-m, --merge</option></arg>
+<arg choice="opt"><option>-b, --base</option> <replaceable>file</replaceable></arg>
+<arg choice="opt"><option>-o, --output</option> <replaceable>file</replaceable></arg>
+<arg choice="opt"><option>--out</option> <replaceable>file</replaceable></arg>
+<arg choice="opt"><option>--auto</option></arg>
+<arg choice="opt"><option>--qall</option></arg>
+<arg choice="opt"><option>-L1</option> <replaceable>alias1</replaceable></arg>
+<arg choice="opt"><option>-L2</option> <replaceable>alias2</replaceable></arg>
+<arg choice="opt"><option>-L3</option> <replaceable>alias3</replaceable></arg>
+<arg choice="opt"><option>-L, --fname</option> <replaceable>alias</replaceable></arg>
+<arg choice="opt"><option>--cs</option> <replaceable>string</replaceable></arg>
+<arg choice="opt"><option>--confighelp</option></arg>
+<arg choice="opt"><option>--config</option> <replaceable>file</replaceable></arg>
+<arg choice="opt"><option><replaceable>File1</replaceable></option></arg>
+<arg choice="opt"><option><replaceable>File2</replaceable></option></arg>
+<arg choice="opt"><option><replaceable>File3</replaceable></option></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+<title>Description</title>
+<para>Compares two or three input files or directories.</para> 
+
+</refsect1>
+
+<refsect1>
+<title>Options</title>
+<variablelist>
+<varlistentry>
+<term><option>-u, --ignore</option></term>
+<listitem><para>Ignored. (User defined.)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--query</option></term>
+<listitem><para>Ignored. (User defined.)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--html</option></term>
+<listitem><para>Ignored. (User defined.)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--abort</option></term>
+<listitem><para>Ignored. (User defined.)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-m, --merge</option></term>
+<listitem><para>Merge the input.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-b, --base</option> <replaceable>file</replaceable></term>
+<listitem><para>Explicit base file. For compatibility with certain tools.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-o, --output</option> <replaceable>file</replaceable></term>
+<listitem><para>Output file. Implies -m. ⪚: -o newfile.txt
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--out</option> <replaceable>file</replaceable></term>
+<listitem><para>Output file, again. (For compatibility with certain tools.)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--auto</option></term>
+<listitem><para>No GUI if all conflicts are auto-solvable.
+(Needs <option>-o</option> <replaceable>file</replaceable>)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--qall</option></term>
+<listitem><para>Don't solve conflicts automatically.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-L1</option> <replaceable>alias1</replaceable></term>
+<listitem><para>Visible name replacement for input file 1 (base).
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-L2</option> <replaceable>alias2</replaceable></term>
+<listitem><para>Visible name replacement for input file 2.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-L3</option> <replaceable>alias3</replaceable></term>
+<listitem><para>Visible name replacement for input file 3.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>-L, --fname</option> <replaceable>alias</replaceable></term>
+<listitem><para>Alternative visible name replacement. Supply this once for every input.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--cs</option> <replaceable>string</replaceable></term>
+<listitem><para>Override a config setting. Use once for every setting.
+⪚: <option>--cs</option> <replaceable>AutoAdvance=1</replaceable>.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--confighelp</option></term>
+<listitem><para>Show list of config settings and current values.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--config</option> <replaceable>file</replaceable></term>
+<listitem><para>Use a different config file.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option><replaceable>File1</replaceable></option></term>
+<listitem><para>file1 to open (base, if not specified via --<option>base</option>)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option><replaceable>File2</replaceable></option></term>
+<listitem><para>file2 to open
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option><replaceable>File3</replaceable></option></term>
+<listitem><para>file2 to open
+</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</refsect1>
+
+<refsect1>
+<title>See Also</title>
+<simplelist>
+<member>More detailed user documentation is available from <ulink
+url="help:/kdiff3">help:/kdiff3</ulink>
+(either enter this &URL; into &konqueror;, or run
+<userinput><command>khelpcenter</command>
+<parameter>help:/kdiff3</parameter></userinput>).</member>
+<member>kf5options(7)</member>
+<member>qt5options(7)</member>
+</simplelist>
+</refsect1>
+
+<refsect1>
+<title>Authors</title>
+<para>This manual page was written by &Burkhard.Lueck; &Burkhard.Lueck.mail;.</para>
+</refsect1>
+
+</refentry>


More information about the kde-doc-english mailing list