Commit Graph

147 Commits

Author SHA1 Message Date
ntova 627ca1376b Fix various code blocks in the docs (#4708)
Fix various code blocks in the docs

- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.

- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Russell Davis 3fb5998bae Fix osxfuse github link in installation docs
It was broken because there's already a different reference named
github in `docs/global.rst.inc`. Fixed by using an anonymous hyperlink
reference, per https://stackoverflow.com/a/14067756/278488
2019-06-23 19:24:37 -07:00
Sebastiaan Lokhorst 8aafc622e7
docs: update macOS Brew link 2019-05-28 13:44:16 +02:00
Thomas Waldmann 060fb02112 docs: update requirements, fixes #4374
also some other minor install docs updates, to be continued...
2019-03-20 00:01:30 +01:00
Thomas Waldmann f922cdd803 docs: remove libzmq3* for debian/ubuntu 2019-03-19 23:19:38 +01:00
Thomas Waldmann f8371898ae docs: mention pkg-config / pkgconfig requirement, fixes #4452
both are required before invoking setup.py.

also mention libb2 requirement for pkgconfig being able to discover it.
2019-03-19 23:17:15 +01:00
Thomas Waldmann e69b8996cc docs: remove zeromq requirement
borg currently does not use zeromq.
2019-03-19 23:06:24 +01:00
Thomas Waldmann 22e021a5ce docs: install libcrypt-devel on cygwin
this is included into Python.h, thus needed when compiling stuff.
2019-03-19 22:38:09 +01:00
jminer74 a2c84215af docs/installation: added Alpine Linux to distribution list (#4414)
docs/installation: added Alpine Linux to distribution list
2019-03-01 22:11:48 +01:00
Thomas Waldmann 02f3c80d83 docs: tell that our binaries are amd/intel, bauerj has ARM
(cherry picked from commit 13986a1a6a)
2018-12-07 00:51:51 +01:00
Thomas Waldmann 8a09f26712 remove zeromq or python 3.5 references 2018-08-06 17:52:08 +02:00
James Rowell 34227430d4 Installation from source - setting python interpreter version (#3995)
explicit instructions for setting python interpreter when installing from source via git
2018-07-29 09:50:09 +01:00
Russell Davis 041f1baf4c
Update installation instructions for macOS
- Updated `OS X` to the new `macOS` name
- Fuse 3.x is no longer just a prerelease
- Added instructions to install fuse via homebrew
2018-07-06 18:46:18 -07:00
Thomas Waldmann 061321b668 update requirements and install docs about bundled lz4 and zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann fe48caf853 fix lz4 deprecation warning, require lz4 >= 1.7.0 (r129)
as we bundle lz4 1.8.0 now, platform not having a recent liblz4 can
now just use the bundled code.
2017-12-18 00:53:26 +01:00
Thomas Waldmann 61d6c58241 update / rephrase cygwin / WSL status, fixes #3174 2017-11-05 19:24:49 +01:00
TW ddecd4b618
Merge pull request #3182 from TBurchfield/master
Removal of |project_name|.
2017-11-01 02:41:02 +01:00
Svein Ove Aas 98443f15d5 Add Nix/NixOS install command 2017-10-20 17:08:10 +01:00
8bit 8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann a5c6a50ebe increase Python minimum requirement to 3.5.0
also:
- drop testing on 3.4
- add some TODO for the docs and vagrant machines
2017-07-29 20:55:04 +02:00
Marian Beermann 55e0c43c53 add zeromq dependency 2017-07-29 11:58:01 +02:00
Marian Beermann 735339c209 docs: streamline installation: platforms table 2017-07-21 12:32:30 +02:00
Marian Beermann ab773956c1 docs: streamline installation (2)
I can't give a good reason why anyone would care about this here.
This is right before distribution packages, which are per definition
compatible (sometimes tested, even).

Instead, mention it where it applies.
2017-07-21 12:32:30 +02:00
Marian Beermann 3d5a8016e6 docs: streamline installation: file systems 2017-07-21 12:32:30 +02:00
Thomas Kluyver 0edad19ee0 Update source-install about doc dependencies
Closes gh-2795
2017-07-15 15:49:55 +02:00
Antonio Larrosa 6c7b9a338c Fix openSUSE command and add openSUSE section
Fix the name of the borgbackup package in openSUSE and
add an openSUSE section on how to install development dependencies
to build borgbackup from sources.
2017-07-04 12:27:58 +02:00
Thomas Waldmann 7ebad4f803 FUSE vs. fuse 2017-06-24 01:24:14 +02:00
Marian Beermann 7df1140ab9 docs: installation: fix accidental block quotes 2017-06-18 01:27:29 +02:00
Andrea Gelmini e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
Thomas Waldmann b484c79bc2 document follow_symlinks requirements, check libc, fixes #2507 2017-05-22 17:54:42 +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
Steve Groesz ff4120184c Fix formatting in pre-installation section
Some documentation was improperly formatted with #2392. This corrects those errors.
2017-04-26 22:25:15 -05:00
Steve Groesz 605f281b37 Document repository file system requirements
#2080
2017-04-23 12:48:28 +02:00
Thomas Waldmann 32c6e3ad95 docs: tell what kind of hardlinks we support 2017-04-05 13:03:58 +02:00
Thomas Waldmann b287fba22e fix caskroom link, fixes #2299 2017-03-15 01:22:21 +01:00
Florent Hemmi 1551be54be Docs: one link per distro in the installation page 2017-03-08 17:11:10 +01:00
Marian Beermann a9db2a2e55 Merge branch '1.0-maint' into master
# Conflicts:
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-12-17 13:26:28 +01:00
Thomas Waldmann 6b6ddecd93 document windows 10 linux subsystem install
also add note about remote repos being broken on cygwin.
2016-12-17 00:25:49 +01:00
Thomas Waldmann a100fb67eb Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	AUTHORS
#	src/borg/archive.py
#	src/borg/key.py
2016-11-30 05:38:04 +01:00
Thomas Waldmann d6d3f275df docs: add python3-devel as a dependency for cygwin-based installation 2016-11-30 02:50:20 +01:00
enkore 223f7890fe Merge pull request #1819 from enkore/issue/1800
Add BLAKE2b key types
2016-11-11 03:11:38 +01:00
Marian Beermann a31ca4f022
crypto: link against system libb2, if possible 2016-11-11 03:08:11 +01:00
Marian Beermann 05a52ec8ec
Merge branch '1.0-maint' into merge/1.0-maint 2016-11-09 23:56:54 +01:00
Antoine Beaupré b4d0388785 move security verification to support section
the rationale is to simplify the README file to the bare
minimum. security researchers will be able to find the contact
information if they look minimally and people installing the software
will find a link where relevant (in binary releases only, since all
the others have other trust paths)
2016-11-04 20:58:27 -04:00
Thomas Waldmann dbe862f3d8 Merge branch '1.0-maint' into merge-1.0-maint 2016-08-06 01:24:22 +02:00
Thomas Waldmann 4e737cb64b OS X: install pkg-config to build with FUSE support 2016-07-30 21:08:20 +02:00
Marian Beermann 4e3bfabebf docs, platform/features: linux has BSD flag emulation 2016-07-30 00:01:05 +02:00
Marian Beermann ac8c8119a7
Merge branch '1.0-maint' into master 2016-07-28 00:29:43 +02:00
enkore f811624fab Merge pull request #1388 from enkore/f/document-platforms2
Platform feature matrix
2016-07-28 00:17:26 +02:00
Marian Beermann c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00