diff --git a/btrbk b/btrbk index bbb761a..e03c835 100755 --- a/btrbk +++ b/btrbk @@ -203,8 +203,8 @@ sub HELP_MESSAGE print STDERR "commands:\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 " tree [filter...] shows backup tree\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 " origin print origin information for subvolume\n"; print STDERR " diff shows new files since subvolume for subvolume \n"; diff --git a/doc/FAQ.md b/doc/FAQ.md index 1809915..be43768 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -37,12 +37,12 @@ valid mount-points, you can loop through the configuration and mount the volumes like this: #!/bin/sh - btrbk config dump volume | while read line; do + btrbk config list volume --format=raw | while read line; do eval $line $volume_rsh mount $volume_path 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 automount" tags in your configuration and dump only the volumes of this group: `btrbk config dump volume automount`. diff --git a/doc/btrbk.1 b/doc/btrbk.1 index ac5e6e1..9c2acbb 100644 --- a/doc/btrbk.1 +++ b/doc/btrbk.1 @@ -88,7 +88,7 @@ Print output in table format (shortcut for "--format=table"). .RS 4 Print output in specified format. If set to "raw", prints 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. .RE .PP @@ -141,12 +141,15 @@ in conjunction with \fI\-l debug\fR to see the btrfs commands that would be executed. .RE .PP -.B info +.B list [filter...] .RS 4 -Print filesystem usage information for all source/target -volumes. Optionally filtered by [filter...] arguments (see \fIFILTER -STATEMENTS\fR below). +Print the source/snapshot/target relations of the configured +subvolumes in a tabular form. Optionally filtered by [filter...] +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 .PP .B tree @@ -158,14 +161,12 @@ STATEMENTS\fR below). Use the \fI\-\-format\fR command line option to switch between different output formats. .RE .PP -.B list +.B info [filter...] .RS 4 -Print the source/snapshot/target relations of the configured -subvolumes in a tabular form. Optionally filtered by [filter...] -arguments (see \fIFILTER STATEMENTS\fR below). Use the -\fI\-\-format\fR command line option to switch between different -output formats. +Print filesystem usage information for all source/target +volumes. Optionally filtered by [filter...] arguments (see \fIFILTER +STATEMENTS\fR below). .RE .PP .B origin @@ -181,10 +182,11 @@ parent-child relationship as well as the received-from information. Print new files since subvolume for subvolume . .RE .PP -.B config dump -volume|source|target [filter...] \fI*experimental*\fR +.B config +print|print-all .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 .SH FILTER STATEMENTS Filter arguments are accepted in form: