docs(backup): add usage text to describe argument (#1193)

This commit is contained in:
Kyle Roth 2021-04-19 03:25:45 -06:00 committed by GitHub
parent 075eb549df
commit 17600e5259
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -23,8 +23,11 @@ import (
// BackupCommand configures the backup cli command. // BackupCommand configures the backup cli command.
var BackupCommand = cli.Command{ var BackupCommand = cli.Command{
Name: "backup", Name: "backup",
Usage: "Creates album and index backups", Usage: "Creates album and index backups",
UsageText: `The first argument (if provided) is the path where the backup will be created.
If not specified, a backup is created at PHOTOPRISM_BACKUP_PATH in a file named
with today's date.`,
Flags: backupFlags, Flags: backupFlags,
Action: backupAction, Action: backupAction,
} }