From 7528434cd90b58bd07173aacf84fc924fe9dd834 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Fri, 27 Mar 2015 00:46:48 +0100 Subject: [PATCH] documentation: added link to btrbk.conf(5) man-page in README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index edbc0d4..34a4458 100644 --- a/README.md +++ b/README.md @@ -58,18 +58,19 @@ an example configuration file. 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. - [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 ================== -Before running `btrbk`, you will need to create a config file. You -might want to take a look at the example configuration file provided -with this package: `btrbk.conf.example`. +Before running `btrbk`, you will need to create a configuration +file. You might want to take a look at `btrbk.conf.example` provided +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 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). + [btrbk.conf(5) man-page]: http://www.digint.ch/btrbk/doc/btrbk.conf.html + + Example: laptop with usb-disk for backups -----------------------------------------