borgbackup/docs/man/borg-version.1

82 lines
2.1 KiB
Groff
Raw Normal View History

2026-03-18 18:55:22 -04:00
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
2024-01-20 13:16:34 -05:00
.
.
.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
..
2026-06-25 12:39:27 -04:00
.TH "borg-version" "1" "2026-06-25" "" "borg backup tool"
2026-03-18 18:55:22 -04:00
.SH Name
2024-01-20 13:16:34 -05:00
borg-version \- Display the borg client / borg server version
.SH SYNOPSIS
.sp
borg [common options] version [options] [REPOSITORY]
.SH DESCRIPTION
.sp
2025-10-31 14:12:42 -04:00
This command displays the Borg client version / Borg server version.
2024-01-20 13:16:34 -05:00
.sp
2025-10-31 14:12:42 -04:00
If a local repository is given, the client code directly accesses the repository,
2024-01-20 13:16:34 -05:00
thus we show the client version also as the server version.
.sp
2025-10-31 14:12:42 -04:00
If a remote repository is given (e.g., ssh:), the remote Borg is queried and
2024-01-20 13:16:34 -05:00
its version is displayed as the server version.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
2025-04-18 12:26:48 -04:00
.EX
2024-01-20 13:16:34 -05:00
# 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
2025-04-18 12:26:48 -04:00
.EE
2024-01-20 13:16:34 -05:00
.UNINDENT
.UNINDENT
.sp
2025-10-31 14:12:42 -04:00
Due to the version tuple format used in Borg client/server negotiation, only
a simplified version is displayed (as provided by \fBborg.version.format_version\fP).
2024-01-20 13:16:34 -05:00
.sp
2025-10-31 14:12:42 -04:00
There is also \fBborg \-\-version\fP to display a potentially more precise client version.
2024-01-20 13:16:34 -05:00
.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
2026-03-18 18:55:22 -04:00
.SH Author
2024-01-20 13:16:34 -05:00
The Borg Collective
2026-03-18 18:55:22 -04:00
.\" End of generated man page.