1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 08:45:13 +00:00

restructure install page headings

do not repeat "installation" all the time, and regroup git and pip under "from source"

also link to the sections in the summary
This commit is contained in:
Antoine Beaupré 2015-11-14 21:03:38 -05:00
parent 44f54c427f
commit 9f8700e383

View file

@ -6,18 +6,23 @@ Installation
There are different ways to install |project_name|: There are different ways to install |project_name|:
- **distribution package** - easy and fast if a package is available for your - :ref:`distribution-package` - easy and fast if a package is
Linux/BSD distribution. available from your operating system.
- **PyInstaller binary** - easy and fast, we provide a ready-to-use binary file - :ref:`pyinstaller-binary` - easy and fast, we provide a ready-to-use binary file
that comes bundled with all dependencies. that comes bundled with all dependencies.
- **pip** - installing a source package with pip needs more installation steps - :ref:`source-install`, either:
and requires all dependencies with development headers and a compiler.
- **git** - for developers and power users who want to have the latest code or
use revision control (each release is tagged).
- :ref:`pip-installation` - installing a source package with pip needs
more installation steps and requires all dependencies with
development headers and a compiler.
- :ref:`git-installation` - for developers and power users who want to
have the latest code or use revision control (each release is
tagged).
Installation (Distribution Package) .. _distribution-package:
-----------------------------------
Distribution Package
--------------------
Some Linux and BSD distributions might offer a ready-to-use ``borgbackup`` Some Linux and BSD distributions might offer a ready-to-use ``borgbackup``
package which can be installed with the package manager. As |project_name| is package which can be installed with the package manager. As |project_name| is
@ -32,9 +37,10 @@ and compare that to our latest release and review the :doc:`changes`.
.. _AUR: https://aur.archlinux.org/packages/borgbackup/ .. _AUR: https://aur.archlinux.org/packages/borgbackup/
.. _pyinstaller-binary:
Installation (PyInstaller Binary) PyInstaller Binary
--------------------------------- ------------------
The |project_name| binary is available on the releases_ page for the following The |project_name| binary is available on the releases_ page for the following
platforms: platforms:
@ -50,10 +56,15 @@ version.
.. _releases: https://github.com/borgbackup/borg/releases .. _releases: https://github.com/borgbackup/borg/releases
Installing the Dependencies .. _source-install:
---------------------------
To install |project_name| from a source package, you have to install the From source
-----------
Dependencies
~~~~~~~~~~~~
To install |project_name| from a source package (including pip), you have to install the
following dependencies first: following dependencies first:
* `Python 3`_ >= 3.2.2. Even though Python 3 is not the default Python version on * `Python 3`_ >= 3.2.2. Even though Python 3 is not the default Python version on
@ -75,7 +86,7 @@ After you have installed the dependencies, you can proceed with steps outlined
under :ref:`pip-installation`. under :ref:`pip-installation`.
Debian / Ubuntu Debian / Ubuntu
~~~~~~~~~~~~~~~ +++++++++++++++
Install the dependencies with development headers:: Install the dependencies with development headers::
@ -91,7 +102,7 @@ Ubuntu this means your user is not in the ``fuse`` group. Add yourself to that
group, log out and log in again. group, log out and log in again.
Fedora / Korora Fedora / Korora
~~~~~~~~~~~~~~~ +++++++++++++++
Install the dependencies with development headers:: Install the dependencies with development headers::
@ -103,7 +114,7 @@ Install the dependencies with development headers::
Mac OS X Mac OS X
~~~~~~~~ ++++++++
Assuming you have installed homebrew_, the following steps will install all the Assuming you have installed homebrew_, the following steps will install all the
dependencies:: dependencies::
@ -117,7 +128,7 @@ FUSE for OS X, which is available as a pre-release_.
.. _pre-release: https://github.com/osxfuse/osxfuse/releases .. _pre-release: https://github.com/osxfuse/osxfuse/releases
Cygwin Cygwin
~~~~~~ ++++++
.. note:: .. note::
Running under Cygwin is experimental and has only been tested with Cygwin Running under Cygwin is experimental and has only been tested with Cygwin
@ -144,8 +155,8 @@ In case the creation of the virtual environment fails, try deleting this file::
.. _pip-installation: .. _pip-installation:
Installation (pip) From pip
------------------ ~~~~~~~~
Virtualenv_ can be used to build and install |project_name| without affecting Virtualenv_ can be used to build and install |project_name| without affecting
the system Python or requiring root access. Using a virtual environment is the system Python or requiring root access. Using a virtual environment is
@ -172,9 +183,10 @@ activating your virtual environment::
pip install -U borgbackup pip install -U borgbackup
.. _git-installation:
Installation (git) From git
------------------ ~~~~~~~~
This uses latest, unreleased development code from git. This uses latest, unreleased development code from git.
While we try not to break master, there are no guarantees on anything. :: While we try not to break master, there are no guarantees on anything. ::