aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index b9c1536..6b2261e 100644
--- a/README.rst
+++ b/README.rst
@@ -1,13 +1,13 @@
crypted backups
===============
-| *crypted backups* enables for |xz|-compressed and |gnupg| encrypted backups of certain configuration data by the use of |systemd| |systemd.service| and |systemd.timer|.
+| **crypted backups** enables for |xz|-compressed and |gnupg| encrypted backups of certain configuration data by the use of |systemd| |systemd.service| and |systemd.timer|.
| System-wide and user-specific backups are possible. The script and all of its components are licensed under the GPLv3.
-| **Note:** Most of *crypted backups* was designed with a headless system in mind.
-| **Note:** By default the script uses volatile file-systems (*tmpfs*) as a working space! Depending on the size of your (singular) backups and available RAM you might want to consider moving this working space somewhere else.
-| **Note:** Due to systemd's architecture you can copy/paste and modify given default timers from **/usr/lib/systemd/{systemd,user}/** and put them to **/etc/systemd/{system,user}**. The latter will always have precedence over the former. Same counts for services!
-| **Note:** To minimize the size of your user backups, you might want to consider using tools like |profile-cleaner| to shrink the size of your program profiles.*
+| **Note:** Most of **crypted backups** was designed with a headless system in mind.
+| **Note:** By default the script uses **/tmp/** - on most systems a volatile file-system (**tmpfs**) - as a working space! Depending on the size of your (singular) backups and available RAM you might want to consider moving this working space somewhere else.
+| **Note:** Due to systemd's architecture you can copy/paste and modify given default timers from **/usr/lib/systemd/{systemd,user}/** and put them to **/etc/systemd/{system,user}/**. The latter will always have precedence over the former. Same counts for services!
+| **Note:** To minimize the size of your user backups, you might want to consider using tools like |profile-cleaner| to shrink the size of your program profiles.
Requirements
------------
@@ -64,7 +64,7 @@ To make the system boot with this timer started, enable it. Again, as root:
User backups
------------
-| The configuration file for user services is read first from **$HOME/.crypted-backups** followed by **$HOME/.config/crypted-backups**. Environment variables set in the first file will be replaced by the ones set in the latter, if present.
+| The configuration file for user services is read first from **~/.crypted-backups** followed by **~/.config/crypted-backups**. Environment variables set in the first file will be replaced by the ones set in the latter, if present.
| Take a look at the example file in **/usr/share/doc/crypted-backups/crypted-backups.conf.example** to get an idea of how to use the services.
| Here you can set the public key to encrypt with, source and destination folder for backups and cleanup policy.
| The following pbackups
@@ -87,6 +87,7 @@ _______
systemctl --user start backup-firefox.timer
systemctl --user stop backup-firefox.timer
+
| To make your user environment start with this timer started, enable it. Again, as your user:
.. code:: bash