docs: man: document configuration files in kmscon(1)
authorLars Kellogg-Stedman <lars@seas.harvard.edu>
Wed, 27 Feb 2013 18:04:16 +0000 (13:04 -0500)
committerDavid Herrmann <dh.herrmann@gmail.com>
Tue, 12 Mar 2013 16:53:22 +0000 (17:53 +0100)
This moves the description of kmscon.conf to a separate "Configuration"
section and adds some example kmscon.conf configuration lines.

This addresses #71 (at least, with this change in place I probably would
not have been momentarily confused by the exact syntax used in
kmsconf.conf).

(removed trailing whitespaces)
Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
docs/man/kmscon.xml

index 9fe0ba1..3d8a639 100644 (file)
 
     <para>When run in listener mode, kmscon watches the system for new seats and
           automatically provides a system console on it.</para>
-
-    <para>Default configuration directory is <filename>/etc/kmscon/</filename>
-          and the main configuration file is called
-          <filename>/etc/kmscon/kmscon.conf</filename>. You can provide an
-          additional configuration file for each seat via
-          <filename>/etc/kmscon/{seatname}.kmscon.conf</filename>.
-          Any command-line option that can be passed to kmscon can also be put
-          into those configuration files. Command-line options overwrite
-          configuration file options. And per-seat configuration files overwrite
-          the global configuration file.</para>
   </refsect1>
 
   <refsect1>
   </refsect1>
 
   <refsect1>
+    <title>Configuration</title>
+    <para>Default configuration directory is <filename>/etc/kmscon/</filename>
+          and the main configuration file is called
+          <filename>/etc/kmscon/kmscon.conf</filename>. You can provide an
+          additional configuration file for each seat via
+          <filename>/etc/kmscon/{seatname}.kmscon.conf</filename>.
+          Any command-line option that can be passed to kmscon can also be put
+          into those configuration files.  For example:</para>
+
+    <programlisting>
+      font-name=Meslo LG M
+      font-size=14
+      login=/bin/bash -i
+    </programlisting>
+
+    <para>Command-line options overwrite
+          configuration file options. And per-seat configuration files overwrite
+          the global configuration file.</para>
+  </refsect1>
+
+  <refsect1>
     <title>Default Mode</title>
     <para>In default mode, kmscon acts as a replacement for
           <citerefentry><refentrytitle>agetty</refentrytitle><manvolnum>1</manvolnum></citerefentry>.