git add docs/man/borg-config.1

docs/man/borg-config.1

@@ -0,0 +1,105 @@
+.\" Man page generated from reStructuredText.
+.
+.TH BORG-CONFIG 1 "2017-12-13" "" "borg backup tool"
+.SH NAME
+borg-config \- get, set, and delete values in a repository or cache config file
+.
+.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 SYNOPSIS
+.sp
+borg [common options] config [options] REPOSITORY NAME [VALUE]
+.SH DESCRIPTION
+.sp
+This command gets and sets options in a local repository or cache config file.
+For security reasons, this command only works on local repositories.
+.sp
+To delete a config value entirely, use \fB\-\-delete\fP\&. To get an existing key, pass
+only the key name. To set a key, pass both the key name and the new value. Keys
+can be specified in the format "section.name" or simply "name"; the section will
+default to "repository" and "cache" for the repo and cache configs, respectively.
+.sp
+By default, borg config manipulates the repository config file. Using \fB\-\-cache\fP
+edits the repository cache\(aqs config file instead.
+.SH OPTIONS
+.sp
+See \fIborg\-common(1)\fP for common options of Borg commands.
+.SS arguments
+.INDENT 0.0
+.TP
+.B REPOSITORY
+repository to configure
+.TP
+.B NAME
+name of config key
+.TP
+.B VALUE
+new value for key
+.UNINDENT
+.SS optional arguments
+.INDENT 0.0
+.TP
+.B \-c\fP,\fB  \-\-cache
+get and set values from the repo cache
+.TP
+.B \-d\fP,\fB  \-\-delete
+delete the key from the config file
+.UNINDENT
+.SH EXAMPLES
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+The repository & cache config files are some of the only directly manipulable
+parts of a repository that aren\(aqt versioned or backed up, so be careful when
+making changes!
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# find cache directory
+$ cd ~/.cache/borg/$(borg config /path/to/repo id)
+
+# reserve some space
+$ borg config /path/to/repo additional_free_space 2G
+
+# make a repo append\-only
+$ borg config /path/to/repo append_only 1
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIborg\-common(1)\fP
+.SH AUTHOR
+The Borg Collective
+.\" Generated by docutils manpage writer.
+.