+<?xml version="1.0" encoding="utf-8"?>
<refentry id='pam_snapper8'>
<refentryinfo>
<refentrytitle>pam_snapper</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='date'>2013-05-23</refmiscinfo>
- <refmiscinfo class='source'>@VERSION@</refmiscinfo>
+ <refmiscinfo class='version'>@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>
+ <refpurpose>PAM module which creates filesystem snapshots via "snapper"</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
starting point.</para>
<para>As many users do not logout for some time, it is a good idea, to
- enable Snapper's time based snapshots in addition.</para>
+ enable snapper's time based snapshots in addition.</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
- <variablelist remap='IP'>
+ <variablelist>
<varlistentry>
- <term>debug</term>
+ <term><option>debug</option></term>
<listitem>
<para>Switch on debugging in the module.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>homeprefix=<prefix></term>
+ <term><option>homeprefix=<replaceable>prefix</replaceable></option></term>
<listitem>
- <para>Prefix for the name of the snapper configuration. The username will be appended to this prefix.</para>
+ <para>Prefix for the name of the snapper configuration. The username
+ will be appended to this prefix.</para>
<para>Default: "home_"</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ignoreservices=<comma separated list of services></term>
+ <term><option>ignoreservices=<replaceable>comma separated list of services</replaceable></option></term>
<listitem>
<para>Default: "crond"</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ignoreusers=<comma separated list of users></term>
+ <term><option>ignoreusers=<replaceable>comma separated list of users</replaceable></option></term>
<listitem>
<para>Default: (none)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>rootasroot</term>
+ <term><option>rootasroot</option></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>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
+ accidentally wrong.</para>
<para>"rootasroot" and "ignoreroot" are mutual exclusive.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ignoreroot</term>
+ <term><option>ignoreroot</option></term>
<listitem>
- <para>No snapshot is taken, if the user "root" opens/closes a session.</para>
+ <para>No snapshot is taken, if the user "root" opens/closes a
+ session.</para>
<para>"rootasroot" and "ignoreroot" are mutual exclusive.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>openonly</term>
+ <term><option>openonly</option></term>
<listitem>
- <para>Only create a single snapshot when opening the PAM session.</para>
+ <para>Only create a single snapshot when opening the PAM
+ session.</para>
<para>Default: create pre- and post-snapshots</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>closeonly</term>
+ <term><option>closeonly</option></term>
<listitem>
- <para>Only create a single snapshot when closing the PAM session.</para>
+ <para>Only create a single snapshot when closing the PAM
+ session.</para>
<para>Default: create pre- and post-snapshots</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cleanup</term>
+ <term><option>cleanup=<replaceable>cleanup-algorithm</replaceable></option></term>
<listitem>
<para>Set snapper cleanup algorithm.</para>
<para>Default: (none)</para>
<refsect1 id='return_values'>
<title>RETURN VALUES</title>
- <variablelist remap='IP'>
+ <variablelist>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
- <para>pam_snapper will always return PAM_SUCCESS, to not prevent users from login, in case a
- snapshot fails. This may change in the future</para>
+ <para>pam_snapper will always return PAM_SUCCESS, to not prevent
+ users from login, in case a snapshot fails. This may change in the
+ future.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect1 id='examples'>
<title>EXAMPLES</title>
- <refsect2 id='basic_usage'><title>Basic usage</title>
- <para>1. Create a btrfs subvolume for the new user, and a snapper configuration, e.g. using the tool "/usr/lib/pam_snapper/pam_snapper_useradd.sh"</para>
+ <refsect2 id='basic_usage'>
+ <title>Basic usage</title>
- <para>2. Add the following line to /etc/pam.d/common-session:</para>
-
- <para>"session optional pam_snapper.so"</para>
+ <orderedlist>
+ <listitem>
+ <para>Create a btrfs subvolume for the new user, and a snapper
+ configuration, e.g. using the tool
+ <command>/usr/lib/pam_snapper/pam_snapper_useradd.sh</command>.</para>
+ </listitem>
+ <listitem>
+ <para>Add the following line to <filename>/etc/pam.d/common-session</filename>:</para>
+ <para>"session optional pam_snapper.so"</para>
+ </listitem>
+ </orderedlist>
</refsect2>
</refsect1>
</para>
</refsect1>
- <refsect1 id='authors_and_contributors'>
- <title>AUTHORS and CONTRIBUTORS</title>
+ <refsect1 id='authors'>
+ <title>AUTHORS</title>
<para>pam-snapper was written by Matthias G. Eckermann <email>mge@suse.com</email>
as part of SUSE Hackweek#9 in April 2013.</para>
+<?xml version="1.0" encoding="utf-8"?>
<refentry id='snapper8'>
<refentryinfo>
<refentrytitle>snapper</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='date'>2013-04-26</refmiscinfo>
- <refmiscinfo class='source'>@VERSION@</refmiscinfo>
+ <refmiscinfo class='version'>@VERSION@</refmiscinfo>
<refmiscinfo class='manual'>Filesystem Snapshot Management</refmiscinfo>
</refmeta>
<refsect2 id='snapshots'>
<title>Snapshots</title>
<para>Snapper distinguishes three types of snapshots.</para>
- <para><emphasis remap='B'>pre</emphasis> - Pre snapshots should always have a corresponding post
- snapshot. The intention of pre/post shotshot pairs is to snapshot the
- filesystem before and after a modification.</para>
-
- <para><emphasis remap='B'>post</emphasis> - See pre type.</para>
-
- <para><emphasis remap='B'>single</emphasis> - These snapshots have no special relationship to other
- snapshots.</para>
-
+ <glosslist>
+ <glossentry>
+ <glossterm>pre</glossterm>
+ <glossdef>
+ <para>Pre snapshots should always have a corresponding post
+ snapshot. The intention of pre/post snapshot pairs is to snapshot the
+ filesystem before and after a modification.</para>
+ </glossdef>
+ </glossentry>
+ <glossentry>
+ <glossterm>post</glossterm>
+ <glossdef>
+ <para>See pre type.</para>
+ </glossdef>
+ </glossentry>
+ <glossentry>
+ <glossterm>single</glossterm>
+ <glossdef>
+ <para>These snapshots have no special relationship to other snapshots.</para>
+ </glossdef>
+ </glossentry>
+ </glosslist>
<para>Note that filesystem-wise all three types are the same.</para>
</refsect2>
- <refsect2 id='snapshot_description_und_userdata'>
- <title>Snapshot Description und Userdata</title>
+ <refsect2 id='snapshot_description_and_userdata'>
+ <title>Snapshot Description and Userdata</title>
<para>With each snapshot a description and some userdata can be associated. The
description is a string. The userdata is a list of key-value pairs where the
<refsect2 id='automatic_snapshot_creation'>
<title>Automatic Snapshot Creation</title>
<para>Next to manual snapshot creation snapshots are also created automatically.</para>
-
- <para><emphasis remap='B'>cron-job</emphasis> - A cron-job creates hourly snapshots.</para>
-
- <para><emphasis remap='B'>certain programs</emphasis> - Certain programs like YaST and zypper create pre/post
- snapshot pairs when modifying the system.</para>
+ <itemizedlist>
+ <listitem>
+ <para>A cron-job creates hourly snapshots.</para>
+ </listitem>
+ <listitem>
+ <para>Certain programs like YaST and zypper create pre/post
+ snapshot pairs when modifying the system.</para>
+ </listitem>
+ </itemizedlist>
</refsect2>
<refsect2 id='cleanup_algorithms'>
corresponding configurations files along with parameters for every
algorithm.</para>
- <para><emphasis remap='B'>number</emphasis> - Deletes old snapshots when a
- certain number of snapshots is reached.</para>
-
- <para><emphasis remap='B'>timeline</emphasis> - Deletes old snapshots but
- keeps a number of hourly, daily, monthly and yearly snapshots.</para>
-
- <para><emphasis remap='B'>empty-pre-post</emphasis> - Deletes pre/post snapshot pairs with empty diffs.</para>
+ <glosslist>
+ <glossentry>
+ <glossterm>number</glossterm>
+ <glossdef>
+ <para>Deletes old snapshots when a certain number of snapshots is reached.</para>
+ </glossdef>
+ </glossentry>
+ <glossentry>
+ <glossterm>timeline</glossterm>
+ <glossdef>
+ <para>Deletes old snapshots but keeps a number of hourly, daily,
+ monthly and yearly snapshots.</para>
+ </glossdef>
+ </glossentry>
+ <glossentry>
+ <glossterm>empty-pre-post</glossterm>
+ <glossdef>
+ <para>Deletes pre/post snapshot pairs with empty diffs.</para>
+ </glossdef>
+ </glossentry>
+ </glosslist>
</refsect2>
</refsect1>
<refsect1 id='global_options'>
<title>GLOBAL OPTIONS</title>
- <variablelist remap='TP'>
+ <variablelist>
<varlistentry>
<term><option>-q, --quiet</option></term>
<listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-c, --config <name></option></term>
+ <term><option>-c, --config <replaceable>name</replaceable></option></term>
<listitem>
<para>Use specified configuration instead of the default configuration. The default
configuration is named "root".</para>
<refsect1 id='commands'>
<title>COMMANDS</title>
- <para>snapper provides a number of <emphasis remap='B'>commands</emphasis>. Each command accepts the options
- listed in the GLOBAL OPTIONS section. These options must be specified
- <emphasis remap='I'>before</emphasis> the command name. In addition, many commands have specific
- options, which are listed in this section. These command-specific options must
- be specified <emphasis remap='I'>after</emphasis> the name of the command and <emphasis remap='I'>before</emphasis> any of the
- command arguments.</para>
-
- <variablelist remap='TP'>
+
+ <para>snapper provides a number of <emphasis>commands</emphasis>. Each
+ command accepts the options listed in the <link
+ linkend='global_options'>GLOBAL OPTIONS</link> section. These options must
+ be specified <emphasis>before</emphasis> the command name. In addition,
+ many commands have specific options, which are listed in this
+ section. These command-specific options must be specified
+ <emphasis>after</emphasis> the name of the command and
+ <emphasis>before</emphasis> any of the command arguments.</para>
+
+ <variablelist>
+
<varlistentry>
- <term><emphasis remap='B'>help</emphasis></term>
+ <term><option>help</option></term>
<listitem>
<para>Show short help text.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>list-configs</emphasis></term>
+ <term><option>list-configs</option></term>
<listitem>
<para>List available configurations.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>create-config [options] <subvolume></emphasis></term>
+ <term><option>create-config [options] <replaceable>subvolume</replaceable></option></term>
<listitem>
<para>Create a new configuration for a filesystem or subvolume. For this command you
- will likely need the global option <option>--config</option>, see <emphasis remap='B'>GLOBAL OPTIONS</emphasis> and
+ will likely need the global option <option>--config</option>, see
+ <link linkend='global_options'>GLOBAL OPTIONS</link> and
<link linkend="concepts">CONCEPTS.</link></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --fstype</option> <fstype></term>
- <listitem>
- <para>Manually set filesystem type. Supported values are btrfs, ext4 and lvm. For
- lvm snapper uses LVM thin-provisioned snapshots. The filesystem type on top of
- LVM must be provided in parentheses, e.g. lvm(xfs).</para>
- <para>Without this option snapper tries to detect the filesystem.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --template</option> <name></term>
- <listitem>
- <para>Name of template for the new configuration file.</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-f, --fstype</option> <replaceable>fstype</replaceable></term>
+ <listitem>
+ <para>Manually set filesystem type. Supported values are btrfs, ext4 and lvm. For
+ lvm snapper uses LVM thin-provisioned snapshots. The filesystem type on top of
+ LVM must be provided in parentheses, e.g. lvm(xfs).</para>
+ <para>Without this option snapper tries to detect the filesystem.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-t, --template</option> <replaceable>name</replaceable></term>
+ <listitem>
+ <para>Name of template for the new configuration file.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>delete-config</emphasis></term>
+ <term><option>delete-config</option></term>
<listitem>
- <para>Delete a configuration for a filesystem or subvolume. For this command you
- will likely need to global option <option>--config</option>, see <emphasis remap='B'>GLOBAL OPTIONS</emphasis> and
- <link linkend="concepts">CONCEPTS.</link></para>
+ <para>Delete a configuration for a filesystem or subvolume. For this
+ command you will likely need to global option
+ <option>--config</option>, see <link linkend='global_options'>GLOBAL
+ OPTIONS</link> and <link linkend="concepts">CONCEPTS.</link></para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>list [options]</emphasis></term>
+ <term><option>list [options]</option></term>
<listitem>
<para>List snapshots.</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-t, --type</option> <replaceable>type</replaceable></term>
+ <listitem>
+ <para>Selects type of snapshots to list. Possible values are
+ all, single and pre-post.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><option>-t, --type</option> <type></term>
- <listitem>
- <para>Selects type of snapshots to list. Possible values are all, single and pre-post.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>create [options]</emphasis></term>
+ <term><option>create [options]</option></term>
<listitem>
<para>Create a new snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --type</option> <type></term>
- <listitem>
- <para>Specifies the type of the new snapshot. Possible values are single, pre and post.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--pre-number</option> <number></term>
- <listitem>
- <para>For post snapshots the number of the pre snapshot must be provided.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --print-number</option></term>
- <listitem>
- <para>Print number of the created snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d, --description</option> <description></term>
- <listitem>
- <para>Description for the snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --cleanup-algorithm</option> <cleanup-algorithm></term>
- <listitem>
- <para>Set the cleanup-algorithm for the snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --userdata</option> <userdata></term>
- <listitem>
- <para>Set userdata for the snapshot. The key-value pairs must be seperated by comma
- and the key and value must be seperated by an equal sign,
- e.g. requestid=42,user=arthur.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--command</option> <command></term>
- <listitem>
- <para>Create a pre and post snapshot and run command in between.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>modify [options] <number></emphasis></term>
+ <variablelist>
+ <varlistentry>
+ <term><option>-t, --type</option> <replaceable>type</replaceable></term>
+ <listitem>
+ <para>Specifies the type of the new snapshot. Possible values
+ are single, pre and post.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--pre-number</option> <replaceable>number</replaceable></term>
+ <listitem>
+ <para>For post snapshots the number of the pre snapshot must
+ be provided.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-p, --print-number</option></term>
+ <listitem>
+ <para>Print number of the created snapshot.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-d, --description</option> <replaceable>description</replaceable></term>
+ <listitem>
+ <para>Description for the snapshot.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-c, --cleanup-algorithm</option> <replaceable>cleanup-algorithm</replaceable></term>
+ <listitem>
+ <para>Set the cleanup-algorithm for the snapshot.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-u, --userdata</option> <replaceable>userdata</replaceable></term>
+ <listitem>
+ <para>Set userdata for the snapshot. The key-value pairs must
+ be separated by comma and the key and value must be separated
+ by an equal sign, e.g. requestid=42,user=arthur.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--command</option> <replaceable>command</replaceable></term>
+ <listitem>
+ <para>Create a pre and post snapshot and run command in between.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>modify [options] <replaceable>number</replaceable></option></term>
<listitem>
<para>Modify a snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d, --description</option> <description></term>
- <listitem>
- <para>New description for snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --cleanup-algorithm</option> <cleanup-algorithm></term>
- <listitem>
- <para>Set the cleanup-algorithm for the snapshot.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --userdata</option> <userdata></term>
- <listitem>
- <para>Set userdata for the snapshot. The key-value pairs must be seperated by comma
- and the key and value must be seperated by an equal sign,
- e.g. requestid=42,user=arthur.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>delete <number> | <number1>-<number2></emphasis></term>
+ <variablelist>
+ <varlistentry>
+ <term><option>-d, --description</option> <replaceable>description</replaceable></term>
+ <listitem>
+ <para>New description for snapshot.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-c, --cleanup-algorithm</option> <replaceable>cleanup-algorithm</replaceable></term>
+ <listitem>
+ <para>Set the cleanup-algorithm for the snapshot.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-u, --userdata</option> <replaceable>userdata</replaceable></term>
+ <listitem>
+ <para>Set userdata for the snapshot. The key-value pairs must
+ be separated by comma and the key and value must be separated
+ by an equal sign, e.g. requestid=42,user=arthur.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>delete <replaceable>number</replaceable> | <replaceable>number1-number2</replaceable></option></term>
<listitem>
<para>Delete a snapshot or a range of snapshots.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>mount <number></emphasis></term>
+ <term><option>mount <replaceable>number</replaceable></option></term>
<listitem>
<para>Mount a snapshot. Not required for all filesystem types.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>umount <number></emphasis></term>
+ <term><option>umount <replaceable>number</replaceable></option></term>
<listitem>
<para>Unmount a snapshot. Not required for all filesystem types.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>status [options] <number1>..<number2></emphasis></term>
- <listitem>
- <para>Compare the snapshots number1 and number2. This will show a list of files and
- directories that have been created, modified or deleted in the time between
- the two snapshots have been made.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --output</option> <file></term>
- <listitem>
- <para>Write output to file <file>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>diff [options] <number1>..<number2> [files]</emphasis></term>
+ <term><option>status [options] <replaceable>number1</replaceable>..<replaceable>number2</replaceable></option></term>
<listitem>
- <para>Compare the snapshots number1 and number2. This will show a diff of the
- content of files and directories that have been created, modified or deleted
- in the time between the two snapshots have been made.</para>
+ <para>Compare the snapshots <replaceable>number1</replaceable> and
+ <replaceable>number2</replaceable>. This will show a list of files
+ and directories that have been created, modified or deleted in the
+ time between the two snapshots have been made.</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-o, --output</option> <replaceable>file</replaceable></term>
+ <listitem>
+ <para>Write output to file <replaceable>file</replaceable>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>undochange [options] <number1>..<number2> [files]</emphasis></term>
+ <term><option>diff [options] <replaceable>number1</replaceable>..<replaceable>number2</replaceable> [files]</option></term>
<listitem>
- <para>Undo changes done between snapshot number1 and number2.</para>
+ <para>Compare the snapshots <replaceable>number1</replaceable> and
+ <replaceable>number2</replaceable>. This will show a diff of the
+ content of files and directories that have been created, modified or
+ deleted in the time between the two snapshots have been made.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><option>-i, --input</option> <file></term>
+ <term><option>undochange [options] <replaceable>number1</replaceable>..<replaceable>number2</replaceable> [files]</option></term>
<listitem>
- <para>Read files for which to undo changes from file <file>.</para>
+ <para>Undo changes done between snapshot <replaceable>number1</replaceable> and <replaceable>number2</replaceable>.</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-i, --input</option> <replaceable>file</replaceable></term>
+ <listitem>
+ <para>Read files for which to undo changes from file <replaceable>file</replaceable>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>cleanup <cleanup-algorithm></emphasis></term>
+ <term><option>cleanup <replaceable>cleanup-algorithm</replaceable></option></term>
<listitem>
- <para>Run the cleanup algorithm <cleanup-algorithm>. Currently implemented cleanup
- algorithms are number, timeline and empty-pre-post.</para>
+ <para>Run the cleanup algorithm
+ <replaceable>cleanup-algorithm</replaceable>. Currently implemented
+ cleanup algorithms are number, timeline and empty-pre-post.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>xadiff <number1>..<number2> [files]</emphasis></term>
+ <term><option>xadiff <replaceable>number1</replaceable>..<replaceable>number2</replaceable> [files]</option></term>
<listitem>
- <para>Compare the extended attributes. This command will genereate a report
- describing the modifications that have taken place in time between the
- snapshots number1 and number2 have been made. See example below:</para>
-
- <para><emphasis remap='B'> +:user.foo</emphasis>
- for created attributes</para>
- <para><emphasis remap='B'> -:user.bar</emphasis>
- for removed attributes</para>
+ <para>Compare the extended attributes between snapshot
+ <replaceable>number1</replaceable> and
+ <replaceable>number2</replaceable>. See examples below:</para>
- <para><option>-+:security.selinux</option>
- for modified attributes</para>
+ <itemizedlist>
+ <listitem>
+ <para><computeroutput> +:user.foo</computeroutput> for created attributes</para>
+ </listitem>
+ <listitem>
+ <para><computeroutput> -:user.bar</computeroutput> for removed attributes</para>
+ </listitem>
+ <listitem>
+ <para><computeroutput>-+:security.selinux</computeroutput> for modified attributes</para>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
</variablelist>
<refsect1 id='permissions'>
<title>PERMISSIONS</title>
- <para>Non-root users can be allowed to use a configuration by setting ALLOW_USERS or
- ALLOW_GROUPS in the config file. For all operations to work the user must also
- be able to read and access the .snapshots directory inside the
- subvolume. The .snapshots directory must be owned by root and must not be
- writable by anybody else.</para>
+ <para>Non-root users can be allowed to use a configuration by setting
+ ALLOW_USERS or ALLOW_GROUPS in the config file. For all operations to work the
+ user must also be able to read and access the <filename>.snapshots</filename>
+ directory inside the subvolume. The <filename>.snapshots</filename> directory
+ must be owned by root and must not be writable by anybody else.</para>
</refsect1>
<refsect1 id='files'>
<title>FILES</title>
- <variablelist remap='TP'>
+ <variablelist>
<varlistentry>
<term><filename>/etc/sysconfig/snapper</filename></term>
<listitem>
<refsect1 id='notes'>
<title>NOTES</title>
- <para>There is no mechanism to ensure consistency of the files while a snapshot it
- made. E.g. the files of a database can be inconsistence while the database is
- running.</para>
+ <para>There is no mechanism to ensure consistency of the files while a
+ snapshot it made. E.g. the files of a database can be inconsistence while
+ the database is running.</para>
- <para>Consistency after undochange is not guaranteed. E.g. when the creation of a
- user is undone there might still exist files from that user.</para>
+ <para>Consistency after undochange is not guaranteed. E.g. when the
+ creation of a user is undone there might still exist files from that
+ user.</para>
<para>Support for extended attributes is a compile-time option.</para>
</refsect1>
projects / thirdparty / snapper.git / commitdiff
