ambiser
/
btrbk
mirror of https://github.com/digint/btrbk
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation: move installation instructions from README.md to doc/install.md

pull/208/merge
Axel Burri 2018-10-10 01:54:51 +02:00
parent 756e1e9449
commit c2a344fed1
2 changed files with 65 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -40,13 +40,17 @@ updating from btrbk <= v0.22.2.
Installation
============
btrbk comes as a single executable file (perl script), without the
need of any installation procedures. If you want the package and
man-pages properly installed, follow the instructions below.
Btrbk is a single perl script, and does not require any special
installation procedures or libraries. Simply download the latest
[btrbk source tarball] and run the "btrbk" executable.
For more information, read the [installation documentation].
[btrbk source tarball]: https://digint.ch/download/btrbk/releases/
[installation documentation]: doc/install.md
Prerequisites
-------------
### Prerequisites
* [btrfs-progs]: Btrfs filesystem utilities >= v3.18.2
* [Perl interpreter]: Probably already installed on your system
@ -59,62 +63,6 @@ Prerequisites
[Pipe Viewer]: https://www.ivarch.com/programs/pv.shtml
Instructions
------------
In order to install the btrbk executable along with the man-pages and
an example configuration file, choose one of the following methods:
### Generic Linux System
Download and unpack the newest stable [btrbk source tarball] and type:
sudo make install
### Gentoo Linux
btrbk is in portage:
emerge app-backup/btrbk
### Debian Based Distros
btrbk is in `stretch (testing) (utils)`: https://packages.debian.org/stretch/btrbk
Packages are also available via NeuroDebian: http://neuro.debian.net/pkgs/btrbk.html
### Fedora Linux
btrbk is in the official Fedora repos: https://apps.fedoraproject.org/packages/btrbk
sudo dnf install btrbk
### Arch Linux
btrbk is in AUR: https://aur.archlinux.org/packages/btrbk/
### Alpine Linux
btrbk is in `testing`, install with:
apk add btrbk
### Void Linux
btrbk is in Void's `current` repository
xbps-install -S btrbk
[btrbk source tarball]: https://digint.ch/download/btrbk/releases/
Synopsis
========

56
doc/install.md Normal file
View File

@ -0,0 +1,56 @@
Installation
============
Btrbk is a single perl script, and does not require any special
installation procedures or libraries. In order to install the btrbk
executable along with the documentation and an example configuration
file, choose one of the following methods:
### Generic Linux System
Download and unpack the latest [btrbk source tarball] and type:
sudo make install
### Gentoo Linux
btrbk is in portage:
emerge app-backup/btrbk
### Debian Based Distros
btrbk is in `stretch (testing) (utils)`: https://packages.debian.org/stretch/btrbk
Packages are also available via NeuroDebian: http://neuro.debian.net/pkgs/btrbk.html
### Fedora Linux
btrbk is in the official Fedora repos: https://apps.fedoraproject.org/packages/btrbk
sudo dnf install btrbk
### Arch Linux
btrbk is in AUR: https://aur.archlinux.org/packages/btrbk/
### Alpine Linux
btrbk is in `testing`, install with:
apk add btrbk
### Void Linux
btrbk is in Void's `current` repository
xbps-install -S btrbk
[btrbk source tarball]: https://digint.ch/download/btrbk/releases/