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

documentation: added link to btrbk.conf(5) man-page in README.md

pull/30/head
Axel Burri 2015-03-27 00:46:48 +01:00
parent 920b7821ce
commit 7528434cd9
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -58,18 +58,19 @@ an example configuration file.
Synopsis Synopsis
======== ========
Please consult the [btrbk man-page] provided with this package for a Please consult the [btrbk(1) man-page] provided with this package for a
full description of the command line options. full description of the command line options.
[btrbk man-page]: http://www.digint.ch/btrbk/doc/btrbk.html [btrbk(1) man-page]: http://www.digint.ch/btrbk/doc/btrbk.html
Configuration File Configuration File
================== ==================
Before running `btrbk`, you will need to create a config file. You Before running `btrbk`, you will need to create a configuration
might want to take a look at the example configuration file provided file. You might want to take a look at `btrbk.conf.example` provided
with this package: `btrbk.conf.example`. with this package. For a detailed description, please consult the
[btrbk.conf(5) man-page].
When playing around with config-files, it is highly recommended to When playing around with config-files, it is highly recommended to
check the output using the `dryrun` command before executing the check the output using the `dryrun` command before executing the
@ -82,6 +83,9 @@ and show what actions would be performed (without writing anything to
the disks). the disks).
[btrbk.conf(5) man-page]: http://www.digint.ch/btrbk/doc/btrbk.conf.html
Example: laptop with usb-disk for backups Example: laptop with usb-disk for backups
----------------------------------------- -----------------------------------------