- better formatted synopsis

diff --git a/doc/pam_snapper.sgml.in b/doc/pam_snapper.sgml.in
index f096669264143cfb5a0589ad5e20ace69d1d7b32..55a91104f6875de4691c350587df13a68d7b16eb 100644 (file)
--- a/doc/pam_snapper.sgml.in
+++ b/doc/pam_snapper.sgml.in
@@ -2,7 +2,10 @@
 
 <refentry id='pam_snapper8'>
 
-  <refentryinfo><date>2013-05-23</date></refentryinfo>
+  <refentryinfo>
+    <date>2013-05-23</date>
+  </refentryinfo>
+
   <refmeta>
     <refentrytitle>pam_snapper</refentrytitle>
     <manvolnum>8</manvolnum>
@@ -10,6 +13,7 @@
     <refmiscinfo class='source'>@VERSION@</refmiscinfo>
     <refmiscinfo class='manual'>Filesystem Snapshot Management</refmiscinfo>
   </refmeta>
+
   <refnamediv>
     <refname>pam_snapper</refname>
     <refpurpose>PAM module which creates filesystem snapshots via "Snapper"</refpurpose>
@@ -17,15 +21,16 @@
 
   <refsynopsisdiv id='synopsis'>
     <cmdsynopsis>
-      <command>pam_snapper.so</command>    <arg choice='opt'><replaceable>debug</replaceable></arg>
-      <arg choice='opt'><replaceable>homeprefix=&lt;&gt;</replaceable></arg>
-      <arg choice='opt'><replaceable>ignoreservices=&lt;&gt;</replaceable></arg>
-      <arg choice='opt'><replaceable>ignoreusers=&lt;&gt;</replaceable></arg>
-      <arg choice='opt'><replaceable>rootasroot</replaceable></arg>
-      <arg choice='opt'><replaceable>ignoreroot</replaceable></arg>
-      <arg choice='opt'><replaceable>openonly</replaceable></arg>
-      <arg choice='opt'><replaceable>closeonly</replaceable></arg>
-      <arg choice='opt'><replaceable>cleanup=&lt;&gt;</replaceable></arg>
+      <command>pam_snapper.so</command>
+      <arg choice='opt'>debug</arg>
+      <arg choice='opt'>homeprefix=<replaceable>prefix</replaceable></arg>
+      <arg choice='opt'>ignoreservices=<replaceable>services</replaceable></arg>
+      <arg choice='opt'>ignoreusers=<replaceable>users</replaceable></arg>
+      <arg choice='opt'>rootasroot</arg>
+      <arg choice='opt'>ignoreroot</arg>
+      <arg choice='opt'>openonly</arg>
+      <arg choice='opt'>closeonly</arg>
+      <arg choice='opt'>cleanup=<replaceable>algorithm</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -52,7 +57,6 @@
        <term>homeprefix=&lt;prefix&gt;</term>
        <listitem>
          <para>Prefix for the name of the snapper configuration. The username will be appended to this prefix.</para>
-
          <para>Default: "home_"</para>
        </listitem>
       </varlistentry>
@@ -72,7 +76,6 @@
        <term>rootasroot</term>
        <listitem>
          <para>Perform a snapshot using the snapper configuration "root", if the user "root" logs in. In other words: the homeprefix is not used in this case. As the snapper configuration "root" is used for the system (the root filesystem), this means that with every login of the user "root" the complete "/" filesystem will be snapshotted. This can be useful to help administrators rolling back in case their activity / configuration changes have been accidentially wrong.</para>
-
          <para>"rootasroot" and "ignoreroot" are mutual exclusive.</para>
        </listitem>
       </varlistentry>
@@ -80,7 +83,6 @@
        <term>ignoreroot</term>
        <listitem>
          <para>No snapshot is taken, if the user "root" opens/closes a session.</para>
-
          <para>"rootasroot" and "ignoreroot" are mutual exclusive.</para>
        </listitem>
       </varlistentry>
@@ -88,7 +90,6 @@
        <term>openonly</term>
        <listitem>
          <para>Only create a single snapshot when opening the PAM session.</para>
-
          <para>Default: create pre- and post-snapshots</para>
        </listitem>
       </varlistentry>
@@ -96,7 +97,6 @@
        <term>closeonly</term>
        <listitem>
          <para>Only create a single snapshot when closing the PAM session.</para>
-
          <para>Default: create pre- and post-snapshots</para>
        </listitem>
       </varlistentry>
@@ -104,7 +104,6 @@
        <term>cleanup</term>
        <listitem>
          <para>Set snapper cleanup algorithm.</para>
-
          <para>Default: (none)</para>
        </listitem>
       </varlistentry>

diff --git a/doc/snapper.sgml.in b/doc/snapper.sgml.in
index 303561fa74075211252eb017663b54dcc9e6b892..de0090d4a02dc74002ebcfc956fc718aafdc52d8 100644 (file)
--- a/doc/snapper.sgml.in
+++ b/doc/snapper.sgml.in
@@ -2,7 +2,10 @@
 
 <refentry id='snapper8'>
 
-  <refentryinfo><date>2013-04-26</date></refentryinfo>
+  <refentryinfo>
+    <date>2013-04-26</date>
+  </refentryinfo>
+
   <refmeta>
     <refentrytitle>snapper</refentrytitle>
     <manvolnum>8</manvolnum>
@@ -10,16 +13,25 @@
     <refmiscinfo class='source'>@VERSION@</refmiscinfo>
     <refmiscinfo class='manual'>Filesystem Snapshot Management</refmiscinfo>
   </refmeta>
+
   <refnamediv>
     <refname>snapper</refname>
     <refpurpose>Command-line program for filesystem snapshot management</refpurpose>
   </refnamediv>
 
-  <refsect1 id='syntax'>
-    <title>SYNTAX</title>
-    <para>snapper [<option>--global-opts</option>] &lt;<emphasis remap='B'>command</emphasis>&gt; [<option>--command-opts</option>] [<emphasis remap='B'>command-arguments</emphasis>]</para>
-    <para>snapper --help</para>
-  </refsect1>
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>snapper</command>
+      <arg choice='opt'><replaceable>--global-opts</replaceable></arg>
+      <arg choice='plain'><replaceable>command</replaceable></arg>
+      <arg choice='opt'><replaceable>--command-opts</replaceable></arg>
+      <arg choice='opt'><replaceable>command-arguments</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>snapper</command>
+      <arg choice='req'>--help</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
 
   <refsect1 id='description'>
     <title>DESCRIPTION</title>
@@ -394,7 +406,6 @@
        <term><filename>/var/log/snapper.log</filename></term>
        <listitem>
          <para>Logfile. Please include this file in bug reports.</para>
-
        </listitem>
       </varlistentry>
     </variablelist>

diff --git a/doc/snapperd.sgml.in b/doc/snapperd.sgml.in
index 41812be146bd99cf3a76ce0baa4af4059122bd58..58a8fc5a6560fea99223ab6ad03e50f5b1193836 100644 (file)
--- a/doc/snapperd.sgml.in
+++ b/doc/snapperd.sgml.in
@@ -2,7 +2,10 @@
 
 <refentry id='snapperd8'>
 
-  <refentryinfo><date>2012-10-15</date></refentryinfo>
+  <refentryinfo>
+    <date>2012-10-15</date>
+  </refentryinfo>
+
   <refmeta>
     <refentrytitle>snapperd</refentrytitle>
     <manvolnum>8</manvolnum>
@@ -10,15 +13,17 @@
     <refmiscinfo class='source'>@VERSION@</refmiscinfo>
     <refmiscinfo class='manual'>Filesystem Snapshot Management</refmiscinfo>
   </refmeta>
+
   <refnamediv>
     <refname>snapperd</refname>
     <refpurpose>DBus daemon for snapper</refpurpose>
   </refnamediv>
 
-  <refsect1 id='syntax'>
-    <title>SYNTAX</title>
-    <para>snapperd</para>
-  </refsect1>
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>snapperd</command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
 
   <refsect1 id='description'>
     <title>DESCRIPTION</title>