aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 90b1ae1..c38f679 100644
--- a/README.md
+++ b/README.md
@@ -45,16 +45,23 @@ Crypted-backups is made available through systemd services and timers.
### Example 1: Activating a system backup with the help of a timer
In this example the system backup for the bitlbee configuration will be started by a timer.
This timer unit has the same name as its service.
+
/usr/lib/systemd/system/backup-bitlbee.service
/usr/lib/systemd/system/backup-bitlbee.timer
+
Using *systemctl* one can easily start and stop timer units belonging to a service. As root:
+
systemctl start backup-bitlbee.timer
systemctl stop backup-bitlbee.timer
-To make the system boot with this timer started, enable it. Again, as root:
+
+To make the system boot with this timer started, enable it. Again, as root:
+
systemctl enable backup-bitlbee.timer
systemctl disable backup-bitlbee.timer
+
When the timer's conditions are met, the service *backup-bitlbee.service* is started automatically. Much like cron.
Unlike cron, you can also start and stop the service separately:
+
systemctl start backup-bitlbee.service
systemctl stop backup-bitlbee.service
@@ -63,17 +70,23 @@ Unlike cron, you can also start and stop the service separately:
### Example 2: Activating a user backup with the help of a timer
In this example the user backup for a user's firefox profile will be started by a timer (like in the example above).
The user service and timer units reside in a different location:
+
/usr/lib/systemd/user/backup-firefox.service
/usr/lib/systemd/user/backup-firefox.timer
+
Using *systemctl* one can easily start and stop timer units belonging to a service. This time, as your user:
+
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:
+
systemctl --user enable backup-firefox.timer
systemctl --user disable backup-firefox.timer
When the timer's conditions are met, the service *backup-firefox.service* is started (as your user) automatically.
This service can of course also just be started and stopped separately from the timer:
+
systemctl --user start backup-firefox.service
systemctl --user stop backup-firefox.service