diff options
Diffstat (limited to 'nixos/modules/services/backup/borgbackup.nix')
| -rw-r--r-- | nixos/modules/services/backup/borgbackup.nix | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix index bd006fdf77fb8..3abd33f5ae6a5 100644 --- a/nixos/modules/services/backup/borgbackup.nix +++ b/nixos/modules/services/backup/borgbackup.nix @@ -320,12 +320,12 @@ in { startAt = mkOption { type = with types; either str (listOf str); default = "daily"; - description = '' + description = lib.mdDoc '' When or how often the backup should run. Must be in the format described in - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. If you do not want the backup to start - automatically, use <literal>[ ]</literal>. + automatically, use `[ ]`. It will generate a systemd service borgbackup-job-NAME. You may trigger it manually via systemctl restart borgbackup-job-NAME. ''; @@ -335,9 +335,9 @@ in { default = false; type = types.bool; example = true; - description = '' - Set the <literal>persistentTimer</literal> option for the - <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry> + description = lib.mdDoc '' + Set the `persistentTimer` option for the + {manpage}`systemd.timer(5)` which triggers the backup immediately if the last trigger was missed (e.g. if the system was powered down). ''; |