documentation: cosmetics

pull/30/head
Axel Burri 2015-03-19 13:16:58 +01:00
parent bef56e59d3
commit 930e2cfbf0
2 changed files with 9 additions and 9 deletions

2
btrbk
View File

@ -117,7 +117,7 @@ sub HELP_MESSAGE
print STDERR " -l LEVEL set loglevel (warn, info, debug, trace)\n"; print STDERR " -l LEVEL set loglevel (warn, info, debug, trace)\n";
print STDERR "\n"; print STDERR "\n";
print STDERR "commands:\n"; print STDERR "commands:\n";
print STDERR " run perform backup operations as defined in configuration\n"; print STDERR " run perform backup operations as defined in the configuration\n";
print STDERR " dryrun don't run btrfs commands, just show what would be executed\n"; print STDERR " dryrun don't run btrfs commands, just show what would be executed\n";
print STDERR " info print useful filesystem information\n"; print STDERR " info print useful filesystem information\n";
print STDERR " tree shows backup tree\n"; print STDERR " tree shows backup tree\n";

View File

@ -52,9 +52,9 @@ performed for the specified subvolumes (which must match a
volume/subvolume declaration in the configuration file), and the -p volume/subvolume declaration in the configuration file), and the -p
(preserve backups) option is implied. (preserve backups) option is implied.
.PP .PP
First, btrbk reads information from the source/target btrfs volumes in First, btrbk reads information from the source and target btrfs
order to do sanity checks and find out about parent/child as well as volumes in order to perform sanity checks and identify parent/child
received-from relationships. and received-from relationships.
.PP .PP
If the checks succeed, btrbk creates snapshots for all the source If the checks succeed, btrbk creates snapshots for all the source
subvolumes specified in the configuration file. subvolumes specified in the configuration file.
@ -65,17 +65,17 @@ found. If no common parent subvolume is found, a full backup is
created. created.
.PP .PP
In a last step, previous snapshots and backup subvolumes that are not In a last step, previous snapshots and backup subvolumes that are not
preserved by the current retention policy will be deleted. This step preserved by their configured retention policy will be deleted. This
will be skipped if the -p (preserve backups) option is present. step will be skipped if the -p (preserve backups) option is present.
.RE .RE
.PP .PP
.B dryrun .B dryrun
[subvolume...] [subvolume...]
.RS 4 .RS 4
Don't run btrfs commands, just show the snapshots and backup Don't run btrfs commands, just show the snapshots and backup
subvolumes that what would be created/deleted by the \fBrun\fR subvolumes that would be created/deleted by the \fBrun\fR command. Use
command. Use in conjunction with \fI\-l debug\fR to see the btrfs in conjunction with \fI\-l debug\fR to see the btrfs commands that
commands that would be executed. would be executed.
.RE .RE
.PP .PP
.B info .B info