ambiser
/
btrbk
mirror of https://github.com/digint/btrbk
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
792 Commits
12 Branches
50 Tags
5 MiB
Commit Graph

78 Commits (f54853dd18fbbbb5411c8a0e794860bac9a7b9b5)

Author SHA1 Message Date
Axel Burri a6dbd60e5a documentation: add pre-generated man pages: from groff to asciidoc and back again 
This reduces build-time dependencies to zero, helping package
maintainers and providing reproducible builds.

NOTE: generated man pages will only be updated on releases. In order
to make sure the docs are correctly rebuilt, run "make clean man". We
apologize for the inconvenience.

From Groff to Asciidoc and Back Again [1]
=========================================

| Comparison                                                               | Links                                                                                                          |
| -------------------------------------------------------------------------| -------------------------------------------------------------------------------------------------------------- |
| **Plain ROFF**                                                           |                                                                                                                |
| +++ Best result for `man` (our main goal!)                               |                                                                                                                |
| - Not supported by github                                                | [btrbk(1) v0.25.1 in plain groff](https://github.com/digint/btrbk/blob/v0.25.1/doc/btrbk.1)                    |
| - No decent converters: e.g. `groff -Txhtml -mandoc`                     | [btrbk(1) v0.25.1 at digint.ch (official site)](https://digint.ch/btrbk/doc/archive/btrbk-0.25.1/btrbk.1.html) |
|                                                                          |                                                                                                                |
| **asciidoc**                                                             |                                                                                                                |
| + Decent (scriptable!) html                                              | [btrbk(1) v0.26.1 at digint.ch (official site)](https://digint.ch/btrbk/doc/archive/btrbk-0.26.1/btrbk.1.html) |
| + Supported by github (helps contributors writing decent documentation)  | [btrbk.1.asciidoc v0.26.1 at github](https://github.com/digint/btrbk/blob/master/doc/btrbk.1.asciidoc)         |
|                                                                          |                                                                                                                |
| **asciidoc (`xmlto`, `atx`)**                                            | http://asciidoc.org/                                                                                           |
| + Good result for `man`                                                  |                                                                                                                |
| - EOL (why care that much? it works fine!)                               | [asciidoc EOL notice at github](https://github.com/asciidoc/asciidoc/releases/tag/8.6.10)                      |
|                                                                          |                                                                                                                |
| **asciidoc (`asciidoctor`)**                                             | https://asciidoctor.org                                                                                        |
| - Pulls in tons of ruby (build depends)                                  | https://bugs.gentoo.org/681056                                                                                 |
| -- Implies to commit a pre-converted `doc/btrbk.1`                       |                                                                                                                |
| + Seems more evolved than `xmlto`, still actively maintained             |                                                                                                                |
|                                                                          |                                                                                                                |
| **rst (`xrst2man.py` from docutils)**                                    |                                                                                                                |
| - Worse result for `man`                                                 |                                                                                                                |
| ++ Good html converters (after having a quick look at it)                |                                                                                                                |
| - Not so well supported by github                                        | [btrbk.1.rst v0.26.1 at github](https://github.com/digint/btrbk/blob/rst2man/doc/btrbk.1.rst)                  |

 [1] https://github.com/digint/btrbk/pull/219 (edited)
 2019-04-24 19:45:54 +02:00
Axel Burri c4ced9d6e4 documentation: convert all groff files (man pages) to asciidoc 
- btrbk.conf.5 to btrbk.conf.5.asciidoc
 - btrbk.1 to btrbk.1.asciidoc
 - ssh_filter_btrbk.1 to ssh_filter_btrbk.1.asciidoc
 2017-10-11 18:04:25 +02:00
Axel Burri a5aaffa5b5 documentation: add "prune" to list of affected commands by several options 2017-10-02 13:44:35 +02:00
Axel Burri 2e974c1f4f btrbk: add "--wipe" command line option 2017-09-28 14:17:00 +02:00
Axel Burri 5bdc3e527b btrbk: add "prune" command 2017-09-28 14:17:00 +02:00
Axel Burri 5428e9cd93 btrbk: add "resume" and "snapshot" commands; add --preserve-snapshots and --preserve-backups options; deprecate "-r, --resume-only" command line option 2017-08-21 13:23:20 +02:00
Axel Burri a9f1b6b24a change version to 0.25.1 2017-07-30 16:03:58 +02:00
Axel Burri 7436d9432c change version to 0.25.0 2017-03-18 16:53:07 +01:00
Axel Burri b69e9ebf34 btrbk: show aggregate "size" and "used" for "usage" action 2016-12-11 15:36:48 +01:00
Axel Burri da849b37ae change version to 0.24.0 2016-11-16 15:32:17 +01:00
Axel Burri 9a5e8311be change version to 0.23.3 2016-07-14 01:41:45 +02:00
Axel Burri 91d02ca97b change version to 0.23.2 2016-06-07 16:41:41 +02:00
Axel Burri 3a8665bce9 documentation: add information about wildcard characters for subvolume section; cleanup 2016-06-07 16:37:32 +02:00
Axel Burri e4a7ba4be5 btrbk: add lockfile support, using perl "flock": add configuration option "lockfile <file>", and command line option "--lockfile"' 2016-06-07 16:17:02 +02:00
Axel Burri cb0851c8b6 change version to 0.23.1 2016-05-03 16:21:34 +02:00
Axel Burri 65ebf949d1 documentation: cosmetics: groff: consistently use minus "\-" instead of hyphen "-" where applicable 2016-05-03 16:01:39 +02:00
Axel Burri cb6dcbe58e documentation: cosmetics (no more long lines) 2016-05-03 15:30:06 +02:00
Axel Burri 4ffaf430c5 change version to 0.23.0 2016-04-23 15:06:57 +02:00
Axel Burri a27f99af46 change version to 0.23.0-rc1 2016-04-17 21:46:56 +02:00
Axel Burri edfebb8193 btrbk: action "origin": use --format options; do not recurse into parent chain 2016-04-16 22:05:26 +02:00
Axel Burri de05b99757 btrbk: rename action "clone" to "archive" (should have been like this from the beginning) 2016-04-16 17:25:51 +02:00
Axel Burri 14de16aabe btrbk: add action "clone": recursively send/receive all backups to an archive directory 2016-04-15 23:29:47 +02:00
Axel Burri 3c9aff4c40 btrbk: enable --override option 2016-04-15 11:10:12 +02:00
Axel Burri a1ee9d5c6d btrbk: allow "{snapshot,target}_preserve no": disable retention policy 2016-04-14 14:43:43 +02:00
Axel Burri 36cc96fdb8 btrbk: always preserve latest snapshot/backup pair (instead of latest snapshot and latest backup); remove preserve_latest option of schedule() 2016-04-13 22:05:20 +02:00
Axel Burri 55b121c372 btrbk: remove resume_missing configuration option 2016-04-13 22:05:20 +02:00
Axel Burri 1e91f179d4 documentation: btrbk.1: update sections containing infos about retention policy; fix documentation of -p option; cosmetics 2016-04-12 11:47:41 +02:00
Axel Burri ceb4dbf19c btrbk: add --print-schedule command line option 2016-04-09 14:16:14 +02:00
Axel Burri 1adb318f02 documentation: cosmetics: change all url from www.digint.ch to digint.ch 2016-03-16 18:34:28 +01:00
Axel Burri 4a41413793 documentation: btrbk.1: more precice description of "btrbk list latest" 2016-02-03 12:43:20 +01:00
Axel Burri 4434bc17ef changed version to 0.22.2 2016-02-02 11:26:09 +01:00
Axel Burri 872779398e changed version to 0.22.1 2016-01-20 18:47:29 +01:00
Axel Burri 9595adc2a5 changed version to 0.22.0 2016-01-19 21:08:19 +01:00
Axel Burri a1698ef4b0 btrbk: print "$hostname:$path" instead of "{$hostname}$path" in summary and logs 2016-01-17 19:44:59 +01:00
Axel Burri e7ff20114c btrbk: add "stats" action (print snapshot/backup statistics) 2016-01-15 02:06:03 +01:00
Axel Burri 9718ad1460 btrbk: add "-n, --dry-run" option 2016-01-14 16:11:33 +01:00
Axel Burri 3624a8fba0 btrbk: add "clean" action (delete incomplete, garbled backups) 2016-01-14 16:11:30 +01:00
Axel Burri cb01507bb1 changed version to 0.21.0 2015-10-25 12:29:52 +01:00
Axel Burri 3f09d2c37f btrbk/documentation: rename "resolve *" commands to "list *"; cleanup 2015-10-22 17:59:17 +02:00
Axel Burri 05bfeaff1b btrbk: replace "info" command with "usage", with tabular output; add support for right-aligned columns 2015-10-19 22:10:08 +02:00
Axel Burri bca413b7ca documentation: add missing "config print" command; add predefined "list" filters; cosmetics; fix FAQ 2015-10-13 20:08:10 +02:00
Axel Burri 01b7ab0ebf btrbk: add "-t, --table" command line option (shortcut for "--format=table") 2015-10-13 20:08:04 +02:00
Axel Burri 956b010143 documentation: add "--format=table|long|raw" command line option 2015-10-13 20:02:02 +02:00
Axel Burri 1905d80969 btrbk: return exit status 10 instead of 0 if one or more backup tasks aborted, and exit status 2 on parse errors 2015-09-30 14:00:39 +02:00
Axel Burri bed00cdb8a documentation: added "target raw" and "timestamp short|long" documentation to btrbk.conf(5), as well as an example for raw targets in README.md 2015-09-29 21:48:56 +02:00
Axel Burri d73e3f184b btrbk: added "config dump" command (tagged as experimental): dump filtered btrbk config, useful for scripting 2015-09-24 16:00:35 +02:00
Axel Burri b3d8c1f15f btrbk: allow filtering by "<target-directory>/<snapshot-name>", which makes it possible to pinpoint a single target 2015-09-24 14:56:22 +02:00
Axel Burri 8059fa28db documentation: added documentation for ---raw-output command line option 2015-09-24 01:02:42 +02:00
Axel Burri 269b3611ac documentation: added "FILTER STATEMENT" section in btrbk(1), and "group" configuration option in btrbk.conf(5) 2015-09-20 17:47:46 +02:00
Axel Burri 38a8c1c9eb documentation: btrbk(1): added missing command line options in synopsis section 2015-09-03 18:13:09 +02:00