cmd

Documentation

Overview

Package cmd implements the command line options to configure and run the application

Index

• Variables
• func Execute(ctx context.Context)
• func ResetListJobInfo()
• func ResetReceiveJobInfo()
• func ResetSendJobInfo()

Variables

var RootCmd = &cobra.Command{
	Use:   "zfsbackup",
	Short: "zfsbackup is a tool used to do off-site backups of ZFS volumes.",
	Long: `zfsbackup is a tool used to do off-site backups of ZFS volumes.
It leverages the built-in snapshot capabilities of ZFS in order to export ZFS
volumes for long-term storage.

zfsbackup uses the "zfs send" command to export, and optionally compress, sign,
encrypt, and split the send stream to files that are then transferred to a
destination of your choosing.`,
	PersistentPreRunE: processFlags,
	PersistentPostRun: postRunCleanup,
	SilenceErrors:     true,
	SilenceUsage:      true,
}

RootCmd represents the base command when called without any subcommands

Functions

func Execute

func Execute(ctx context.Context)

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func ResetListJobInfo

func ResetListJobInfo()

ResetListJobInfo exists solely for integration testing

func ResetReceiveJobInfo

func ResetReceiveJobInfo()

ResetReceiveJobInfo exists solely for integration testing

func ResetSendJobInfo

func ResetSendJobInfo()

ResetSendJobInfo exists solely for integration testing