borg/docs/man/borg-placeholders.1

.\" Man page generated from reStructuredText.
.
.TH BORG-PLACEHOLDERS 1 "2017-02-11" "" "borg backup tool"
.SH NAME
borg-placeholders \- Details regarding placeholders
.
.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
..
.SH DESCRIPTION
.sp
Repository (or Archive) URLs, \-\-prefix and \-\-remote\-path values support these
placeholders:
.sp
{hostname}
.INDENT 0.0
.INDENT 3.5
The (short) hostname of the machine.
.UNINDENT
.UNINDENT
.sp
{fqdn}
.INDENT 0.0
.INDENT 3.5
The full name of the machine.
.UNINDENT
.UNINDENT
.sp
{now}
.INDENT 0.0
.INDENT 3.5
The current local date and time, by default in ISO\-8601 format.
You can also supply your own \fI\%format string\fP, e.g. {now:%Y\-%m\-%d_%H:%M:%S}
.UNINDENT
.UNINDENT
.sp
{utcnow}
.INDENT 0.0
.INDENT 3.5
The current UTC date and time, by default in ISO\-8601 format.
You can also supply your own \fI\%format string\fP, e.g. {utcnow:%Y\-%m\-%d_%H:%M:%S}
.UNINDENT
.UNINDENT
.sp
{user}
.INDENT 0.0
.INDENT 3.5
The user name (or UID, if no name is available) of the user running borg.
.UNINDENT
.UNINDENT
.sp
{pid}
.INDENT 0.0
.INDENT 3.5
The current process ID.
.UNINDENT
.UNINDENT
.sp
{borgversion}
.INDENT 0.0
.INDENT 3.5
The version of borg, e.g.: 1.0.8rc1
.UNINDENT
.UNINDENT
.sp
{borgmajor}
.INDENT 0.0
.INDENT 3.5
The version of borg, only the major version, e.g.: 1
.UNINDENT
.UNINDENT
.sp
{borgminor}
.INDENT 0.0
.INDENT 3.5
The version of borg, only major and minor version, e.g.: 1.0
.UNINDENT
.UNINDENT
.sp
{borgpatch}
.INDENT 0.0
.INDENT 3.5
The version of borg, only major, minor and patch version, e.g.: 1.0.8
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
borg create /path/to/repo::{hostname}\-{user}\-{utcnow} ...
borg create /path/to/repo::{hostname}\-{now:%Y\-%m\-%d_%H:%M:%S} ...
borg prune \-\-prefix \(aq{hostname}\-\(aq ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
The Borg Collective
.\" Generated by docutils manpage writer.
.