ambiser
/
btrbk
mirror of https://github.com/digint/btrbk
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation: add missing "config print" command; add predefined "list" filters; cosmetics; fix FAQ

pull/57/head
Axel Burri 2015-10-13 19:32:48 +02:00
parent 46c7841e93
commit bca413b7ca
3 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
btrbk
View File

@ -203,8 +203,8 @@ sub HELP_MESSAGE
print STDERR "commands:\n"; print STDERR "commands:\n";
print STDERR " run [filter...] perform backup operations as defined in the config file\n"; print STDERR " run [filter...] perform backup operations as defined in the config file\n";
print STDERR " dryrun [filter...] don't run btrfs commands; show what would be executed\n"; print STDERR " dryrun [filter...] don't run btrfs commands; show what would be executed\n";
print STDERR " tree [filter...] shows backup tree\n";
print STDERR " list [filter...] print source/snapshot/target relations\n"; print STDERR " list [filter...] print source/snapshot/target relations\n";
print STDERR " tree [filter...] shows backup tree\n";
print STDERR " info [filter...] print useful filesystem information\n"; print STDERR " info [filter...] print useful filesystem information\n";
print STDERR " origin <subvol> print origin information for subvolume\n"; print STDERR " origin <subvol> print origin information for subvolume\n";
print STDERR " diff <from> <to> shows new files since subvolume <from> for subvolume <to>\n"; print STDERR " diff <from> <to> shows new files since subvolume <from> for subvolume <to>\n";

4
doc/FAQ.md
View File

@ -37,12 +37,12 @@ valid mount-points, you can loop through the configuration and mount
the volumes like this: the volumes like this:
#!/bin/sh #!/bin/sh
btrbk config dump volume | while read line; do btrbk config list volume --format=raw | while read line; do
eval $line eval $line
$volume_rsh mount $volume_path $volume_rsh mount $volume_path
done done
Note that the `btrbk config dump volume` command accepts filters (see Note that the `btrbk config list` command accepts filters (see
[btrbk(1)], FILTER STATEMENTS), which means you can e.g. add "group [btrbk(1)], FILTER STATEMENTS), which means you can e.g. add "group
automount" tags in your configuration and dump only the volumes of automount" tags in your configuration and dump only the volumes of
this group: `btrbk config dump volume automount`. this group: `btrbk config dump volume automount`.

30
doc/btrbk.1
View File

@ -88,7 +88,7 @@ Print output in table format (shortcut for "--format=table").
.RS 4 .RS 4
Print output in specified format. If set to "raw", prints Print output in specified format. If set to "raw", prints
space-separated key="value" pairs (machine-readable). Affects output space-separated key="value" pairs (machine-readable). Affects output
format for \fBrun\fR, \fBdryrun\fR, \fBinfo\fR and \fBtree\fR format for \fBrun\fR, \fBdryrun\fR, \fBlist\fR and \fBtree\fR
commands. Useful for further exporting/scripting. commands. Useful for further exporting/scripting.
.RE .RE
.PP .PP
@ -141,12 +141,15 @@ in conjunction with \fI\-l debug\fR to see the btrfs commands that
would be executed. would be executed.
.RE .RE
.PP .PP
.B info .B list
[filter...] [filter...]
.RS 4 .RS 4
Print filesystem usage information for all source/target Print the source/snapshot/target relations of the configured
volumes. Optionally filtered by [filter...] arguments (see \fIFILTER subvolumes in a tabular form. Optionally filtered by [filter...]
STATEMENTS\fR below). arguments (see \fIFILTER STATEMENTS\fR below). Accepts predefined
filters \fIvolume\fR, \fIsource\fR and \fItarget\fR. Use the
\fI\-\-format\fR command line option to switch between different
output formats.
.RE .RE
.PP .PP
.B tree .B tree
@ -158,14 +161,12 @@ STATEMENTS\fR below). Use the \fI\-\-format\fR command line option to
switch between different output formats. switch between different output formats.
.RE .RE
.PP .PP
.B list .B info
[filter...] [filter...]
.RS 4 .RS 4
Print the source/snapshot/target relations of the configured Print filesystem usage information for all source/target
subvolumes in a tabular form. Optionally filtered by [filter...] volumes. Optionally filtered by [filter...] arguments (see \fIFILTER
arguments (see \fIFILTER STATEMENTS\fR below). Use the STATEMENTS\fR below).
\fI\-\-format\fR command line option to switch between different
output formats.
.RE .RE
.PP .PP
.B origin .B origin
@ -181,10 +182,11 @@ parent-child relationship as well as the received-from information.
Print new files since subvolume <from> for subvolume <to>. Print new files since subvolume <from> for subvolume <to>.
.RE .RE
.PP .PP
.B config dump .B config
volume|source|target [filter...] \fI*experimental*\fR print|print-all
.RS 4 .RS 4
Dump parsed content from the configuration file, in format: key="value"... Prints the parsed configuration file. Use the \fI\-\-format\fR command
line option to switch between different output formats.
.RE .RE
.SH FILTER STATEMENTS .SH FILTER STATEMENTS
Filter arguments are accepted in form: Filter arguments are accepted in form: