Module v1

Support functions to create and read backup archive files.

Structs

Metadata

Describes the Tmux sessions, windows & panes stored in a backup.

Overview

Overview of the archive’s content: number of sessions, windows and panes in the archive.

Constants

FORMAT_VERSION

Version of the archive format.

METADATA_FILENAME

Name of the file storing the metadata in the backup.

PANES_DIR_NAME

Name of the directory storing the panes content in the backup.

VERSION_FILENAME

Name of the file storing the version of the archive format.

Functions

backup_filepath_pattern

Return the pattern for searching the backup files.

create_from_paths

Create a new backup file in dest_filepath with the contents of the metadata file and panes content.

new_backup_filepath

Return the filepath for a new backup.

print_description

Print a full description of the archive, with session and window names.

unpack

Unpack a backup at backup_filepath into dest_dirpath.