update manpage

This commit is contained in:
James Barnett 2017-02-03 20:56:18 -06:00
parent b6082ceaed
commit 59ea13fd11
No known key found for this signature in database
GPG key ID: E4B5E45AA3B8C5C3

View file

@ -31,46 +31,51 @@ depends on your specific setup. Be careful.
.SH CONFIGURATION .SH CONFIGURATION
Configuration is done via the snapper configuration files, with extra variables Configuration is done via the snapper configuration files, with extra variables
specific to these pacman hooks. The defaults should be suitable for most users, specific to these pacman hooks (see \fBsnapper-configs\fR(5)). The defaults
so you shouldn't need to change anything. of the following should be suitable for most users.
The following are possible settings you can place in each snapper configuration The following are possible settings you can place in each snapper configuration
file (e.g., \fI/etc/snapper/configs/root\fR, etc.). Follow the pattern of other file (e.g., \fI/etc/snapper/configs/root\fR, etc.). Follow the pattern of other
variables in the configuration file (VAR=setting). variables in the configuration file (VAR=setting).
\fBPACMAN_PRE_POST=\fR\fB\fIyes\fR\fR\fB or \fR\fB\fIno\fR\fR \fBPACMAN_PRE_POST=\fR\fB\fIyes\fR\fR\fB or \fR\fB\fIno\fR\fR
.RS .RS 4
Perform pacman pre/post snapshots for this configuration. Default is \fIno\fR Perform pacman pre/post snapshots for this configuration.
for all configurations, except for the root configuration which is \fIyes\fR.
Default is "no", except for the root configuration which is "yes".
.RE .RE
.BR PACMAN_CLEANUP_ALGORITHM .BR PACMAN_CLEANUP_ALGORITHM
.RS .RS 4
Snapper algorithm used in cleaning up the pacman pre/post snapshots. Default Snapper algorithm used in cleaning up the pacman pre/post snapshots. See \fBsnapper\fR(8) for list of valid options.
is \fInumber\fR. See \fBsnapper\fR(8) for list of valid options.
Default is "number".
.RE .RE
\fBPACMAN_PRE_DESCRIPTION=\fR\fB\fIstring\fR\fR \fBPACMAN_PRE_DESCRIPTION=\fR\fB\fIstring\fR\fR
.RS .RS 4
snapper description used for the pacman pre snapshot. Default is the pacman snapper description used for the pacman pre snapshot.
command that called the snapshot.
Default is the pacman command that called the snapshot.
.RE .RE
\fBPACMAN_POST_DESCRIPTION=\fR\fB\fIstring\fR\fR \fBPACMAN_POST_DESCRIPTION=\fR\fB\fIstring\fR\fR
.RS .RS 4
snapper description used for the pacman post snapshot. Default is the pacman snapper description used for the pacman post snapshot.
command that called the snapshot.
Default is the pacman command that called the snapshot.
.RE .RE
The following setting can be changed in the snapper configuration file The following setting can be changed in the snapper configuration file
\fI/etc/conf.d/snapper\fR: \fI/etc/conf.d/snapper\fR:
\fBPACMAN_ABORT_ON_FAIL=\fR\fB\fIyes\fR\fR\fB or \fR\fB\fIno\fR\fR \fBPACMAN_ABORT_ON_FAIL=\fR\fB\fIyes\fR\fR\fB or \fR\fB\fIno\fR\fR
.RS .RS 4
By default this is set to \fIno\fR. When set to When set to "yes" this causes pacman to abort a transaction if the snap-pac pre
\fIyes\fR this causes pacman to abort a transaction if the snap-pac pre hook hook fails. This prevents an upgrade/installation/removal from occurring if a
fails. This prevents an upgrade/installation/removal from occurring if a pre pre snapshot cannot be performed.
snapshot cannot be performed.
Default is "no".
.RE .RE
.SH EXAMPLE .SH EXAMPLE
@ -221,11 +226,15 @@ following:
.EE .EE
.SH HOMEPAGE
https://github.com/wesbarnett
.SH AUTHORS
Wes Barnett <wes@wbarnett.us>
.SH SEE ALSO .SH SEE ALSO
.BR alpm-hooks (5), .BR alpm-hooks (5),
.BR snapper (8), .BR snapper (8),
.BR snapper-configs (5),
.BR pacman (8) .BR pacman (8)
.SH AUTHORS
.MT https://github.com/wesbarnett
Wes Barnett