diff options
Diffstat (limited to 'docs/man/borg-version.1')
-rw-r--r-- | docs/man/borg-version.1 | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/man/borg-version.1 b/docs/man/borg-version.1 new file mode 100644 index 000000000..ec096c9b6 --- /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. +. |