dump: Mention tar output in command help text

This commit is contained in:
Michael Eischer 2020-08-31 21:40:47 +02:00
parent dcf9ded977
commit 81dcfea11a
1 changed files with 4 additions and 2 deletions

View File

@ -19,8 +19,10 @@ var cmdDump = &cobra.Command{
Use: "dump [flags] snapshotID file",
Short: "Print a backed-up file to stdout",
Long: `
The "dump" command extracts a single file from a snapshot from the repository and
prints its contents to stdout.
The "dump" command extracts files from a snapshot from the repository. If a
single file is selected, it prints its contents to stdout. Folders are output
as a tar file containing the contents of the specified folder. Pass "/" as
file name to dump the whole snapshot as a tar file.
The special snapshot "latest" can be used to use the latest snapshot in the
repository.