[kde-doc-english] [konsole] doc/manual: improve + extend description of file format for tabs-from-file option

[Burkhard Lück]

Git commit 08ee99e35826bf781589142fe43e5c872b218074 by Burkhard Lück.
Committed on 03/08/2013 at 21:02.
Pushed by lueck into branch 'master'.

improve + extend description of file format for tabs-from-file option
REVIEW:111785

M  +17   -3    doc/manual/index.docbook

http://commits.kde.org/konsole/08ee99e35826bf781589142fe43e5c872b218074

diff --git a/doc/manual/index.docbook b/doc/manual/index.docbook
index de2f0da..a49da13 100644
--- a/doc/manual/index.docbook
+++ b/doc/manual/index.docbook
@@ -1021,9 +1021,23 @@ For more information, please visit
 <term><option>--tabs-from-file </option><parameter>file</parameter></term>
 <listitem><para><action>Create tabs</action> as specified in the given tabs configuration file.
 </para>
-<note><para>The file has one tab per line in the following format:</para><para>
-title: PUT A TITLE ;; command: PUT A COMMAND ;; workdir: PUT A DIRECTORY
-</para></note>
+<note><para>The file has one tab per line in the following format:</para>
+<para>Each line specifies a tab to open using up to 4 fields specifying how it is to open. 
+Fields are delimited with <userinput>;;</userinput> and a field name must have a <userinput>:</userinput> appended.
+Empty lines or lines with <userinput>#</userinput> at the beginning are ignored, so you can use line beginning with 
+<userinput>#</userinput> to add comments.
+</para>
+
+<simplelist>
+<member><userinput>title:</userinput> a name for this tab, tab default if blank or not specified</member>
+<member><userinput>workdir:</userinput> working directory, <filename class="directory"> ~</filename> if blank or not specified</member>
+<member><userinput>profile:</userinput> a &konsole; profile to use, the default if blank or not specified</member>
+<member><userinput>command:</userinput> a command to run</member>
+</simplelist>
+<para>Each line should contain at least one of <userinput>command</userinput> or <userinput>profile</userinput> field.
+</para>
+<para>Example: <userinput>title: %n;; command: /usr/bin/top ;; profile: Shell</userinput></para>
+</note>
 </listitem>
 </varlistentry>