mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 01:37:20 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage.rst

171 lines
4.6 KiB
ReStructuredText
Raw Normal View History

More documentation work
2013-07-31 18:51:01 +00:00
.. include:: global.rst.inc
.. _detailed_usage:
Renamed commands.rst to usage.rst
2013-08-04 19:23:12 +00:00
Usage
=====
More documentation work
2013-07-31 18:51:01 +00:00
|project_name| consists of a number of commands. Each command accepts
a number of arguments and options. The following sections will describe each
command in detail.
Quiet by default
----------------
Like most UNIX commands |project_name| is quiet by default but the ``-v`` or
``--verbose`` option can be used to get the program to output more status
messages as it is processing.
.. include:: usage/init.rst.inc
Examples
~~~~~~~~
::
docs: More improvements
2014-04-06 20:47:22 +00:00
# Local repository
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg init /mnt/backup
More documentation work
2013-07-31 18:51:01 +00:00
docs: More improvements
2014-04-06 20:47:22 +00:00
# Remote repository
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg init user@hostname:backup
More documentation work
2013-07-31 18:51:01 +00:00
docs: More improvements
2014-04-06 20:47:22 +00:00
# Encrypted remote repository
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg init --encryption=passphrase user@hostname:backup
More documentation work
2013-07-31 18:51:01 +00:00
.. include:: usage/create.rst.inc
Examples
~~~~~~~~
::
Update prune docs and a few other things in usage.rst.
2014-02-04 01:11:47 +00:00
# Backup ~/Documents into an archive named "my-documents"
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg create /mnt/backup::my-documents ~/Documents
More documentation work
2013-07-31 18:51:01 +00:00
# Backup ~/Documents and ~/src but exclude pyc files
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg create /mnt/backup::my-files \
~/Documents \
~/src \
Update prune docs and a few other things in usage.rst.
2014-02-04 01:11:47 +00:00
--exclude '*.pyc'
More documentation work
2013-07-31 18:51:01 +00:00
# Backup the root filesystem into an archive named "root-YYYY-MM-DD"
NAME="root-`date +%Y-%m-%d`"
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg create /mnt/backup::$NAME / --do-not-cross-mountpoints
More documentation work
2013-07-31 18:51:01 +00:00
.. include:: usage/extract.rst.inc
Examples
~~~~~~~~
::
# Extract entire archive
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg extract /mnt/backup::my-files
More documentation work
2013-07-31 18:51:01 +00:00
# Extract entire archive and list files while processing
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg extract -v /mnt/backup::my-files
More documentation work
2013-07-31 18:51:01 +00:00
# Extract the "src" directory
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg extract /mnt/backup::my-files home/USERNAME/src
More documentation work
2013-07-31 18:51:01 +00:00
# Extract the "src" directory but exclude object files
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg extract /mnt/backup::my-files home/USERNAME/src --exclude '*.o'
More documentation work
2013-07-31 18:51:01 +00:00
Basic repository consistency check functionality. Still no archive metadata validation or repair functionality.
2014-02-04 22:49:10 +00:00
.. include:: usage/check.rst.inc
More documentation work
2013-07-31 18:51:01 +00:00
.. include:: usage/delete.rst.inc
.. include:: usage/list.rst.inc
Examples
~~~~~~~~
::
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg list /mnt/backup
More documentation work
2013-07-31 18:51:01 +00:00
my-files Thu Aug 1 23:33:22 2013
my-documents Thu Aug 1 23:35:43 2013
root-2013-08-01 Thu Aug 1 23:43:55 2013
root-2013-08-02 Fri Aug 2 15:18:17 2013
...
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg list /mnt/backup::root-2013-08-02
More documentation work
2013-07-31 18:51:01 +00:00
drwxr-xr-x root root 0 Jun 05 12:06 .
lrwxrwxrwx root root 0 May 31 20:40 bin -> usr/bin
drwxr-xr-x root root 0 Aug 01 22:08 etc
drwxr-xr-x root root 0 Jul 15 22:07 etc/ImageMagick-6
-rw-r--r-- root root 1383 May 22 22:25 etc/ImageMagick-6/colors.xml
...
.. include:: usage/prune.rst.inc
Examples
~~~~~~~~
::
Update prune documentation to use new command line options, and also to say that the time that matters is the time each backup completes.
2014-02-25 00:32:18 +00:00
# Keep 7 end of day and 4 additional end of week archives:
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4
More documentation work
2013-07-31 18:51:01 +00:00
Update prune documentation to use new command line options, and also to say that the time that matters is the time each backup completes.
2014-02-25 00:32:18 +00:00
# Same as above but only apply to archive names starting with "foo":
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 --prefix=foo
More documentation work
2013-07-31 18:51:01 +00:00
Update prune documentation to use new command line options, and also to say that the time that matters is the time each backup completes.
2014-02-25 00:32:18 +00:00
# Keep 7 end of day, 4 additional end of week archives,
# and an end of month archive for every month:
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 --monthly=-1
Update prune documentation to use new command line options, and also to say that the time that matters is the time each backup completes.
2014-02-25 00:32:18 +00:00
# Keep all backups in the last 10 days, 4 additional end of week archives,
# and an end of month archive for every month:
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg prune /mnt/backup --keep-within=10d --keep-weekly=4 --monthly=-1
Update prune docs and a few other things in usage.rst.
2014-02-04 01:11:47 +00:00
More documentation work
2013-07-31 18:51:01 +00:00
.. include:: usage/info.rst.inc
Examples
~~~~~~~~
::
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg info /mnt/backup::root-2013-08-02
More documentation work
2013-07-31 18:51:01 +00:00
Name: root-2013-08-02
Fingerprint: bc3902e2c79b6d25f5d769b335c5c49331e6537f324d8d3badcb9a0917536dbb
Hostname: myhostname
Username: root
Time: Fri Aug 2 15:18:17 2013
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
Command line: /usr/bin/borg create --stats /mnt/backup::root-2013-08-02 / --do-not-cross-mountpoints
More documentation work
2013-07-31 18:51:01 +00:00
Number of files: 147429
Original size: 5344169493 (4.98 GB)
Compressed size: 1748189642 (1.63 GB)
Unique data: 64805454 (61.80 MB)
.. include:: usage/mount.rst.inc
Examples
~~~~~~~~
::
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg mount /mnt/backup::root-2013-08-02 /tmp/mymountpoint
More documentation work
2013-07-31 18:51:01 +00:00
$ ls /tmp/mymountpoint
bin boot etc lib lib64 mnt opt root sbin srv usr var
$ fusermount -u /tmp/mymountpoint
.. include:: usage/change-passphrase.rst.inc
Examples
~~~~~~~~
::
# Create a key file protected repository
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg init --encryption=keyfile /mnt/backup
Initializing repository at "/mnt/backup"
More documentation work
2013-07-31 18:51:01 +00:00
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
Key file "/home/USER/.borg/keys/mnt_backup" created.
More documentation work
2013-07-31 18:51:01 +00:00
Keep this file safe. Your data will be inaccessible without it.
# Change key file passphrase
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg change-passphrase /mnt/backup
Enter passphrase for key file /home/USER/.borg/keys/mnt_backup:
More documentation work
2013-07-31 18:51:01 +00:00
New passphrase:
Enter same passphrase again:
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
Key file "/home/USER/.borg/keys/mnt_backup" updated
Reference in a new issue Copy permalink