me/snap-pac
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update wording on snapper filters

Browse source
This commit is contained in:
Wes Barnett 2021-01-29 20:51:01 -05:00
parent 189fb58044
commit 8af8c526bc
No known key found for this signature in database
GPG key ID: 1070BCC98C18BD66
1 changed files with 30 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
man8/snap-pac.8
View file

@ -1,5 +1,5 @@
'\" t '\" t
.TH SNAP-PAC 8 2017-02-04 SNAP-PAC .TH SNAP-PAC 8 2021-01-29 SNAP-PAC
.SH NAME .SH NAME
snap-pac \- Pacman hooks that use snapper to create pre/post btrfs snapshots snap-pac \- Pacman hooks that use snapper to create pre/post btrfs snapshots
like openSUSE's YaST like openSUSE's YaST
@ -16,10 +16,11 @@ directly, through an AUR helper, or using an alias—snapper will create the
snapshots when pacman installs, upgrades, or removes a package. The pacman snapshots when pacman installs, upgrades, or removes a package. The pacman
command used is logged in the snapper description for the snapshots. command used is logged in the snapper description for the snapshots.
Additionally the snapshot numbers are output to the screen and to the pacman log Additionally the snapshot numbers are output to the screen and to the pacman log
for each snapper configuration during the pacman transaction. for each snapper configuration during the pacman transaction, so that the user can
easily find which changes he or she may want to revert.
To undo changes from a pacman transaction, use \fIsnapper undochange\fR. See To undo changes from a pacman transaction, use \fIsnapper undochange\fR. See
\fBsnapper\fR(8) and the following example. \fBsnapper\fR(8) and \fBEXAMPLES\fR.
If you have severe breakage—like snapper is gone for some reason and you can't If you have severe breakage—like snapper is gone for some reason and you can't
get it back—you'll have to resort to more extreme methods, such as taking a get it back—you'll have to resort to more extreme methods, such as taking a
@ -76,21 +77,22 @@ Default is "no", except for the root configuration which is "yes".
.BR CLEANUP_ALGORITHM .BR CLEANUP_ALGORITHM
.RS 4 .RS 4
snapper algorithm used in cleaning up the pacman pre/post snapshots. See \fBsnapper\fR(8) for list of valid options. \fBsnapper\fR algorithm used in cleaning up the pacman pre/post snapshots. See
\fBsnapper\fR(8) for a list of valid options.
Default is "number". Default is "number".
.RE .RE
\fBPRE_DESCRIPTION=\fR\fB\fIstring\fR\fR \fBPRE_DESCRIPTION=\fR\fB\fIstring\fR\fR
.RS 4 .RS 4
snapper description used for the pacman pre snapshot. \fBsnapper\fR description used for the pacman pre snapshot.
Default is the parent program (usually pacman) that called the snapshot script. Default is the parent program, usually \fBpacman\fR, that called the snapshot script.
.RE .RE
\fBPOST_DESCRIPTION=\fR\fB\fIstring\fR\fR \fBPOST_DESCRIPTION=\fR\fB\fIstring\fR\fR
.RS 4 .RS 4
snapper description used for the pacman post snapshot. \fBsnapper\fR description used for the pacman post snapshot.
Default is the list of packages that were installed/upgraded/removed Default is the list of packages that were installed/upgraded/removed
during the transaction. during the transaction.
@ -109,9 +111,10 @@ example:
.EE .EE
.SH EXAMPLE .SH EXAMPLES
Installing the nano package as normal: Here is an example of how the snapshots are created and how to rollback and pacman
transaction. Here the \fBnano\fR package is installed:
.EX .EX
@ -141,9 +144,9 @@ Installing the nano package as normal:
.EE .EE
The snapper snapshot number is given for each snapper configuration that is The snapper snapshot number is given for each snapper configuration that is
used. Tip: this is also logged in pacman's log). used. This is also logged in pacman's log.
And here are the snapshots: Here are the snapshots created before and after the pacman transaction:
.EX .EX
@ -152,7 +155,7 @@ And here are the snapshots:
.EE .EE
What changed? Here is what changed during the transaction:
.EX .EX
@ -170,11 +173,10 @@ What changed?
.EE .EE
I truncated the above output, but it continues. See the manpage for snapper to The above output is truncated, but it continues. See the \fBsnapper\fR(8) to
see what each symbol means. You can also do snapper diff in the same way—I'll for what each symbol means. You can also do \fBsnapper diff\fR in the same way.
spare you that one.
To undo the upgrade: Then, to undo the \fBpacman\fR transaction:
.EX .EX
@ -183,7 +185,7 @@ To undo the upgrade:
.EE .EE
And nano is now gone, along with all the files it changed: Now nano is no longer installed, along with all the files it changed:
.EX .EX
@ -194,22 +196,26 @@ And nano is now gone, along with all the files it changed:
.SH TROUBLESHOOTING .SH TROUBLESHOOTING
.SS snap-pac is only taking snapshots of the root configuration .SS snap-pac is only taking snapshots of the root configuration.
That's the default behavior. See \fBCONFIGURATION\fR. That's the default behavior. See \fBCONFIGURATION\fR.
.SS No snapshots are being taken when I run pacman .SS No snapshots are being taken when I run pacman.
No snapper configurations are set up for snap-pac's pacman hooks. By default No snapper configurations are set up for snap-pac's pacman hooks. By default
snap-pac will take snapshots for the root configuration and any other snap-pac will take snapshots for the root configuration and any other
configuration which has SNAPSHOT set to yes in its configuration file. configuration which has SNAPSHOT set to yes in its configuration file.
See CONFIGURATION. See \fBCONFIGURATION\fR.
.SS After restoring snapshot from snap-pac, pacman database is locked .SS After restoring snapshot from snap-pac, the pacman database is locked.
The pre/post snaphots are taken while pacman is running, so this is expected. The pre/post snaphots are taken while pacman is running, so this is expected.
Follow the instructions pacman gives you (e.g., removing the lock file). Follow the instructions pacman gives you (e.g., removing the lock file). You can add the
database lock file to a snapper filter so that snapper won't consider it when performing
\fBsnapper diff\fR, \fBsnapper status\fR, \fBsnapper undochange\fR, etc. See the
\fBFilters\fR section in \fBsnapper\fR(8) for more information.
.SH FAQ .SH FAQ
.SS Does snap-pac backup non-btrfs /boot partitions? .SS Does snap-pac backup non-btrfs /boot partitions?
Nope. But you can add a hook that does it for you. It would be No, but you can add a hook that does it for you. It would be
something like the following: something like the following:
.EX .EX
@ -228,7 +234,7 @@ something like the following:
.EE .EE
.SS How do I link old kernel modules? .SS How do I link old kernel modules automatically when the kernel is upgraded?
This behavior is no longer a part of this package. Use a pacman hook like the following: This behavior is no longer a part of this package. Use a pacman hook like the following:
[Trigger] [Trigger]