manpage: Remove auto gen tag from man page
This commit is contained in:
parent
e348b3deeb
commit
6bc43a4198
45 changed files with 27 additions and 114 deletions
|
@ -19,6 +19,7 @@ for convenience, and the command may need superuser rights, e.g.:
|
|||
|
||||
$ sudo restic autocomplete`,
|
||||
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if err := cmdRoot.GenBashCompletionFile(autocompleteTarget); err != nil {
|
||||
return err
|
||||
|
|
|
@ -37,6 +37,7 @@ given as the arguments.
|
|||
backupOptions.Hostname = hostname
|
||||
}
|
||||
},
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if backupOptions.Stdin && backupOptions.FilesFrom == "-" {
|
||||
return errors.Fatal("cannot use both `--stdin` and `--files-from -`")
|
||||
|
|
|
@ -20,6 +20,7 @@ var cmdCat = &cobra.Command{
|
|||
Long: `
|
||||
The "cat" command is used to print internal objects to stdout.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runCat(globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -20,6 +20,7 @@ var cmdCheck = &cobra.Command{
|
|||
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.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runCheck(checkOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -25,6 +25,7 @@ var cmdDump = &cobra.Command{
|
|||
Long: `
|
||||
The "dump" command dumps data structures from the repository as JSON objects. It
|
||||
is used for debugging purposes only.`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runDump(globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -20,6 +20,7 @@ var cmdFind = &cobra.Command{
|
|||
Long: `
|
||||
The "find" command searches for files or directories in snapshots stored in the
|
||||
repo. `,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runFind(findOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -18,6 +18,7 @@ The "forget" command removes snapshots according to a policy. Please note that
|
|||
this command really only deletes the snapshot object in the repository, which
|
||||
is a reference to data stored there. In order to remove this (now unreferenced)
|
||||
data after 'forget' was run successfully, see the 'prune' command. `,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runForget(forgetOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -15,6 +15,7 @@ var cmdInit = &cobra.Command{
|
|||
Long: `
|
||||
The "init" command initializes a new repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runInit(globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -17,6 +17,7 @@ var cmdKey = &cobra.Command{
|
|||
Long: `
|
||||
The "key" command manages keys (passwords) for accessing the repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runKey(globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -17,6 +17,7 @@ var cmdList = &cobra.Command{
|
|||
Long: `
|
||||
The "list" command allows listing objects in the repository based on type.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runList(globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -19,6 +19,7 @@ The "ls" command allows listing files and directories in a snapshot.
|
|||
|
||||
The special snapshot-ID "latest" can be used to list files and directories of the latest snapshot in the repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runLs(lsOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -16,7 +16,8 @@ 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
|
||||
set and no command is specified, all manpages are written to the directory.
|
||||
`,
|
||||
RunE: runManpage,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: runManpage,
|
||||
}
|
||||
|
||||
var manpageOpts = struct {
|
||||
|
|
|
@ -14,6 +14,7 @@ var cmdMigrate = &cobra.Command{
|
|||
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.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runMigrate(migrateOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -27,6 +27,7 @@ var cmdMount = &cobra.Command{
|
|||
The "mount" command mounts the repository via fuse to a directory. This is a
|
||||
read-only mount.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runMount(mountOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -14,7 +14,8 @@ var optionsCmd = &cobra.Command{
|
|||
Long: `
|
||||
The "options" command prints a list of extended options.
|
||||
`,
|
||||
Hidden: true,
|
||||
Hidden: true,
|
||||
DisableAutoGenTag: true,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
fmt.Printf("All Extended Options:\n")
|
||||
for _, opt := range options.List() {
|
||||
|
|
|
@ -20,6 +20,7 @@ var cmdPrune = &cobra.Command{
|
|||
The "prune" command checks the repository and removes data that is not
|
||||
referenced and therefore not needed any more.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runPrune(globalOptions)
|
||||
},
|
||||
|
|
|
@ -16,6 +16,7 @@ var cmdRebuildIndex = &cobra.Command{
|
|||
The "rebuild-index" command creates a new index based on the pack files in the
|
||||
repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runRebuildIndex(globalOptions)
|
||||
},
|
||||
|
|
|
@ -19,6 +19,7 @@ a directory.
|
|||
The special snapshot "latest" can be used to restore the latest snapshot in the
|
||||
repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runRestore(restoreOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -17,6 +17,7 @@ var cmdSnapshots = &cobra.Command{
|
|||
Long: `
|
||||
The "snapshots" command lists all snapshots stored in the repository.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runSnapshots(snapshotOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -22,6 +22,7 @@ add tags to/remove tags from the existing set.
|
|||
|
||||
When no snapshot-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runTag(tagOptions, globalOptions, args)
|
||||
},
|
||||
|
|
|
@ -13,6 +13,7 @@ var unlockCmd = &cobra.Command{
|
|||
Long: `
|
||||
The "unlock" command removes stale locks that have been created by other restic processes.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runUnlock(unlockOptions, globalOptions)
|
||||
},
|
||||
|
|
|
@ -14,6 +14,7 @@ var versionCmd = &cobra.Command{
|
|||
The "version" command prints detailed information about the build environment
|
||||
and the version of this software.
|
||||
`,
|
||||
DisableAutoGenTag: true,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
fmt.Printf("restic %s\ncompiled with %v on %v/%v\n",
|
||||
version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
|
||||
|
|
|
@ -25,8 +25,9 @@ var cmdRoot = &cobra.Command{
|
|||
restic is a backup program which allows saving multiple revisions of files and
|
||||
directories in an encrypted repository stored on different backends.
|
||||
`,
|
||||
SilenceErrors: true,
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
SilenceUsage: true,
|
||||
DisableAutoGenTag: true,
|
||||
|
||||
PersistentPreRunE: func(*cobra.Command, []string) error {
|
||||
// parse extended options
|
||||
|
|
|
@ -68,8 +68,3 @@ $ sudo restic autocomplete
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -94,8 +94,3 @@ given as the arguments.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -53,8 +53,3 @@ The "cat" command is used to print internal objects to stdout.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -62,8 +62,3 @@ finds. It can also be used to read all data and therefore simulate a restore.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -54,8 +54,3 @@ is used for debugging purposes only.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -86,8 +86,3 @@ repo.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -112,8 +112,3 @@ data after 'forget' was run successfully, see the 'prune' command.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -53,8 +53,3 @@ The "init" command initializes a new repository.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -53,8 +53,3 @@ The "key" command manages keys (passwords) for accessing the repository.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -53,8 +53,3 @@ The "list" command allows listing objects in the repository based on type.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -72,8 +72,3 @@ The special snapshot\-ID "latest" can be used to list files and directories of t
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -59,8 +59,3 @@ set and no command is specified, all manpages are written to the directory.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -58,8 +58,3 @@ name is explicitly given, a list of migrations that can be applied is printed.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -78,8 +78,3 @@ read\-only mount.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -54,8 +54,3 @@ referenced and therefore not needed any more.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -54,8 +54,3 @@ repository.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -82,8 +82,3 @@ repository.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -65,8 +65,3 @@ The "snapshots" command lists all snapshots stored in the repository.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -84,8 +84,3 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -57,8 +57,3 @@ The "unlock" command removes stale locks that have been created by other restic
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -54,8 +54,3 @@ and the version of this software.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
|
@ -52,8 +52,3 @@ directories in an encrypted repository stored on different backends.
|
|||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBrestic\-autocomplete(1)\fP, \fBrestic\-backup(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-manpage(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
5\-Aug\-2017 Auto generated by spf13/cobra
|
||||
|
|
Loading…
Reference in a new issue