'\" t
.\"     Title: pam_snapper
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2013-05-23
.\"    Manual: Filesystem Snapshot Management
.\"    Source: 0.11.0
.\"  Language: English
.\"
.TH "PAM_SNAPPER" "8" "2013\-05\-23" "0\&.11\&.0" "Filesystem Snapshot Management"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pam_snapper \- PAM module which creates filesystem snapshots via "snapper"
.SH "SYNOPSIS"
.HP \w'\fBpam_snapper\&.so\fR\ 'u
\fBpam_snapper\&.so\fR [debug] [homeprefix=\fIprefix\fR] [ignoreservices=\fIservices\fR] [ignoreusers=\fIusers\fR] [rootasroot] [ignoreroot] [openonly] [closeonly] [cleanup=\fIalgorithm\fR]
.SH "DESCRIPTION"
.PP
Create a snapshot at every login of a user, thus they always have a save starting point\&.
.PP
As many users do not logout for some time, it is a good idea to enable snapper\*(Aqs time based snapshots in addition\&.
.SH "OPTIONS"
.PP
\fBdebug\fR
.RS 4
Switch on debugging in the module\&.
.RE
.PP
\fBhomeprefix=\fR\fB\fIprefix\fR\fR
.RS 4
Prefix for the name of the snapper configuration\&. The username will be appended to this prefix\&.
.sp
Default: "home_"
.RE
.PP
\fBignoreservices=\fR\fB\fIcomma separated list of services\fR\fR
.RS 4
Default: "crond"
.RE
.PP
\fBignoreusers=\fR\fB\fIcomma separated list of users\fR\fR
.RS 4
Default: (none)
.RE
.PP
\fBrootasroot\fR
.RS 4
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\&.
.sp
"rootasroot" and "ignoreroot" are mutually exclusive\&.
.RE
.PP
\fBignoreroot\fR
.RS 4
No snapshot is taken, if the user "root" opens/closes a session\&.
.sp
"rootasroot" and "ignoreroot" are mutually exclusive\&.
.RE
.PP
\fBopenonly\fR
.RS 4
Only create a single snapshot when opening the PAM session\&.
.sp
Default: create pre\- and post\-snapshots
.RE
.PP
\fBcloseonly\fR
.RS 4
Only create a single snapshot when closing the PAM session\&.
.sp
Default: create pre\- and post\-snapshots
.RE
.PP
\fBcleanup=\fR\fB\fIcleanup\-algorithm\fR\fR
.RS 4
Set snapper cleanup algorithm\&.
.sp
Default: (none)
.RE
.SH "MODULE TYPES PROVIDED"
.PP
Only the module type "session" is provided\&.
.SH "RETURN VALUES"
.PP
PAM_SUCCESS
.RS 4
pam_snapper will always return PAM_SUCCESS, to not prevent users from login, in case a snapshot fails\&. This may change in the future\&.
.RE
.SH "EXAMPLES"
.SS "Basic usage"
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
Add the following line to
/etc/pam\&.d/common\-session:
.sp
.if n \{\
.RS 4
.\}
.nf
session    optional    pam_snapper\&.so
	  
.fi
.if n \{\
.RE
.\}
.sp
.RE
.SH "SEE ALSO"
.PP
\fBsnapper\fR(8),
\fBpam.conf\fR(5),
\fBpam\fR(8), pam_snapper_homeconvert, pam_snapper_pamconfig, pam_snapper_useradd, pam_snapper_userdel
.SH "HOMEPAGE"
.PP
\m[blue]\fBhttp://snapper\&.io/\fR\m[]
.SH "AUTHORS"
.PP
pam\-snapper was written by Matthias G\&. Eckermann
<mge@suse\&.com>
as part of SUSE 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 DBUS handling from "snapper_dbus_cli\&.c" by David Disseldorp\&.
.PP
The module builds on the Linux PAM stack and its documentation, written by Thorsten Kukuk\&.
.SH "LICENSE"
.PP
Copyright (c) 2013 SUSE
.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 GNU General Public License as published by the Free Software Foundation\&.
.PP
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\&.
.PP
You should have received a copy of the GNU General Public License along with this program; if not, contact SUSE\&.
.PP
To contact SUSE about this file by physical or electronic mail, you may find current contact information at www\&.suse\&.com\&.