From bdacc84ceb23f55e3f69c8ed09a6070b626470fb Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 20 Jan 2024 19:16:34 +0100 Subject: [PATCH] build_usage build_man --- docs/man/borg-benchmark-crud.1 | 2 +- docs/man/borg-benchmark.1 | 2 +- docs/man/borg-break-lock.1 | 2 +- docs/man/borg-check.1 | 4 +- docs/man/borg-common.1 | 2 +- docs/man/borg-compact.1 | 4 +- docs/man/borg-compression.1 | 2 +- docs/man/borg-config.1 | 4 +- docs/man/borg-create.1 | 4 +- docs/man/borg-delete.1 | 4 +- docs/man/borg-diff.1 | 4 +- docs/man/borg-export-tar.1 | 4 +- docs/man/borg-extract.1 | 4 +- docs/man/borg-import-tar.1 | 4 +- docs/man/borg-info.1 | 4 +- docs/man/borg-init.1 | 4 +- docs/man/borg-key-change-passphrase.1 | 2 +- docs/man/borg-key-export.1 | 4 +- docs/man/borg-key-import.1 | 4 +- docs/man/borg-key-migrate-to-repokey.1 | 2 +- docs/man/borg-key.1 | 2 +- docs/man/borg-list.1 | 4 +- docs/man/borg-mount.1 | 4 +- docs/man/borg-patterns.1 | 2 +- docs/man/borg-placeholders.1 | 2 +- docs/man/borg-prune.1 | 4 +- docs/man/borg-recreate.1 | 4 +- docs/man/borg-rename.1 | 2 +- docs/man/borg-serve.1 | 4 +- docs/man/borg-umount.1 | 2 +- docs/man/borg-upgrade.1 | 4 +- docs/man/borg-version.1 | 83 ++++++++++++++++++++++++++ docs/man/borg-with-lock.1 | 14 ++++- docs/man/borg.1 | 2 +- docs/man/borgfs.1 | 4 +- docs/usage.rst | 1 + docs/usage/check.rst.inc | 4 +- docs/usage/compact.rst.inc | 4 +- docs/usage/config.rst.inc | 4 +- docs/usage/create.rst.inc | 4 +- docs/usage/delete.rst.inc | 4 +- docs/usage/diff.rst.inc | 4 +- docs/usage/export-tar.rst.inc | 4 +- docs/usage/extract.rst.inc | 4 +- docs/usage/import-tar.rst.inc | 4 +- docs/usage/info.rst.inc | 4 +- docs/usage/init.rst.inc | 4 +- docs/usage/key_export.rst.inc | 4 +- docs/usage/key_import.rst.inc | 4 +- docs/usage/list.rst.inc | 4 +- docs/usage/mount.rst.inc | 4 +- docs/usage/prune.rst.inc | 4 +- docs/usage/recreate.rst.inc | 4 +- docs/usage/serve.rst.inc | 4 +- docs/usage/upgrade.rst.inc | 4 +- docs/usage/version.rst | 1 + docs/usage/version.rst.inc | 66 ++++++++++++++++++++ docs/usage/with-lock.rst.inc | 6 +- 58 files changed, 259 insertions(+), 94 deletions(-) create mode 100644 docs/man/borg-version.1 create mode 100644 docs/usage/version.rst create mode 100644 docs/usage/version.rst.inc diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index c759041907..c56ea713be 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK-CRUD" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. .SH SYNOPSIS diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index bd32f25a42..51c11fdd84 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command .SH SYNOPSIS diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index bdcae0ee48..e6b45ec36f 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BREAK-LOCK" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. .SH SYNOPSIS diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index c3046647d2..7e8ede0533 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CHECK" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -161,7 +161,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to check consistency of .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-repository\-only diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index ed88eedcd4..f4510502fe 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMMON" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands .SH SYNOPSIS diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index c3f28e31ba..d07e006347 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPACT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository .SH SYNOPSIS @@ -66,7 +66,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to compact .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-cleanup\-commits diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index b6f0775135..2aa7c4d95c 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPRESSION" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression .SH DESCRIPTION diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index 07eaf43d2e..381e240e35 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CONFIG" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file .SH SYNOPSIS @@ -62,7 +62,7 @@ name of config key .B VALUE new value for key .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-c\fP,\fB \-\-cache diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 709f18bbce..53cb8ae7b2 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CREATE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-create \- Create new archive .SH SYNOPSIS @@ -132,7 +132,7 @@ name of archive to create (must be also a valid directory name) .B PATH paths to archive .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 7beddb85ea..c456fa93d5 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DELETE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives .SH SYNOPSIS @@ -71,7 +71,7 @@ repository or archive to delete .B ARCHIVE archives to delete .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 22b036f750..136497c2a7 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DIFF" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -66,7 +66,7 @@ ARCHIVE2 name (no repository location allowed) .B PATH paths of items inside the archives to compare; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-numeric\-owner diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 65fbb72731..6aa2a119af 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXPORT-TAR" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -91,7 +91,7 @@ output tar file. \(dq\-\(dq to write to stdout instead. .B PATH paths to extract; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-tar\-filter diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index b698d11f9d..71e9f894fb 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXTRACT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents .SH SYNOPSIS @@ -72,7 +72,7 @@ archive to extract .B PATH paths to extract; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-list diff --git a/docs/man/borg-import-tar.1 b/docs/man/borg-import-tar.1 index b1b1e2c8f2..b720b203df 100644 --- a/docs/man/borg-import-tar.1 +++ b/docs/man/borg-import-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-IMPORT-TAR" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS @@ -86,7 +86,7 @@ name of archive to create (must be also a valid directory name) .B TARFILE input tar file. \(dq\-\(dq to read from stdin instead. .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-tar\-filter diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index cd8bf1ab65..0d40cabc18 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INFO" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-INFO" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used .SH SYNOPSIS @@ -59,7 +59,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to display information about .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-json diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index 36136889c9..6c671ace3d 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INIT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-INIT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository .SH SYNOPSIS @@ -225,7 +225,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to create .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index 0d9a9d086e..e19f4c1f69 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase .SH SYNOPSIS diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 7a883133c1..5c6b7701d1 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-EXPORT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-KEY-EXPORT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup .SH SYNOPSIS @@ -85,7 +85,7 @@ REPOSITORY .B PATH where to store the backup .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-paper diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index a131106794..7a35f58ac7 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-IMPORT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-KEY-IMPORT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup .SH SYNOPSIS @@ -60,7 +60,7 @@ REPOSITORY .B PATH path to the backup (\(aq\-\(aq to read from stdin) .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-paper diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 525e69dc02..3f1238dc73 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey .SH SYNOPSIS diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index 8a3f4437e6..b474931406 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-KEY" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository .SH SYNOPSIS diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index bb34c0d22f..efc8d4fc34 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-LIST" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-LIST" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents .SH SYNOPSIS @@ -50,7 +50,7 @@ repository or archive to list contents of .B PATH paths to list; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-consider\-checkpoints diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index 4c03000c19..b59fb273bd 100644 --- a/docs/man/borg-mount.1 +++ b/docs/man/borg-mount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-MOUNT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-MOUNT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -107,7 +107,7 @@ where to mount filesystem .B PATH paths to extract; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-consider\-checkpoints diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index a19ea8ad5b..6ecf485655 100644 --- a/docs/man/borg-patterns.1 +++ b/docs/man/borg-patterns.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PATTERNS" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-PATTERNS" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns .SH DESCRIPTION diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index ffaa17e251..5f33e41c6b 100644 --- a/docs/man/borg-placeholders.1 +++ b/docs/man/borg-placeholders.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PLACEHOLDERS" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-PLACEHOLDERS" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-placeholders \- Details regarding placeholders .SH DESCRIPTION diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index d1029428e1..76874a875c 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PRUNE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-PRUNE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules .SH SYNOPSIS @@ -97,7 +97,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to prune .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index 24e12eda10..33be2038c5 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RECREATE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-RECREATE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives .SH SYNOPSIS @@ -97,7 +97,7 @@ repository or archive to recreate .B PATH paths to recreate; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-\-list diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index 8bc6ba5000..47951be896 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RENAME" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-RENAME" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-rename \- Rename an existing archive .SH SYNOPSIS diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1 index b3a6f82f72..9297635712 100644 --- a/docs/man/borg-serve.1 +++ b/docs/man/borg-serve.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-SERVE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-SERVE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-serve \- Start in server mode. This command is usually not used manually. .SH SYNOPSIS @@ -39,7 +39,7 @@ This command starts a repository server process. This command is usually not use .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. -.SS optional arguments +.SS options .INDENT 0.0 .TP .BI \-\-restrict\-to\-path \ PATH diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1 index 6451ee779c..d0a0699402 100644 --- a/docs/man/borg-umount.1 +++ b/docs/man/borg-umount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UMOUNT" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-UMOUNT" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-umount \- un-mount the FUSE filesystem .SH SYNOPSIS diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1 index 1c20c656e7..570e2e7e12 100644 --- a/docs/man/borg-upgrade.1 +++ b/docs/man/borg-upgrade.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UPGRADE" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-UPGRADE" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-upgrade \- upgrade a repository from a previous version .SH SYNOPSIS @@ -148,7 +148,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY path to the repository to be upgraded .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-version.1 b/docs/man/borg-version.1 new file mode 100644 index 0000000000..ec096c9b60 --- /dev/null +++ b/docs/man/borg-version.1 @@ -0,0 +1,83 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BORG-VERSION" 1 "2024-01-20" "" "borg backup tool" +.SH NAME +borg-version \- Display the borg client / borg server version +.SH SYNOPSIS +.sp +borg [common options] version [options] [REPOSITORY] +.SH DESCRIPTION +.sp +This command displays the borg client version / borg server version. +.sp +If a local repo is given, the client code directly accesses the repository, +thus we show the client version also as the server version. +.sp +If a remote repo is given (e.g. ssh:), the remote borg is queried and +its version is displayed as the server version. +.sp +Examples: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# local repo (client uses 1.4.0 alpha version) +$ borg version /mnt/backup +1.4.0a / 1.4.0a + +# remote repo (client uses 1.4.0 alpha, server uses 1.2.7 release) +$ borg version ssh://borg@borgbackup:repo +1.4.0a / 1.2.7 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Due to the version tuple format used in borg client/server negotiation, only +a simplified version is displayed (as provided by borg.version.format_version). +.sp +There is also borg \-\-version to display a potentially more precise client version. +.SH OPTIONS +.sp +See \fIborg\-common(1)\fP for common options of Borg commands. +.SS arguments +.INDENT 0.0 +.TP +.B REPOSITORY +repository (used to determine client/server situation) +.UNINDENT +.SH SEE ALSO +.sp +\fIborg\-common(1)\fP +.SH AUTHOR +The Borg Collective +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1 index 47ec228ee3..e0c074eae2 100644 --- a/docs/man/borg-with-lock.1 +++ b/docs/man/borg-with-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-WITH-LOCK" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG-WITH-LOCK" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg-with-lock \- run a user specified command with the repository lock held .SH SYNOPSIS @@ -35,7 +35,17 @@ borg-with-lock \- run a user specified command with the repository lock held borg [common options] with\-lock [options] REPOSITORY COMMAND [ARGS...] .SH DESCRIPTION .sp -This command runs a user\-specified command while the repository lock is held. +This command runs a user\-specified command while locking the repository. For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ borg with\-lock /mnt/borgrepo rsync \-av /mnt/borgrepo /somewhere/else/borgrepo +.ft P +.fi +.UNINDENT +.UNINDENT .sp It will first try to acquire the lock (make sure that no other operation is running in the repo), then execute the given command as a subprocess and wait diff --git a/docs/man/borg.1 b/docs/man/borg.1 index f6c7c4e2de..0fb420b40a 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG" 1 "2024-01-01" "" "borg backup tool" +.TH "BORG" 1 "2024-01-20" "" "borg backup tool" .SH NAME borg \- deduplicating and encrypting backup tool .SH SYNOPSIS diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 1e40a357fc..6a60b03f07 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORGFS" 1 "2024-01-01" "" "borg backup tool" +.TH "BORGFS" 1 "2024-01-20" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -107,7 +107,7 @@ where to mount filesystem .B PATH paths to extract; patterns are supported .UNINDENT -.SS optional arguments +.SS options .INDENT 0.0 .TP .B \-V\fP,\fB \-\-version diff --git a/docs/usage.rst b/docs/usage.rst index f6e0113eee..ad63cb7e47 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -47,6 +47,7 @@ Usage usage/prune usage/compact usage/info + usage/version usage/mount usage/key usage/upgrade diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index 47bf1f7ce1..cfa72d057f 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -17,7 +17,7 @@ borg check +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to check consistency of | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--repository-only`` | only perform repository checks | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ borg check repository or archive to check consistency of - optional arguments + options --repository-only only perform repository checks --archives-only only perform archives checks --verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) diff --git a/docs/usage/compact.rst.inc b/docs/usage/compact.rst.inc index 8187bbf7f1..514dbf575b 100644 --- a/docs/usage/compact.rst.inc +++ b/docs/usage/compact.rst.inc @@ -17,7 +17,7 @@ borg compact +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ | | ``REPOSITORY`` | repository to compact | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ | | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ @@ -42,7 +42,7 @@ borg compact repository to compact - optional arguments + options --cleanup-commits cleanup commit-only 17-byte segment files --threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10) diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc index d90c327ee7..fdb44bf834 100644 --- a/docs/usage/config.rst.inc +++ b/docs/usage/config.rst.inc @@ -21,7 +21,7 @@ borg config +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``VALUE`` | new value for key | +-------------------------------------------------------+----------------------+----------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``-c``, ``--cache`` | get and set values from the repo cache | +-------------------------------------------------------+----------------------+----------------------------------------+ @@ -52,7 +52,7 @@ borg config new value for key - optional arguments + options -c, --cache get and set values from the repo cache -d, --delete delete the key from the config file -l, --list list the configuration of the repo diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index ff9cd2b2f2..3059d4a8fa 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -19,7 +19,7 @@ borg create +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to archive | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not create a backup archive | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,7 +130,7 @@ borg create paths to archive - optional arguments + options -n, --dry-run do not create a backup archive -s, --stats print statistics for the created archive --list output verbose list of items (files, dirs, ...) diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 77246644fc..46a21fa6aa 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -19,7 +19,7 @@ borg delete +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``ARCHIVE`` | archives to delete | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,7 @@ borg delete archives to delete - optional arguments + options -n, --dry-run do not change repository --list output verbose list of archives -s, --stats print statistics for the deleted archive diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index 914d46a06a..4bad260bb8 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -21,7 +21,7 @@ borg diff +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``PATH`` | paths of items inside the archives to compare; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ @@ -68,7 +68,7 @@ borg diff paths of items inside the archives to compare; patterns are supported - optional arguments + options --numeric-owner deprecated, use ``--numeric-ids`` instead --numeric-ids only consider numeric user and group identifiers --same-chunker-params Override check of chunker parameters. diff --git a/docs/usage/export-tar.rst.inc b/docs/usage/export-tar.rst.inc index 46334880a9..cabfec740f 100644 --- a/docs/usage/export-tar.rst.inc +++ b/docs/usage/export-tar.rst.inc @@ -21,7 +21,7 @@ borg export-tar +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ borg export-tar paths to extract; patterns are supported - optional arguments + options --tar-filter filter program to pipe data through --list output verbose list of items (files, dirs, ...) diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index b233a846b0..c928209f9d 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -19,7 +19,7 @@ borg extract +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -74,7 +74,7 @@ borg extract paths to extract; patterns are supported - optional arguments + options --list output verbose list of items (files, dirs, ...) -n, --dry-run do not actually change any files --numeric-owner deprecated, use ``--numeric-ids`` instead diff --git a/docs/usage/import-tar.rst.inc b/docs/usage/import-tar.rst.inc index 033ea16141..0749627cd6 100644 --- a/docs/usage/import-tar.rst.inc +++ b/docs/usage/import-tar.rst.inc @@ -19,7 +19,7 @@ borg import-tar +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | | ``TARFILE`` | input tar file. "-" to read from stdin instead. | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,7 +66,7 @@ borg import-tar input tar file. "-" to read from stdin instead. - optional arguments + options --tar-filter filter program to pipe data through -s, --stats print statistics for the created archive --list output verbose list of items (files, dirs, ...) diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index d77e485a02..d53ecf3cce 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -17,7 +17,7 @@ borg info +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to display information about | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--json`` | format output as JSON | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -52,7 +52,7 @@ borg info repository or archive to display information about - optional arguments + options --json format output as JSON diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 52102fa0a2..265a491a2b 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -17,7 +17,7 @@ borg init +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY`` | repository to create | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-e MODE``, ``--encryption MODE`` | select encryption key mode **(required)** | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,7 +46,7 @@ borg init repository to create - optional arguments + options -e MODE, --encryption MODE select encryption key mode **(required)** --append-only create an append-only mode repository. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. --storage-quota QUOTA Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 0a57bf0916..319d8b8d85 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -19,7 +19,7 @@ borg key export +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ | | ``PATH`` | where to store the backup | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ | | ``--paper`` | Create an export suitable for printing and later type-in | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ @@ -46,7 +46,7 @@ borg key export where to store the backup - optional arguments + options --paper Create an export suitable for printing and later type-in --qr-html Create an html file suitable for printing and later type-in or qr scan diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index a0890ff38a..19afbe5371 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -19,7 +19,7 @@ borg key import +-------------------------------------------------------+----------------+----------------------------------------------------------+ | | ``PATH`` | path to the backup ('-' to read from stdin) | +-------------------------------------------------------+----------------+----------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+----------------+----------------------------------------------------------+ | | ``--paper`` | interactively import from a backup done with ``--paper`` | +-------------------------------------------------------+----------------+----------------------------------------------------------+ @@ -44,7 +44,7 @@ borg key import path to the backup ('-' to read from stdin) - optional arguments + options --paper interactively import from a backup done with ``--paper`` diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index f48a7f5150..d44d9d5508 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -19,7 +19,7 @@ borg list +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to list; patterns are supported | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -74,7 +74,7 @@ borg list paths to list; patterns are supported - optional arguments + options --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). --short only print file/directory names, nothing else --format FORMAT specify format for file or archive listing (default for files: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}"; for archives: "{archive:<36} {time} [{id}]{NL}") diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 251f56cfe2..89767a6764 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -21,7 +21,7 @@ borg mount +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -80,7 +80,7 @@ borg mount paths to extract; patterns are supported - optional arguments + options --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). -f, --foreground stay in foreground, do not daemonize -o Extra mount options diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index c57677bf7a..6856cde005 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -17,7 +17,7 @@ borg prune +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY`` | repository to prune | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ borg prune repository to prune - optional arguments + options -n, --dry-run do not change repository --force force pruning of corrupted archives, use ``--force --force`` in case ``--force`` does not work. -s, --stats print statistics for the deleted archive diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index d9c1302ee7..22a6dc9080 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -19,7 +19,7 @@ borg recreate +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to recreate; patterns are supported | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,7 +82,7 @@ borg recreate paths to recreate; patterns are supported - optional arguments + options --list output verbose list of items (files, dirs, ...) --filter STATUSCHARS only display items with the given status characters (listed in borg create --help) -n, --dry-run do not change anything diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 1c93098c17..e40692b5a5 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -13,7 +13,7 @@ borg serve .. class:: borg-options-table +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--restrict-to-path PATH`` | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository. | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ borg serve - optional arguments + options --restrict-to-path PATH restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository. --restrict-to-repository PATH restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path`` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. --append-only only allow appending to repository segment files. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index f289982bf9..de69643851 100644 --- a/docs/usage/upgrade.rst.inc +++ b/docs/usage/upgrade.rst.inc @@ -17,7 +17,7 @@ borg upgrade +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ | | ``REPOSITORY`` | path to the repository to be upgraded | +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ borg upgrade path to the repository to be upgraded - optional arguments + options -n, --dry-run do not change repository --inplace rewrite repository in place, with no chance of going back to older versions of the repository. --force Force upgrade diff --git a/docs/usage/version.rst b/docs/usage/version.rst new file mode 100644 index 0000000000..204afdbb76 --- /dev/null +++ b/docs/usage/version.rst @@ -0,0 +1 @@ +.. include:: version.rst.inc diff --git a/docs/usage/version.rst.inc b/docs/usage/version.rst.inc new file mode 100644 index 0000000000..aecce6760f --- /dev/null +++ b/docs/usage/version.rst.inc @@ -0,0 +1,66 @@ +.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! + +.. _borg_version: + +borg version +------------ +.. code-block:: none + + borg [common options] version [options] [REPOSITORY] + +.. only:: html + + .. class:: borg-options-table + + +-------------------------------------------------------+----------------+--------------------------------------------------------+ + | **positional arguments** | + +-------------------------------------------------------+----------------+--------------------------------------------------------+ + | | ``REPOSITORY`` | repository (used to determine client/server situation) | + +-------------------------------------------------------+----------------+--------------------------------------------------------+ + | .. class:: borg-common-opt-ref | + | | + | :ref:`common_options` | + +-------------------------------------------------------+----------------+--------------------------------------------------------+ + + .. raw:: html + + + +.. only:: latex + + REPOSITORY + repository (used to determine client/server situation) + + + :ref:`common_options` + | + +Description +~~~~~~~~~~~ + +This command displays the borg client version / borg server version. + +If a local repo is given, the client code directly accesses the repository, +thus we show the client version also as the server version. + +If a remote repo is given (e.g. ssh:), the remote borg is queried and +its version is displayed as the server version. + +Examples:: + + # local repo (client uses 1.4.0 alpha version) + $ borg version /mnt/backup + 1.4.0a / 1.4.0a + + # remote repo (client uses 1.4.0 alpha, server uses 1.2.7 release) + $ borg version ssh://borg@borgbackup:repo + 1.4.0a / 1.2.7 + +Due to the version tuple format used in borg client/server negotiation, only +a simplified version is displayed (as provided by borg.version.format_version). + +There is also borg --version to display a potentially more precise client version. \ No newline at end of file diff --git a/docs/usage/with-lock.rst.inc b/docs/usage/with-lock.rst.inc index 6f4fc741af..e10f38ec85 100644 --- a/docs/usage/with-lock.rst.inc +++ b/docs/usage/with-lock.rst.inc @@ -50,7 +50,11 @@ borg with-lock Description ~~~~~~~~~~~ -This command runs a user-specified command while the repository lock is held. +This command runs a user-specified command while locking the repository. For example: + +:: + + $ borg with-lock /mnt/borgrepo rsync -av /mnt/borgrepo /somewhere/else/borgrepo It will first try to acquire the lock (make sure that no other operation is running in the repo), then execute the given command as a subprocess and wait