Forrest logo
back to the borg tool

borg:tldr:e43ad

borg: Display help on creating archives.
$ borg create --help
try on your machine

The "borg create --help" command is used to display the help documentation and usage instructions for the "borg create" command in the Borg Backup software.

Borg Backup is an open-source deduplicating backup program that creates efficient and secure backups of files and directories. The "create" command is one of the primary commands in Borg Backup, used to create new backups.

When you run "borg create --help" command, it will display information about the usage, options, and arguments of the "borg create" command. This includes:

  • Basic usage: It will show the syntax of the command, explaining how to use it properly.
  • Options: It will provide a list of available options that can be used with the "borg create" command. These options modify the behavior of the command and allow you to customize the backup process.
  • Arguments: It will explain the required and optional arguments that need to be provided with the command. For example, the source directory or file(s) to be backed up, and the destination repository where the backup will be stored.
  • Detailed descriptions: It will provide additional information and explanations for each option and argument, helping you understand their purpose and usage.

By using "borg create --help", you can understand how to use the "borg create" command effectively and take advantage of its various options to create and manage backups using Borg Backup.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the borg tool