Merge pull request #1230 from shayneholmes/update-short-help

Update style in short help commands

cmd/restic/cmd_autocomplete.go

@@ -8,7 +8,7 @@ var autocompleteTarget string
 
 var cmdAutocomplete = &cobra.Command{
 	Use:   "autocomplete",
-	Short: "generate shell autocompletion script",
+	Short: "Generate shell autocompletion script",
 	Long: `The "autocomplete" command generates a shell autocompletion script.
 
 NOTE: The current version supports Bash only.

cmd/restic/cmd_backup.go

@@ -21,7 +21,7 @@ import (
 
 var cmdBackup = &cobra.Command{
 	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: `
 The "backup" command creates a new snapshot and saves the files and directories
 given as the arguments.

cmd/restic/cmd_cat.go

@@ -16,7 +16,7 @@ import (
 
 var cmdCat = &cobra.Command{
 	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: `
 The "cat" command is used to print internal objects to stdout.
 `,

cmd/restic/cmd_check.go

@@ -15,7 +15,7 @@ import (
 
 var cmdCheck = &cobra.Command{
 	Use:   "check [flags]",
-	Short: "check the repository for errors",
+	Short: "Check the repository for errors",
 	Long: `
 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.

cmd/restic/cmd_dump.go

@@ -21,7 +21,7 @@ import (
 
 var cmdDump = &cobra.Command{
 	Use:   "dump [indexes|snapshots|trees|all|packs]",
-	Short: "dump data structures",
+	Short: "Dump data structures",
 	Long: `
 The "dump" command dumps data structures from the repository as JSON objects. It
 is used for debugging purposes only.`,

cmd/restic/cmd_find.go

@@ -16,7 +16,7 @@ import (
 
 var cmdFind = &cobra.Command{
 	Use:   "find [flags] PATTERN",
-	Short: "find a file or directory",
+	Short: "Find a file or directory",
 	Long: `
 The "find" command searches for files or directories in snapshots stored in the
 repo. `,

cmd/restic/cmd_forget.go

@@ -13,7 +13,7 @@ import (
 
 var cmdForget = &cobra.Command{
 	Use:   "forget [flags] [snapshot ID] [...]",
-	Short: "forget removes snapshots from the repository",
+	Short: "Remove snapshots from the repository",
 	Long: `
 The "forget" command removes snapshots according to a policy. Please note that
 this command really only deletes the snapshot object in the repository, which

cmd/restic/cmd_init.go

@@ -11,7 +11,7 @@ import (
 
 var cmdInit = &cobra.Command{
 	Use:   "init",
-	Short: "initialize a new repository",
+	Short: "Initialize a new repository",
 	Long: `
 The "init" command initializes a new repository.
 `,

cmd/restic/cmd_key.go

@@ -13,7 +13,7 @@ import (
 
 var cmdKey = &cobra.Command{
 	Use:   "key [list|add|remove|passwd] [ID]",
-	Short: "manage keys (passwords)",
+	Short: "Manage keys (passwords)",
 	Long: `
 The "key" command manages keys (passwords) for accessing the repository.
 `,

cmd/restic/cmd_list.go

@@ -13,7 +13,7 @@ import (
 
 var cmdList = &cobra.Command{
 	Use:   "list [blobs|packs|index|snapshots|keys|locks]",
-	Short: "list objects in the repository",
+	Short: "List objects in the repository",
 	Long: `
 The "list" command allows listing objects in the repository based on type.
 `,

cmd/restic/cmd_ls.go

@@ -13,7 +13,7 @@ import (
 
 var cmdLs = &cobra.Command{
 	Use:   "ls [flags] [snapshot-ID ...]",
-	Short: "list files in a snapshot",
+	Short: "List files in a snapshot",
 	Long: `
 The "ls" command allows listing files and directories in a snapshot.
 

cmd/restic/cmd_manpage.go

@@ -11,7 +11,7 @@ import (
 
 var cmdManpage = &cobra.Command{
 	Use:   "manpage [command]",
-	Short: "generate manual pages",
+	Short: "Generate manual pages",
 	Long: `
 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

cmd/restic/cmd_migrate.go

@@ -9,7 +9,7 @@ import (
 
 var cmdMigrate = &cobra.Command{
 	Use:   "migrate [name]",
-	Short: "apply migrations",
+	Short: "Apply migrations",
 	Long: `
 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.

cmd/restic/cmd_mount.go

@@ -22,7 +22,7 @@ import (
 
 var cmdMount = &cobra.Command{
 	Use:   "mount [flags] mountpoint",
-	Short: "mount the repository",
+	Short: "Mount the repository",
 	Long: `
 The "mount" command mounts the repository via fuse to a directory. This is a
 read-only mount.

cmd/restic/cmd_options.go

@@ -10,7 +10,7 @@ import (
 
 var optionsCmd = &cobra.Command{
 	Use:   "options",
-	Short: "print list of extended options",
+	Short: "Print list of extended options",
 	Long: `
 The "options" command prints a list of extended options.
 `,

cmd/restic/cmd_prune.go

@@ -15,7 +15,7 @@ import (
 
 var cmdPrune = &cobra.Command{
 	Use:   "prune [flags]",
-	Short: "remove unneeded data from the repository",
+	Short: "Remove unneeded data from the repository",
 	Long: `
 The "prune" command checks the repository and removes data that is not
 referenced and therefore not needed any more.

cmd/restic/cmd_rebuild_index.go

@@ -11,7 +11,7 @@ import (
 
 var cmdRebuildIndex = &cobra.Command{
 	Use:   "rebuild-index [flags]",
-	Short: "build a new index file",
+	Short: "Build a new index file",
 	Long: `
 The "rebuild-index" command creates a new index based on the pack files in the
 repository.

cmd/restic/cmd_restore.go

@@ -11,7 +11,7 @@ import (
 
 var cmdRestore = &cobra.Command{
 	Use:   "restore [flags] snapshotID",
-	Short: "extract the data from a snapshot",
+	Short: "Extract the data from a snapshot",
 	Long: `
 The "restore" command extracts the data from a snapshot from the repository to
 a directory.

cmd/restic/cmd_snapshots.go

@@ -13,7 +13,7 @@ import (
 
 var cmdSnapshots = &cobra.Command{
 	Use:   "snapshots [snapshotID ...]",
-	Short: "list all snapshots",
+	Short: "List all snapshots",
 	Long: `
 The "snapshots" command lists all snapshots stored in the repository.
 `,

cmd/restic/cmd_tag.go

@@ -13,7 +13,7 @@ import (
 
 var cmdTag = &cobra.Command{
 	Use:   "tag [flags] [snapshot-ID ...]",
-	Short: "modifies tags on snapshots",
+	Short: "Modify tags on snapshots",
 	Long: `
 The "tag" command allows you to modify tags on exiting snapshots.
 

cmd/restic/cmd_unlock.go

@@ -9,7 +9,7 @@ import (
 
 var unlockCmd = &cobra.Command{
 	Use:   "unlock",
-	Short: "remove locks other processes created",
+	Short: "Remove locks other processes created",
 	Long: `
 The "unlock" command removes stale locks that have been created by other restic processes.
 `,

cmd/restic/cmd_version.go

@@ -9,7 +9,7 @@ import (
 
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "print version information",
+	Short: "Print version information",
 	Long: `
 The "version" command prints detailed information about the build environment
 and the version of this software.

cmd/restic/main.go

@@ -20,7 +20,7 @@ import (
 // cmdRoot is the base command when no other command has been specified.
 var cmdRoot = &cobra.Command{
 	Use:   "restic",
-	Short: "backup and restore files",
+	Short: "Backup and restore files",
 	Long: `
 restic is a backup program which allows saving multiple revisions of files and
 directories in an encrypted repository stored on different backends.