pam/Makefile
data/Makefile
doc/Makefile
- doc/snapper.8:doc/snapper.8.in
- doc/snapperd.8:doc/snapperd.8.in
- doc/pam_snapper.8:doc/pam_snapper.8.in
+ doc/snapper.sgml:doc/snapper.sgml.in
+ doc/snapperd.sgml:doc/snapperd.sgml.in
+ doc/pam_snapper.sgml:doc/pam_snapper.sgml.in
po/Makefile
testsuite-real/Makefile
testsuite-cmp/Makefile
+snapper.sgml
+snapperd.sgml
+pam_snapper.sgml
snapper.8
snapperd.8
pam_snapper.8
+manpage.links
+manpage.refs
man_MANS += pam_snapper.8
endif
+.sgml.8: .sgml
+ docbook2man $<
+
TXTS = dbus-protocol.txt
-EXTRA_DIST = $(man_MANS) $(TXTS)
+EXTRA_DIST = $(TXTS)
+++ /dev/null
-.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
-. ds C` ""
-. ds C' ""
-'br\}
-.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
-'br\}
-.\"
-.\" Escape single quotes in literal strings from groff's Unicode transform.
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
-.\" entries marked with X<> in POD. Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.ie \nF \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
-..
-. nr % 0
-. rr F
-.\}
-.el \{\
-. de IX
-..
-.\}
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "PAM_SNAPPER 8"
-.TH "PAM_SNAPPER" "8" "2013-05-23" "@VERSION@" "Filesystem Snapshot Management"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.if n .ad l
-.nh
-.SH "NAME"
-pam_snapper \- PAM module which creates filesystem snapshots via "Snapper"
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-pam_snapper.so [debug] [homeprefix=<>] [ignoreservices=<>] [ignoreusers=<>] [rootasroot] [ignoreroot] [openonly] [closeonly] [cleanup=<>]
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-Create a snapshot at every login of a User, thus he or she always have a save starting point.
-.PP
-As many users do not logout for some time, it is a good idea, to enable Snapper's time based snapshots in addition.
-.SH "OPTIONS"
-.IX Header "OPTIONS"
-.IP "debug" 4
-.IX Item "debug"
-Switch on debugging in the module.
-.IP "homeprefix=<prefix>" 4
-.IX Item "homeprefix=<prefix>"
-Prefix for the name of the snapper configuration. The username will be appended to this prefix.
-.Sp
-Default: \*(L"home_\*(R"
-.IP "ignoreservices=<comma separated list of services>" 4
-.IX Item "ignoreservices=<comma separated list of services>"
-Default: \*(L"crond\*(R"
-.IP "ignoreusers=<comma separated list of users>" 4
-.IX Item "ignoreusers=<comma separated list of users>"
-Default: (none)
-.IP "rootasroot" 4
-.IX Item "rootasroot"
-Perform a snapshot using the snapper configuration \*(L"root\*(R", if the user \*(L"root\*(R" logs in. In other words: the homeprefix is not used in this case. As the snapper configuration \*(L"root\*(R" is used for the system (the root filesystem), this means that with every login of the user \*(L"root\*(R" the complete \*(L"/\*(R" filesystem will be snapshotted. This can be useful to help administrators rolling back in case their activity / configuration changes have been accidentially wrong.
-.Sp
-\&\*(L"rootasroot\*(R" and \*(L"ignoreroot\*(R" are mutual exclusive.
-.IP "ignoreroot" 4
-.IX Item "ignoreroot"
-No snapshot is taken, if the user \*(L"root\*(R" opens/closes a session.
-.Sp
-\&\*(L"rootasroot\*(R" and \*(L"ignoreroot\*(R" are mutual exclusive.
-.IP "openonly" 4
-.IX Item "openonly"
-Only create a single snapshot when opening the \s-1PAM\s0 session.
-.Sp
-Default: create pre\- and post-snapshots
-.IP "closeonly" 4
-.IX Item "closeonly"
-Only create a single snapshot when closing the \s-1PAM\s0 session.
-.Sp
-Default: create pre\- and post-snapshots
-.IP "cleanup" 4
-.IX Item "cleanup"
-Set snapper cleanup algorithm.
-.Sp
-Default: (none)
-.SH "MODULE TYPES PROVIDED"
-.IX Header "MODULE TYPES PROVIDED"
-Only the module type \*(L"session\*(R" is provided.
-.SH "RETURN VALUES"
-.IX Header "RETURN VALUES"
-.IP "\s-1PAM_SUCCESS\s0" 4
-.IX Item "PAM_SUCCESS"
-pam_snapper will always return \s-1PAM_SUCCESS\s0, to not prevent users from login, in case a snapshot fails. This may change in the future
-.SH "EXAMPLES"
-.IX Header "EXAMPLES"
-.SS "Basic usage"
-.IX Subsection "Basic usage"
-1. Create a btrfs subvolume for the new user, and a snapper configuration, e.g. using the tool \*(L"/usr/lib/pam_snapper/pam_snapper_useradd.sh\*(R"
-.PP
-2. Add the following line to /etc/pam.d/common\-session:
-.PP
-\&\*(L"session optional pam_snapper.so\*(R"
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-snapper(8), pam.conf(5), pam(8), pam_snapper_homeconvert, pam_snapper_pamconfig, pam_snapper_useradd, pam_snapper_userdel
-.SH "AUTHORS and CONTRIBUTORS"
-.IX Header "AUTHORS and CONTRIBUTORS"
-pam-snapper was written by Matthias G. Eckermann <mge@suse.com>
-as part of \s-1SUSE\s0 Hackweek#9 in April 2013.
-.PP
-This module would not have been possible without the work of
-Arvin Schnell on the snapper project. pam-snapper inherits
-\&\s-1DBUS\s0 handling from \*(L"snapper_dbus_cli.c\*(R" by David Disseldorp.
-.PP
-The module builds on the Linux \s-1PAM\s0 stack and its
-documentation, written by Thorsten Kukuk.
-.SH "LICENSE"
-.IX Header "LICENSE"
-Copyright (c) 2013 \s-1SUSE\s0
-.PP
-All Rights Reserved.
-.PP
-This program is free software; you can redistribute it and/or modify
-it under the terms of version 2 of the \s-1GNU\s0 General Public License as
-published by the Free Software Foundation.
-.PP
-This program is distributed in the hope that it will be useful, but
-\&\s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
-\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \s-1GNU\s0
-General Public License for more details.
-.PP
-You should have received a copy of the \s-1GNU\s0 General Public License
-along with this program; if not, contact \s-1SUSE\s0.
-.PP
-To contact \s-1SUSE\s0 about this file by physical or electronic mail, you
-may find current contact information at www.suse.com.
--- /dev/null
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+
+<refentry id='pam_snapper8'>
+
+ <refentryinfo><date>2013-05-23</date></refentryinfo>
+ <refmeta>
+ <refentrytitle>pam_snapper</refentrytitle>
+ <manvolnum>8</manvolnum>
+ <refmiscinfo class='date'>2013-05-23</refmiscinfo>
+ <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>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pam_snapper.so</command> <arg choice='opt'><replaceable>debug</replaceable></arg>
+ <arg choice='opt'><replaceable>homeprefix=<></replaceable></arg>
+ <arg choice='opt'><replaceable>ignoreservices=<></replaceable></arg>
+ <arg choice='opt'><replaceable>ignoreusers=<></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=<></replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+
+ <para>Create a snapshot at every login of a User, thus he or she always have a save
+ 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>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <variablelist remap='IP'>
+ <varlistentry>
+ <term>debug</term>
+ <listitem>
+ <para>Switch on debugging in the module.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>homeprefix=<prefix></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>
+ <varlistentry>
+ <term>ignoreservices=<comma separated list of services></term>
+ <listitem>
+ <para>Default: "crond"</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ignoreusers=<comma separated list of users></term>
+ <listitem>
+ <para>Default: (none)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <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>
+ <varlistentry>
+ <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>
+ <varlistentry>
+ <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>
+ <varlistentry>
+ <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>
+ <varlistentry>
+ <term>cleanup</term>
+ <listitem>
+ <para>Set snapper cleanup algorithm.</para>
+
+ <para>Default: (none)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 id='module_types_provided'>
+ <title>MODULE TYPES PROVIDED</title>
+ <para>Only the module type "session" is provided.</para>
+ </refsect1>
+
+ <refsect1 id='return_values'>
+ <title>RETURN VALUES</title>
+ <variablelist remap='IP'>
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <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>
+
+ <para>2. Add the following line to /etc/pam.d/common-session:</para>
+
+ <para>"session optional pam_snapper.so"</para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1 id='see_also'>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry><refentrytitle>snapper</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ pam_snapper_homeconvert,
+ pam_snapper_pamconfig,
+ pam_snapper_useradd,
+ pam_snapper_userdel
+ </para>
+ </refsect1>
+
+ <refsect1 id='authors_and_contributors'>
+ <title>AUTHORS and CONTRIBUTORS</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>
+
+ <para>This module would not have been possible without the work of Arvin
+ Schnell on the snapper project. pam-snapper inherits DBUS handling from
+ "snapper_dbus_cli.c" by David Disseldorp.</para>
+
+ <para>The module builds on the Linux PAM stack and its documentation,
+ written by Thorsten Kukuk.</para>
+ </refsect1>
+
+ <refsect1 id='license'>
+ <title>LICENSE</title>
+ <para>Copyright (c) 2013 SUSE</para>
+
+ <para>All Rights Reserved.</para>
+
+ <para>This program is free software; you can redistribute it and/or modify
+ it under the terms of version 2 of the GNU General Public License as published
+ by the Free Software Foundation.</para>
+
+ <para>This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ details.</para>
+
+ <para>You should have received a copy of the GNU General Public License
+ along with this program; if not, contact SUSE.</para>
+
+ <para>To contact SUSE about this file by physical or electronic mail, you
+ may find current contact information at www.suse.com.</para>
+ </refsect1>
+
+</refentry>
+++ /dev/null
-.TH "SNAPPER" "8" "2013-04-26" "@VERSION@" "Filesystem Snapshot Management"
-.SH "NAME"
-.LP
-snapper - Command\-line program for filesystem snapshot management
-
-.SH "SYNTAX"
-.LP
-snapper [\fI\-\-global\-opts\fR] <\fBcommand\fR> [\fI\-\-command\-opts\fR]
-[\fBcommand-arguments\fR]
-
-snapper --help
-
-.SH "DESCRIPTION"
-.LP
-Snapper is a command\-line program for filesystem snapshot management. It can
-create, delete and compare snapshots and undo changes done between snapshots.
-.LP
-Snapper never modifies the content of snapshots. Thus snapper creates
-read-only snapshots if supported by the kernel. Supported filesystems are
-btrfs and ext4 as well as snapshots of LVM logical volumes with
-thin-provisioning. Some filesystems might not be supported depending on your
-installation.
-
-.SH CONCEPTS
-
-.SS Configurations
-.LP
-For each filesystem or subvolume that should be snapshotted by snapper a
-configuration file is required. The complete setup can be done with the
-create-config command.
-
-.SS Snapshots
-.LP
-Snapper distinguishes three types of snapshots.
-.LP
-\fBpre\fR - 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.
-.LP
-\fBpost\fR - See pre type.
-.LP
-\fBsingle\fR - These snapshots have no special relationship to other
-snapshots.
-.LP
-Note that filesystem\-wise all three types are the same.
-
-.SS Snapshot Description und Userdata
-.LP
-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
-keys and values are strings.
-
-.SS Automatic Snapshot Creation
-Next to manual snapshot creation snapshots are also created automatically.
-.LP
-\fBcron\-job\fR - A cron\-job creates hourly snapshots.
-.LP
-\fBcertain programs\fR - Certain programs like YaST and zypper create pre/post
-snapshot pairs when modifying the system.
-
-.SS Cleanup Algorithms
-.LP
-Snapper provides several algorithms to cleanup old snapshots. The algorithms
-are executed in a daily cron\-job. This can be configured in the corresponding
-configurations files along with parameters for every algorithm.
-.LP
-\fBnumber\fR - Deletes old snapshots when a certain number of snapshots is
-reached.
-.LP
-\fBtimeline\fR - Deletes old snapshots but keeps a number of hourly, daily,
-monthly and yearly snapshots.
-.LP
-\fBempty\-pre\-post\fR - Deletes pre/post snapshot pairs with empty diffs.
-
-.SH "GLOBAL OPTIONS"
-
-.TP
-.I \-q, \-\-quiet
-Suppress normal output. Error messages will still be printed, though.
-.TP
-.I \-v, \-\-verbose
-Increase verbosity.
-.TP
-.I \-t, \-\-table\-style
-Specifies table style. Table style is identified by an integer number.
-.TP
-.I \-c, \-\-config <name>
-Use specified configuration instead of the default configuration. The default
-configuration is named "root".
-.TP
-.I \-\-version
-Print version and exit.
-
-.SH "COMMANDS"
-.LP
-snapper provides a number of \fBcommands\fR. Each command accepts the options
-listed in the GLOBAL OPTIONS section. These options must be specified
-\fIbefore\fR the command name. In addition, many commands have specific
-options, which are listed in this section. These command-specific options must
-be specified \fIafter\fR the name of the command and \fIbefore\fR any of the
-command arguments.
-
-.TP
-.B help
-Show short help text.
-
-.TP
-.B list-configs
-List available configurations.
-
-.TP
-.B create-config [options] <subvolume>
-Create a new configuration for a filesystem or subvolume. For this command you
-will likely need the global option \fI--config\fR, see \fBGLOBAL OPTIONS\fR and
-\fBCONCEPTS\fR.
-.TP
-\fI\-f, \-\-fstype\fR <fstype>
-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).
-
-Without this option snapper tries to detect the filesystem.
-
-.TP
-\fI\-t, \-\-template\fR <name>
-Name of template for the new configuration file.
-
-.TP
-.B delete-config
-Delete a configuration for a filesystem or subvolume. For this command you
-will likely need to global option \fI--config\fR, see \fBGLOBAL OPTIONS\fR and
-\fBCONCEPTS\fR.
-
-.TP
-.B list [options]
-List snapshots.
-.TP
-\fI\-t, \-\-type\fR <type>
-Selects type of snapshots to list. Possible values are all, single and pre-post.
-
-.TP
-.B create [options]
-Create a new snapshot.
-.TP
-\fI\-t, \-\-type\fR <type>
-Specifies the type of the new snapshot. Possible values are single, pre and post.
-.TP
-\fI\-\-pre\-number\fR <number>
-For post snapshots the number of the pre snapshot must be provided.
-.TP
-\fI\-p, \-\-print\-number\fR
-Print number of the created snapshot.
-.TP
-\fI\-d, \-\-description\fR <description>
-Description for the snapshot.
-.TP
-\fI\-c, \-\-cleanup\-algorithm\fR <cleanup-algorithm>
-Set the cleanup-algorithm for the snapshot.
-.TP
-\fI\-u, \-\-userdata\fR <userdata>
-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.
-.TP
-\fI\-\-command\fR <command>
-Create a pre and post snapshot and run command in between.
-
-.TP
-.B modify [options] <number>
-Modify a snapshot.
-.TP
-\fI\-d, \-\-description\fR <description>
-New description for snapshot.
-.TP
-\fI\-c, \-\-cleanup\-algorithm\fR <cleanup-algorithm>
-Set the cleanup-algorithm for the snapshot.
-.TP
-\fI\-u, \-\-userdata\fR <userdata>
-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.
-
-.TP
-.B delete <number> | <number1>-<number2>
-Delete a snapshot or a range of snapshots.
-
-.TP
-.B mount <number>
-Mount a snapshot. Not required for all filesystem types.
-
-.TP
-.B umount <number>
-Unmount a snapshot. Not required for all filesystem types.
-
-.TP
-.B status [options] <number1>..<number2>
-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.
-.TP
-\fI\-o, \-\-output\fR <file>
-Write output to file <file>.
-
-.TP
-.B diff [options] <number1>..<number2> [files]
-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.
-
-.TP
-.B undochange [options] <number1>..<number2> [files]
-Undo changes done between snapshot number1 and number2.
-.TP
-\fI\-i, \-\-input\fR <file>
-Read files for which to undo changes from file <file>.
-
-.TP
-.B cleanup <cleanup-algorithm>
-Run the cleanup algorithm <cleanup-algorithm>. Currently implemented cleanup
-algorithms are number, timeline and empty-pre-post.
-
-.TP
-.B xadiff <number1>..<number2> [files]
-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:
-.IP
-.B \ +:user.foo
-for created attributes
-.IP
-.B \ -:user.bar
-for removed attributes
-.IP
-.B -+:security.selinux
-for modified attributes
-
-.SH "PERMISSIONS"
-.LP
-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.
-
-.SH "FILES"
-.TP
-.B /etc/sysconfig/snapper
-Global configuration file.
-.TP
-.B /etc/snapper/configs
-Directory containing configuration files.
-.TP
-.B /etc/snapper/config-templates
-Directory containing configuration templates.
-.TP
-.B /etc/snapper/filters
-Directory containing filter files.
-.TP
-.B /var/log/snapper.log
-Logfile. Please include this file in bug reports.
-
-.SH "NOTES"
-.LP
-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.
-.LP
-Consistency after undochange is not guaranteed. E.g. when the creation of a
-user is undone there might still exist files from that user.
-.LP
-Support for extended attributes is a compile-time option.
-
-.SH "HOMEPAGE"
-.LP
-http://en.opensuse.org/Portal:Snapper
-
-.SH "AUTHORS"
-.LP
-Arvin Schnell <aschnell@suse.de>
-
-.SH "SEE ALSO"
-.LP
-btrfs(8), lvm(8), attr(5)
--- /dev/null
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+
+<refentry id='snapper8'>
+
+ <refentryinfo><date>2013-04-26</date></refentryinfo>
+ <refmeta>
+ <refentrytitle>snapper</refentrytitle>
+ <manvolnum>8</manvolnum>
+ <refmiscinfo class='date'>2013-04-26</refmiscinfo>
+ <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>] <<emphasis remap='B'>command</emphasis>> [<option>--command-opts</option>] [<emphasis remap='B'>command-arguments</emphasis>]</para>
+ <para>snapper --help</para>
+ </refsect1>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Snapper is a command-line program for filesystem snapshot management. It can
+ create, delete and compare snapshots and undo changes done between snapshots.</para>
+
+ <para>Snapper never modifies the content of snapshots. Thus snapper creates
+ read-only snapshots if supported by the kernel. Supported filesystems are
+ btrfs and ext4 as well as snapshots of LVM logical volumes with
+ thin-provisioning. Some filesystems might not be supported depending on your
+ installation.</para>
+ </refsect1>
+
+ <refsect1 id='concepts'>
+ <title>CONCEPTS</title>
+
+ <refsect2 id='configurations'>
+ <title>Configurations</title>
+ <para>For each filesystem or subvolume that should be snapshotted by snapper a
+ configuration file is required. The complete setup can be done with the
+ create-config command.</para>
+ </refsect2>
+
+ <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>
+
+ <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>
+
+ <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
+ keys and values are strings.</para>
+ </refsect2>
+
+ <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>
+ </refsect2>
+
+ <refsect2 id='cleanup_algorithms'>
+ <title>Cleanup Algorithms</title>
+
+ <para>Snapper provides several algorithms to cleanup old snapshots. The
+ algorithms are executed in a daily cron-job. This can be configured in the
+ 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>
+ </refsect2>
+
+ </refsect1>
+
+ <refsect1 id='global_options'>
+ <title>GLOBAL OPTIONS</title>
+ <variablelist remap='TP'>
+ <varlistentry>
+ <term><option>-q, --quiet</option></term>
+ <listitem>
+ <para>Suppress normal output. Error messages will still be printed, though.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-v, --verbose</option></term>
+ <listitem>
+ <para>Increase verbosity.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-t, --table-style</option></term>
+ <listitem>
+ <para>Specifies table style. Table style is identified by an integer number.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-c, --config <name></option></term>
+ <listitem>
+ <para>Use specified configuration instead of the default configuration. The default
+ configuration is named "root".</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--version</option></term>
+ <listitem>
+ <para>Print version and exit.</para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <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'>
+ <varlistentry>
+ <term><emphasis remap='B'>help</emphasis></term>
+ <listitem>
+ <para>Show short help text.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>list-configs</emphasis></term>
+ <listitem>
+ <para>List available configurations.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>create-config [options] <subvolume></emphasis></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
+ <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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>delete-config</emphasis></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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>list [options]</emphasis></term>
+ <listitem>
+ <para>List snapshots.</para>
+ </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>
+ <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>
+ <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>
+ <listitem>
+ <para>Delete a snapshot or a range of snapshots.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>mount <number></emphasis></term>
+ <listitem>
+ <para>Mount a snapshot. Not required for all filesystem types.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>umount <number></emphasis></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>
+ <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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>undochange [options] <number1>..<number2> [files]</emphasis></term>
+ <listitem>
+ <para>Undo changes done between snapshot number1 and number2.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-i, --input</option> <file></term>
+ <listitem>
+ <para>Read files for which to undo changes from file <file>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>cleanup <cleanup-algorithm></emphasis></term>
+ <listitem>
+ <para>Run the cleanup algorithm <cleanup-algorithm>. 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>
+ <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><option>-+:security.selinux</option>
+ for modified attributes</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <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>
+ </refsect1>
+
+ <refsect1 id='files'>
+ <title>FILES</title>
+ <variablelist remap='TP'>
+ <varlistentry>
+ <term><filename>/etc/sysconfig/snapper</filename></term>
+ <listitem>
+ <para>Global configuration file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>/etc/snapper/configs</filename></term>
+ <listitem>
+ <para>Directory containing configuration files.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>/etc/snapper/config-templates</filename></term>
+ <listitem>
+ <para>Directory containing configuration templates.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>/etc/snapper/filters</filename></term>
+ <listitem>
+ <para>Directory containing filter files.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>/var/log/snapper.log</filename></term>
+ <listitem>
+ <para>Logfile. Please include this file in bug reports.</para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <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>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>
+
+ <refsect1 id='homepage'>
+ <title>HOMEPAGE</title>
+ <para><ulink url='http://en.opensuse.org/Portal:Snapper'>http://en.opensuse.org/Portal:Snapper</ulink></para>
+ </refsect1>
+
+ <refsect1 id='authors'>
+ <title>AUTHORS</title>
+ <para>Arvin Schnell <email>aschnell@suse.de</email></para>
+ </refsect1>
+
+ <refsect1 id='see_also'>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>lvm</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>attr</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
+++ /dev/null
-.TH "SNAPPERD" "8" "2012-10-15" "@VERSION@" "Filesystem Snapshot Management"
-.SH "NAME"
-.LP
-snapperd - DBus daemon for snapper
-
-.SH "SYNTAX"
-.LP
-snapperd
-
-.SH "DESCRIPTION"
-.LP
-Snapperd is a DBus daemon for snapper and not for direct use by the user.
-
-.SH "HOMEPAGE"
-.LP
-http://en.opensuse.org/Portal:Snapper
-
-.SH "AUTHORS"
-.LP
-Arvin Schnell <aschnell@suse.de>
-
-.SH "SEE ALSO"
-.LP
-snapper(8), dbus-daemon(1)
--- /dev/null
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+
+<refentry id='snapperd8'>
+
+ <refentryinfo><date>2012-10-15</date></refentryinfo>
+ <refmeta>
+ <refentrytitle>snapperd</refentrytitle>
+ <manvolnum>8</manvolnum>
+ <refmiscinfo class='date'>2012-10-15</refmiscinfo>
+ <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>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Snapperd is a DBus daemon for snapper and not for direct use by the user.</para>
+ </refsect1>
+
+ <refsect1 id='homepage'>
+ <title>HOMEPAGE</title>
+ <para><ulink url='http://en.opensuse.org/Portal:Snapper'>http://en.opensuse.org/Portal:Snapper</ulink></para>
+ </refsect1>
+
+ <refsect1 id='authors'>
+ <title>AUTHORS</title>
+ <para>Arvin Schnell <email>aschnell@suse.de</email></para>
+ </refsect1>
+
+ <refsect1 id='see_also'>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry><refentrytitle>snapper</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
BuildRequires: libzypp(plugin:commit)
%endif
BuildRequires: pam-devel
+%if (0%{?suse_version} && 0%{?suse_version} >= 1220)
+BuildRequires: docbook-utils-minimal
+%else
+BuildRequires: docbook-utils
+%endif
Requires: libsnapper@LIBVERSION_MAJOR@ = %version
Requires: diffutils
%if 0%{?suse_version}
projects / thirdparty / snapper.git / commitdiff
