cmdexport

Documentation

Overview

Package cmdexport implements the "ffs export" subcommand.

Index

• Variables

Variables

var Command = &command.C{
	Name:  "export",
	Usage: "<root-key>[/path/...]\n@<file-key>[/path/...]",
	Help: `
Export a file tree to the local filesystem.

Recursively export the file indicated by the selected root or file storage
key to the path indicated by --to. By default, stat information (permissions,
modification time, etc.) is copied to the output; use --nostat to omit this.
Use --xattr to export extended attributes, if any are stored.`,

	SetFlags: command.Flags(flax.MustBind, &exportFlags),
	Run:      command.Adapt(runExport),

	Commands: []*command.C{{
		Name:  "tar",
		Usage: "<root-key>[/path/...] ...\n@<file-key>[/path/...] ...",
		Help: `
Export file trees to a tar archive.

Recursively export the files indicated by the selected root or file storage keys to
a tar stream. If --to is set, the output is written to that file, which is created
if necessary; otherwise the output is written to stdout. Unless --update is set,
the specified file name must not already exist.

If --compress is true, or if the --to filename ends in ".zst" or ".zstd", the output
is compressed with zstd.`,

		SetFlags: command.Flags(flax.MustBind, &tarFlags),
		Run:      command.Adapt(runTarExport),
	}, {
		Name: "zip",
		Usage: `--to <zipfile> <root-key>[/path/...] ...
--to <zipfile> @<file-key>[/path/...] ...`,
		Help: `
Export file trees to a ZIP archive.

Recursively export the file indicated by the selected root or file storage key
to a ZIP archive in the specified file, which is created if necessary.
Unless --update is set, the specified ZIP file name must not already exist.`,
		SetFlags: command.Flags(flax.MustBind, &zipFlags),
		Run:      command.Adapt(runZipExport),
	}},
}