mirror of
https://github.com/borgbackup/borg.git
synced 2026-02-03 20:40:16 -05:00
76 lines
1.9 KiB
Groff
76 lines
1.9 KiB
Groff
.\" 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-COMPLETION" "1" "2025-12-23" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-completion \- Output shell completion script for the given shell.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] completion [options] SHELL
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command prints a shell completion script for the given shell.
|
|
.sp
|
|
Please note that for some dynamic completions (like archive IDs), the shell
|
|
completion script will call borg to query the repository. This will work best
|
|
if that call can be made without prompting for user input, so you may want to
|
|
set BORG_REPO and BORG_PASSPHRASE environment variables.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B SHELL
|
|
shell to generate completion for (one of: %(choices)s)
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.sp
|
|
To activate completion in your current shell session, evaluate the output
|
|
of this command. To enable it persistently, add the corresponding line to
|
|
your shell\(aqs startup file.
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
# Bash (in ~/.bashrc)
|
|
eval \(dq$(borg completion bash)\(dq
|
|
|
|
# Zsh (in ~/.zshrc)
|
|
eval \(dq$(borg completion zsh)\(dq
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|