]> gitweb.fluxo.info Git - borger.git/commitdiff
Fix: README formatting and typo
authorSilvio Rhatto <rhatto@riseup.net>
Fri, 8 Mar 2024 01:02:42 +0000 (22:02 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Fri, 8 Mar 2024 01:02:42 +0000 (22:02 -0300)
README.md

index 621e8f18aebb0bf0868604f9f99154f8d88c8704..c91866552b019d284d0579c6864d27bf9a7b0b47 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,24 +2,24 @@
 
 A script for home folder backups using [Borg](https://borgbackup.readthedocs.io).
 
-# Features
+## Features
 
 * Multiple destinations using config files.
 * Automatically initializes repository in the remote destination.
 * Automatically pruning of old backups.
 
-# Usage
+## Usage
 
 Create a config for your `servername` destination at `~/.config/borger/servername`:
 
     # Backup destination
     export SSH_SERVER="user@host"
     export SSH_PORT="2202"
-  
+
     # Repository path
     export BORG_REPO_DIR="/var/backups/users/$USER/borg"
     export BORG_REPO="ssh://$SSH_SERVER:$SSH_PORT/$BORG_REPO_DIR"
-  
+
     # Setting one of those, so you won't be asked for your repository passphrase:
     #export BORG_PASSPHRASE='HACKME'
     #export BORG_PASSCOMMAND='pass show backup'
@@ -47,7 +47,7 @@ Then run borger normally:
 Note that `BORGER_REPO` param assumes that the path is available. If this path represents
 a mountpoint for an external drive then you should mount it manually.
 
-# Optional config
+## Optional config
 
 These include:
 
@@ -59,7 +59,7 @@ These include:
     export PLACEHOLDER="{user}"  # placeholder to tag archives
     export INTERVAL="1h"         # interval between backups in the continuous mode
 
-# Continuous backups
+## Continuous backups
 
 If you want to run your backups continuously, use
 
@@ -70,16 +70,16 @@ can be adjusted using the `INTERVAL` config variable. See [this
 issue](https://github.com/borgbackup/borg/issues/325) for a discussion on
 continous backups.
 
-# Listing your backups
+## Listing your backups
 
 As simply as
 
     borger servername --list
     borger mydisk     --list
 
-# Multiple configuration profiles
+## Multiple configuration profiles
 
-You can process multiple backup destionation in the same command by placing each
+You can process multiple backup destinations in the same command by placing each
 configuration in a subfolder of `~/.config/borger`, like `~/.config/borger/default/servername`
 and `~/.config/borger/default/mydisk` and invoking both using commands like
 
@@ -91,7 +91,7 @@ Each config could even be a symbolic links to other configs, so you can build di
 backup profiles for different situations, eg. when your laptop is at home, office or if you're
 backing up to multiple external drives at the same time.
 
-# WARNING
+## WARNING
 
 Borger uses `keyfile` encrytion by default. That means **you should backup your keyfile**
 somewhere else. **If you don't want that, use `encryption="repokey"` at your config.**
@@ -99,7 +99,7 @@ somewhere else. **If you don't want that, use `encryption="repokey"` at your con
 See [Repository Encryption](https://borgbackup.readthedocs.io/en/stable/quickstart.html#repository-encryption)
 for details.
 
-# Known issues
+## Known issues
 
 Borger needs a better lock/session management to prevent errors like
 
@@ -107,11 +107,11 @@ Borger needs a better lock/session management to prevent errors like
 
 See also:
 
-- borg break-lock (before 1.1.0 in theory)
-- https://www.solved.tips/failed-create-acquire-lock/
-- https://github.com/rugk/borg-cron-helper
-- https://github.com/rugk/borg-cron-helper#local-lock-borg--v110
-- https://github.com/borgbackup/borg/issues/2306
-- https://github.com/borgbackup/borg/issues/813
-- https://github.com/borgbackup/borg/issues/2306
-- https://github.com/borgbackup/borg/issues/3191
+* `borg break-lock` (before 1.1.0 in theory)
+* https://www.solved.tips/failed-create-acquire-lock/
+* https://github.com/rugk/borg-cron-helper
+* https://github.com/rugk/borg-cron-helper#local-lock-borg--v110
+* https://github.com/borgbackup/borg/issues/2306
+* https://github.com/borgbackup/borg/issues/813
+* https://github.com/borgbackup/borg/issues/2306
+* https://github.com/borgbackup/borg/issues/3191