Commit Graph

31 Commits

Author SHA1 Message Date
Sitaram Chamarty bbc3f8d6fd add a sample logging.conf in docs/misc (#4380)
add a sample logging.conf in docs/misc

(and point to it in the man page)
2019-03-19 18:22:32 +01:00
Manuel Riel e99448cc7b Add --rsh command line option to complement BORG_RSH env var. Fixes #… (#4290)
Add --rsh command line option to complement BORG_RSH env var. Fixes #1701
(cherry picked from commit 9ab0a095ab)
2019-02-01 11:21:50 +01:00
Manu 8b9f5f6de1 Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249 2019-01-31 22:37:54 +08:00
Łukasz Stelmach 82e37fbd03 read a passphrase from a file descriptor
Read a passpharase from a file descriptor specified in the
BORG_PASSPHRASE_FD environment variable.
2018-09-22 11:33:23 +02:00
newtonne f2f9838201 Remove row/column-spanning from docs source, fixes #4000
Sphinx doesn't support row or column-spanning, which caused the content
of the additional features table to be incorrect. To fix this, we now
define the content of each cell explicitly.

This change also fixes #3990.

(cherry picked from commit 11a2f1f684)
2018-08-11 10:58:30 +01:00
Thomas Waldmann 901e3a7888 add BORG_HOST_ID, fixes #3985
(cherry picked from commit 90348c1de9)
2018-08-09 08:11:05 +02:00
lumbric 4f30330f40 docs: add link to tempfile module
Linking tempfile docs helps to figure out, which default value might be
used, if TMPDIR is not set.

(cherry picked from commit bbd1533c99)
2018-06-26 12:56:06 +05:30
André-Patrick Bubel dd5e0b913d docs: describe what BORG_LIBZSTD_PREFIX does
(cherry picked from commit 1ba0e85621)
2018-05-18 17:45:51 +02:00
Thomas Waldmann 5da50f2440 minor docs formatting fix 2018-03-30 00:47:44 +02:00
Thomas Waldmann 64aaec6628 BORG_SHOW_SYSINFO=no to hide system information from exceptions
Can be used:
- in case of troubles with the sysinfo code
- by borg backup providers who do not want to show system information
2018-03-29 23:45:01 +02:00
Thomas Waldmann 30db004de6 docs: improve logging docs, fixes #3549
(cherry picked from commit 99be106bc8)
2018-03-17 21:21:55 +01:00
Rémi Oudin fe807046b4 Better formatting of CPU usage documentation
This is now displayed as a list, with bold fonts for each bullet.
Refers https://github.com/borgbackup/borg/issues/3554
2018-03-01 23:20:02 +00:00
Thomas Waldmann 28baa78595 added BORG_BASE_DIR, s/get_home_dir/get_base_dir/g, docs, fixes #3338
also: sorted env var docs by level
(cherry picked from commit c5a339384e)
2017-12-23 18:09:16 +01:00
Thomas Waldmann 83603acd48 rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX
consistency:
we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX.

(cherry picked from commit 9b6924d27f)
2017-12-18 02:42:03 +01:00
Thomas Waldmann b175f1fdf1 docs: document birthtime support on platforms supporting it
stat.st_birthtime, MacOS and (some?) BSDs.

(cherry picked from commit a107233f75)
2017-11-26 04:04:01 +01:00
Thomas Waldmann 21afd17f2f docs: document good and problematic option placements, see #3356
(cherry picked from commit e3cb7c3c32)
2017-11-26 04:03:42 +01:00
narendravardi 00152e8a61 Added documentation for BORG_CONFIG_DIR
(cherry picked from commit 764a62f42c)
2017-11-03 18:39:15 +01:00
Marian Beermann b3e0dd3761 docs: file system requirements, update segs per dir 2017-07-23 16:03:45 +02:00
Marian Beermann cc93cbb202 docs: usage; remove strange blurb about tested platforms 2017-07-21 12:32:30 +02:00
Marian Beermann 735339c209 docs: streamline installation: platforms table 2017-07-21 12:32:30 +02:00
Marian Beermann 3d5a8016e6 docs: streamline installation: file systems 2017-07-21 12:32:30 +02:00
Marian Beermann 0288fff6b7 docs: explain formatting 2017-06-17 14:29:56 +02:00
Marian Beermann 5aa865c8d8 docs: double backticks for --options 2017-06-17 12:27:53 +02:00
Andrea Gelmini e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
TuXicc 578b76af3a Added BORG_PASSCOMMAND environment variable (#2573) 2017-05-31 19:25:21 +02:00
Marian Beermann e036ebc340 docs: installation: pre-install considerations, fix crossrefs
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
2017-04-28 10:40:21 +02:00
Marian Beermann bb6b4fde93 BORG_HOSTNAME_IS_UNIQUE=yes by default. 2017-04-01 21:28:41 +02:00
Marian Beermann e98b5b20df yes(): handle JSON output 2017-03-09 21:36:37 +01:00
Thomas Waldmann d5707929fd [docs] improve remote-path description
(ported bebehei's 1.0-maint change to master)
2017-03-01 01:53:23 +01:00
Thomas Waldmann 4e08bbcf0b document BORG_HOSTNAME_IS_UNIQUE, fixes #2087 2017-02-19 05:12:00 +01:00
Marian Beermann 96fa1e8414 docs: define "ours" merge strategy for auto-generated files 2017-02-12 18:51:40 +01:00
Renamed from docs/usage/general.rst.inc (Browse further)