tlmgr-backup

Make a backup of one or more packages

$ tlmgr backup [package1 package2 ...]

$ tlmgr backup --all

$ tlmgr backup [package] --backupdir [path/to/backup_directory]

$ tlmgr backup clean [package1 package2 ...]

$ tlmgr backup clean --all

tlmgr backup [options]

--backupdir directory
    Specify the directory to store backups. If not specified, a default location within the TeX Live installation is used.

--clean number
    Keep only the last number backups, automatically deleting older ones.

--dry-run
    Simulate the backup process without actually creating any files.

--exclude package1,package2,...
    Exclude the specified packages from the backup.

--include package1,package2,...
    Include the specified packages to the backup.

--list
    List all available backups.

--restore backup_id
    Restore a specific backup identified by its backup_id.

--verify
    Verify the integrity of a backup archive.

--verbose
    Increase verbosity of the output.

The tlmgr-backup command is used to create and restore backups of a TeX Live installation. It allows you to save the current state of your TeX Live installation, including all packages and configuration files. This is useful for various scenarios, such as before making significant changes to your installation, before upgrading to a new version of TeX Live, or for disaster recovery purposes. The command can create a full backup of the entire TeX Live installation or a partial backup containing only specific packages. The restore function can revert your installation to a previous backup.

The process involves creating an archive file containing all necessary files and metadata. During restoration, the archive is extracted, and the TeX Live configuration is updated to reflect the state of the backup. It is important to ensure that the backup archive is stored in a safe location, separate from the TeX Live installation itself, to avoid data loss in case of system failure. Using tlmgr-backup ensures a consistent and reproducible TeX Live environment.

Restoring a backup will overwrite existing files in your TeX Live installation. Backups created with older versions of tlmgr might not be fully compatible with newer versions.

Backup IDs are typically timestamps representing the date and time when the backup was created. They are used to identify specific backups when restoring.

The default location for backups is usually within the TeX Live installation directory, under a dedicated 'backups' folder. However, it is highly recommended to use the '--backupdir' option and store backups in a safe place outside of the TeX Live install directory.

The tlmgr-backup command was introduced as part of the TeX Live Manager (tlmgr) to provide a convenient way to manage and maintain TeX Live installations. It addresses the need for a reliable backup and restore mechanism, allowing users to easily revert to a known working state. Over time, the command has been refined and improved with new features and options to enhance its usability and flexibility.

tlmgr(1)