forked from TrueCloudLab/restic
Capitalize short help commands
Unify existing Cobra help command, and git-help's style.
This commit is contained in:
parent
ee6150f67c
commit
9eb39cef05
24 changed files with 40 additions and 40 deletions
|
@ -8,7 +8,7 @@ var autocompleteTarget string
|
||||||
|
|
||||||
var cmdAutocomplete = &cobra.Command{
|
var cmdAutocomplete = &cobra.Command{
|
||||||
Use: "autocomplete",
|
Use: "autocomplete",
|
||||||
Short: "generate shell autocompletion script",
|
Short: "Generate shell autocompletion script",
|
||||||
Long: `The "autocomplete" command generates a shell autocompletion script.
|
Long: `The "autocomplete" command generates a shell autocompletion script.
|
||||||
|
|
||||||
NOTE: The current version supports Bash only.
|
NOTE: The current version supports Bash only.
|
||||||
|
|
|
@ -21,7 +21,7 @@ import (
|
||||||
|
|
||||||
var cmdBackup = &cobra.Command{
|
var cmdBackup = &cobra.Command{
|
||||||
Use: "backup [flags] FILE/DIR [FILE/DIR] ...",
|
Use: "backup [flags] FILE/DIR [FILE/DIR] ...",
|
||||||
Short: "create a new backup of files and/or directories",
|
Short: "Create a new backup of files and/or directories",
|
||||||
Long: `
|
Long: `
|
||||||
The "backup" command creates a new snapshot and saves the files and directories
|
The "backup" command creates a new snapshot and saves the files and directories
|
||||||
given as the arguments.
|
given as the arguments.
|
||||||
|
|
|
@ -16,7 +16,7 @@ import (
|
||||||
|
|
||||||
var cmdCat = &cobra.Command{
|
var cmdCat = &cobra.Command{
|
||||||
Use: "cat [flags] [pack|blob|snapshot|index|key|masterkey|config|lock] ID",
|
Use: "cat [flags] [pack|blob|snapshot|index|key|masterkey|config|lock] ID",
|
||||||
Short: "print internal objects to stdout",
|
Short: "Print internal objects to stdout",
|
||||||
Long: `
|
Long: `
|
||||||
The "cat" command is used to print internal objects to stdout.
|
The "cat" command is used to print internal objects to stdout.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -15,7 +15,7 @@ import (
|
||||||
|
|
||||||
var cmdCheck = &cobra.Command{
|
var cmdCheck = &cobra.Command{
|
||||||
Use: "check [flags]",
|
Use: "check [flags]",
|
||||||
Short: "check the repository for errors",
|
Short: "Check the repository for errors",
|
||||||
Long: `
|
Long: `
|
||||||
The "check" command tests the repository for errors and reports any errors it
|
The "check" command tests the repository for errors and reports any errors it
|
||||||
finds. It can also be used to read all data and therefore simulate a restore.
|
finds. It can also be used to read all data and therefore simulate a restore.
|
||||||
|
|
|
@ -21,7 +21,7 @@ import (
|
||||||
|
|
||||||
var cmdDump = &cobra.Command{
|
var cmdDump = &cobra.Command{
|
||||||
Use: "dump [indexes|snapshots|trees|all|packs]",
|
Use: "dump [indexes|snapshots|trees|all|packs]",
|
||||||
Short: "dump data structures",
|
Short: "Dump data structures",
|
||||||
Long: `
|
Long: `
|
||||||
The "dump" command dumps data structures from the repository as JSON objects. It
|
The "dump" command dumps data structures from the repository as JSON objects. It
|
||||||
is used for debugging purposes only.`,
|
is used for debugging purposes only.`,
|
||||||
|
|
|
@ -16,7 +16,7 @@ import (
|
||||||
|
|
||||||
var cmdFind = &cobra.Command{
|
var cmdFind = &cobra.Command{
|
||||||
Use: "find [flags] PATTERN",
|
Use: "find [flags] PATTERN",
|
||||||
Short: "find a file or directory",
|
Short: "Find a file or directory",
|
||||||
Long: `
|
Long: `
|
||||||
The "find" command searches for files or directories in snapshots stored in the
|
The "find" command searches for files or directories in snapshots stored in the
|
||||||
repo. `,
|
repo. `,
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdForget = &cobra.Command{
|
var cmdForget = &cobra.Command{
|
||||||
Use: "forget [flags] [snapshot ID] [...]",
|
Use: "forget [flags] [snapshot ID] [...]",
|
||||||
Short: "remove snapshots from the repository",
|
Short: "Remove snapshots from the repository",
|
||||||
Long: `
|
Long: `
|
||||||
The "forget" command removes snapshots according to a policy. Please note that
|
The "forget" command removes snapshots according to a policy. Please note that
|
||||||
this command really only deletes the snapshot object in the repository, which
|
this command really only deletes the snapshot object in the repository, which
|
||||||
|
|
|
@ -11,7 +11,7 @@ import (
|
||||||
|
|
||||||
var cmdInit = &cobra.Command{
|
var cmdInit = &cobra.Command{
|
||||||
Use: "init",
|
Use: "init",
|
||||||
Short: "initialize a new repository",
|
Short: "Initialize a new repository",
|
||||||
Long: `
|
Long: `
|
||||||
The "init" command initializes a new repository.
|
The "init" command initializes a new repository.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdKey = &cobra.Command{
|
var cmdKey = &cobra.Command{
|
||||||
Use: "key [list|add|remove|passwd] [ID]",
|
Use: "key [list|add|remove|passwd] [ID]",
|
||||||
Short: "manage keys (passwords)",
|
Short: "Manage keys (passwords)",
|
||||||
Long: `
|
Long: `
|
||||||
The "key" command manages keys (passwords) for accessing the repository.
|
The "key" command manages keys (passwords) for accessing the repository.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdList = &cobra.Command{
|
var cmdList = &cobra.Command{
|
||||||
Use: "list [blobs|packs|index|snapshots|keys|locks]",
|
Use: "list [blobs|packs|index|snapshots|keys|locks]",
|
||||||
Short: "list objects in the repository",
|
Short: "List objects in the repository",
|
||||||
Long: `
|
Long: `
|
||||||
The "list" command allows listing objects in the repository based on type.
|
The "list" command allows listing objects in the repository based on type.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdLs = &cobra.Command{
|
var cmdLs = &cobra.Command{
|
||||||
Use: "ls [flags] [snapshot-ID ...]",
|
Use: "ls [flags] [snapshot-ID ...]",
|
||||||
Short: "list files in a snapshot",
|
Short: "List files in a snapshot",
|
||||||
Long: `
|
Long: `
|
||||||
The "ls" command allows listing files and directories in a snapshot.
|
The "ls" command allows listing files and directories in a snapshot.
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ import (
|
||||||
|
|
||||||
var cmdManpage = &cobra.Command{
|
var cmdManpage = &cobra.Command{
|
||||||
Use: "manpage [command]",
|
Use: "manpage [command]",
|
||||||
Short: "generate manual pages",
|
Short: "Generate manual pages",
|
||||||
Long: `
|
Long: `
|
||||||
The "manpage" command generates a manual page for a single command. It can also
|
The "manpage" command generates a manual page for a single command. It can also
|
||||||
be used to write all manual pages to a directory. If the output directory is
|
be used to write all manual pages to a directory. If the output directory is
|
||||||
|
|
|
@ -9,7 +9,7 @@ import (
|
||||||
|
|
||||||
var cmdMigrate = &cobra.Command{
|
var cmdMigrate = &cobra.Command{
|
||||||
Use: "migrate [name]",
|
Use: "migrate [name]",
|
||||||
Short: "apply migrations",
|
Short: "Apply migrations",
|
||||||
Long: `
|
Long: `
|
||||||
The "migrate" command applies migrations to a repository. When no migration
|
The "migrate" command applies migrations to a repository. When no migration
|
||||||
name is explicitly given, a list of migrations that can be applied is printed.
|
name is explicitly given, a list of migrations that can be applied is printed.
|
||||||
|
|
|
@ -22,7 +22,7 @@ import (
|
||||||
|
|
||||||
var cmdMount = &cobra.Command{
|
var cmdMount = &cobra.Command{
|
||||||
Use: "mount [flags] mountpoint",
|
Use: "mount [flags] mountpoint",
|
||||||
Short: "mount the repository",
|
Short: "Mount the repository",
|
||||||
Long: `
|
Long: `
|
||||||
The "mount" command mounts the repository via fuse to a directory. This is a
|
The "mount" command mounts the repository via fuse to a directory. This is a
|
||||||
read-only mount.
|
read-only mount.
|
||||||
|
|
|
@ -10,7 +10,7 @@ import (
|
||||||
|
|
||||||
var optionsCmd = &cobra.Command{
|
var optionsCmd = &cobra.Command{
|
||||||
Use: "options",
|
Use: "options",
|
||||||
Short: "print list of extended options",
|
Short: "Print list of extended options",
|
||||||
Long: `
|
Long: `
|
||||||
The "options" command prints a list of extended options.
|
The "options" command prints a list of extended options.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -15,7 +15,7 @@ import (
|
||||||
|
|
||||||
var cmdPrune = &cobra.Command{
|
var cmdPrune = &cobra.Command{
|
||||||
Use: "prune [flags]",
|
Use: "prune [flags]",
|
||||||
Short: "remove unneeded data from the repository",
|
Short: "Remove unneeded data from the repository",
|
||||||
Long: `
|
Long: `
|
||||||
The "prune" command checks the repository and removes data that is not
|
The "prune" command checks the repository and removes data that is not
|
||||||
referenced and therefore not needed any more.
|
referenced and therefore not needed any more.
|
||||||
|
|
|
@ -11,7 +11,7 @@ import (
|
||||||
|
|
||||||
var cmdRebuildIndex = &cobra.Command{
|
var cmdRebuildIndex = &cobra.Command{
|
||||||
Use: "rebuild-index [flags]",
|
Use: "rebuild-index [flags]",
|
||||||
Short: "build a new index file",
|
Short: "Build a new index file",
|
||||||
Long: `
|
Long: `
|
||||||
The "rebuild-index" command creates a new index based on the pack files in the
|
The "rebuild-index" command creates a new index based on the pack files in the
|
||||||
repository.
|
repository.
|
||||||
|
|
|
@ -11,7 +11,7 @@ import (
|
||||||
|
|
||||||
var cmdRestore = &cobra.Command{
|
var cmdRestore = &cobra.Command{
|
||||||
Use: "restore [flags] snapshotID",
|
Use: "restore [flags] snapshotID",
|
||||||
Short: "extract the data from a snapshot",
|
Short: "Extract the data from a snapshot",
|
||||||
Long: `
|
Long: `
|
||||||
The "restore" command extracts the data from a snapshot from the repository to
|
The "restore" command extracts the data from a snapshot from the repository to
|
||||||
a directory.
|
a directory.
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdSnapshots = &cobra.Command{
|
var cmdSnapshots = &cobra.Command{
|
||||||
Use: "snapshots [snapshotID ...]",
|
Use: "snapshots [snapshotID ...]",
|
||||||
Short: "list all snapshots",
|
Short: "List all snapshots",
|
||||||
Long: `
|
Long: `
|
||||||
The "snapshots" command lists all snapshots stored in the repository.
|
The "snapshots" command lists all snapshots stored in the repository.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -13,7 +13,7 @@ import (
|
||||||
|
|
||||||
var cmdTag = &cobra.Command{
|
var cmdTag = &cobra.Command{
|
||||||
Use: "tag [flags] [snapshot-ID ...]",
|
Use: "tag [flags] [snapshot-ID ...]",
|
||||||
Short: "modify tags on snapshots",
|
Short: "Modify tags on snapshots",
|
||||||
Long: `
|
Long: `
|
||||||
The "tag" command allows you to modify tags on exiting snapshots.
|
The "tag" command allows you to modify tags on exiting snapshots.
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,7 @@ import (
|
||||||
|
|
||||||
var unlockCmd = &cobra.Command{
|
var unlockCmd = &cobra.Command{
|
||||||
Use: "unlock",
|
Use: "unlock",
|
||||||
Short: "remove locks other processes created",
|
Short: "Remove locks other processes created",
|
||||||
Long: `
|
Long: `
|
||||||
The "unlock" command removes stale locks that have been created by other restic processes.
|
The "unlock" command removes stale locks that have been created by other restic processes.
|
||||||
`,
|
`,
|
||||||
|
|
|
@ -9,7 +9,7 @@ import (
|
||||||
|
|
||||||
var versionCmd = &cobra.Command{
|
var versionCmd = &cobra.Command{
|
||||||
Use: "version",
|
Use: "version",
|
||||||
Short: "print version information",
|
Short: "Print version information",
|
||||||
Long: `
|
Long: `
|
||||||
The "version" command prints detailed information about the build environment
|
The "version" command prints detailed information about the build environment
|
||||||
and the version of this software.
|
and the version of this software.
|
||||||
|
|
|
@ -20,7 +20,7 @@ import (
|
||||||
// cmdRoot is the base command when no other command has been specified.
|
// cmdRoot is the base command when no other command has been specified.
|
||||||
var cmdRoot = &cobra.Command{
|
var cmdRoot = &cobra.Command{
|
||||||
Use: "restic",
|
Use: "restic",
|
||||||
Short: "backup and restore files",
|
Short: "Backup and restore files",
|
||||||
Long: `
|
Long: `
|
||||||
restic is a backup program which allows saving multiple revisions of files and
|
restic is a backup program which allows saving multiple revisions of files and
|
||||||
directories in an encrypted repository stored on different backends.
|
directories in an encrypted repository stored on different backends.
|
||||||
|
|
|
@ -16,23 +16,23 @@ Usage help is available:
|
||||||
restic [command]
|
restic [command]
|
||||||
|
|
||||||
Available Commands:
|
Available Commands:
|
||||||
autocomplete generate shell autocompletion script
|
autocomplete Generate shell autocompletion script
|
||||||
backup create a new backup of files and/or directories
|
backup Create a new backup of files and/or directories
|
||||||
cat print internal objects to stdout
|
cat Print internal objects to stdout
|
||||||
check check the repository for errors
|
check Check the repository for errors
|
||||||
find find a file or directory
|
find Find a file or directory
|
||||||
forget remove snapshots from the repository
|
forget Remove snapshots from the repository
|
||||||
init initialize a new repository
|
init Initialize a new repository
|
||||||
key manage keys (passwords)
|
key Manage keys (passwords)
|
||||||
list list items in the repository
|
list List items in the repository
|
||||||
ls list files in a snapshot
|
ls List files in a snapshot
|
||||||
mount mount the repository
|
mount Mount the repository
|
||||||
prune remove unneeded data from the repository
|
prune Remove unneeded data from the repository
|
||||||
rebuild-index build a new index file
|
rebuild-index Build a new index file
|
||||||
restore extract the data from a snapshot
|
restore Extract the data from a snapshot
|
||||||
snapshots list all snapshots
|
snapshots List all snapshots
|
||||||
tag modify tags on snapshots
|
tag Modify tags on snapshots
|
||||||
unlock remove locks other processes created
|
unlock Remove locks other processes created
|
||||||
version Print version information
|
version Print version information
|
||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
|
|
Loading…
Reference in a new issue