2017-02-05 13:22:06 +00:00
|
|
|
.\" 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
|
|
|
|
|
..
|
2023-09-14 13:52:08 +00:00
|
|
|
.TH "BORG-COMMON" 1 "2023-09-14" "" "borg backup tool"
|
2022-06-23 23:19:19 +00:00
|
|
|
.SH NAME
|
|
|
|
|
borg-common \- Common options of Borg commands
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-h\fP,\fB \-\-help
|
2017-02-05 13:22:06 +00:00
|
|
|
show this help message and exit
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-critical
|
2017-02-05 13:22:06 +00:00
|
|
|
work on log level CRITICAL
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-error
|
2017-02-05 13:22:06 +00:00
|
|
|
work on log level ERROR
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-warning
|
2017-02-05 13:22:06 +00:00
|
|
|
work on log level WARNING (default)
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose
|
2017-02-05 13:22:06 +00:00
|
|
|
work on log level INFO
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-debug
|
2017-02-05 13:22:06 +00:00
|
|
|
enable debug output, work on log level DEBUG
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-debug\-topic \ TOPIC
|
|
|
|
|
enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-p\fP,\fB \-\-progress
|
2017-05-17 09:52:48 +00:00
|
|
|
show progress information
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-iec
|
2021-05-11 20:33:28 +00:00
|
|
|
format using IEC units (1KiB = 1024B)
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-log\-json
|
2017-03-26 23:58:19 +00:00
|
|
|
Output one JSON object per log line instead of formatted text.
|
|
|
|
|
.TP
|
2017-11-25 13:38:04 +00:00
|
|
|
.BI \-\-lock\-wait \ SECONDS
|
|
|
|
|
wait at most SECONDS for acquiring a repository/cache lock (default: 1).
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-bypass\-lock
|
2020-04-12 17:55:57 +00:00
|
|
|
Bypass locking mechanism
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-show\-version
|
2017-02-05 13:22:06 +00:00
|
|
|
show/log the borg version
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-show\-rc
|
2017-02-05 13:22:06 +00:00
|
|
|
show/log the return code (rc)
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-umask \ M
|
2020-10-04 18:33:08 +00:00
|
|
|
set umask to M (local only, default: 0077)
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-remote\-path \ PATH
|
2022-09-10 14:03:27 +00:00
|
|
|
use PATH as borg executable on the remote (default: \(dqborg\(dq)
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
2021-05-11 20:33:28 +00:00
|
|
|
.BI \-\-upload\-ratelimit \ RATE
|
|
|
|
|
set network upload rate limit in kiByte/s (default: 0=unlimited)
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
2021-05-11 20:33:28 +00:00
|
|
|
.BI \-\-upload\-buffer \ UPLOAD_BUFFER
|
|
|
|
|
set network upload buffer size in MiB. (default: 0=no buffer)
|
2021-02-06 00:32:54 +00:00
|
|
|
.TP
|
2017-05-17 09:52:48 +00:00
|
|
|
.BI \-\-debug\-profile \ FILE
|
2022-09-10 14:03:27 +00:00
|
|
|
Write execution profile in Borg format into FILE. For local use a Python\-compatible file can be generated by suffixing FILE with \(dq.pyprof\(dq.
|
2019-02-24 19:40:07 +00:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-rsh \ RSH
|
|
|
|
|
Use this command to connect to the \(aqborg serve\(aq process (default: \(aqssh\(aq)
|
2022-06-23 23:19:19 +00:00
|
|
|
.TP
|
2023-06-11 21:10:23 +00:00
|
|
|
.BI \-\-socket \ PATH
|
|
|
|
|
Use UNIX DOMAIN (IPC) socket at PATH for client/server communication with socket: protocol.
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.BI \-r \ REPO\fR,\fB \ \-\-repo \ REPO
|
|
|
|
|
repository to use
|
2017-02-05 13:22:06 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIborg\-common(1)\fP
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
The Borg Collective
|
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
