From 5de6e6455e9e952188677da339a2c2b5ac27ddbb Mon Sep 17 00:00:00 2001 From: Jerry Date: Tue, 25 May 2021 15:36:06 +0800 Subject: [PATCH] document new config options --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 465e06c..20106ee 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ run [-d --debug] pacroller writes an exception to the status database, and refuses to run again without resetting its failure status. status [-v --verbose] [-m --max ] - print details of a previous successful upgrade + print details of a previously successful upgrade reset reset the current failure status ``` @@ -26,7 +26,7 @@ There is also a systemd timer for scheduled automatic upgrades. ## Configuration Pacroller reads `/etc/pacroller/config.json` on startup. ### custom sync commands -Pacroller can be configured to use custom sync commands, which allows the usage of a different set of mirrors when syncing the database. Enable the "custom_sync" option and write your custom `/etc/pacroller/sync.sh`. +Pacroller can be configured to use custom sync commands, which allows the usage of a different set of mirrors when syncing the database. Enable the "custom_sync" option and write your custom `/etc/pacroller/sync.sh`. ### needrestart If the "needrestart" option is enabled, needrestart should be called after a successful upgrade. ### hold packages @@ -35,7 +35,13 @@ If pacroller observes any changes of the matching group or the hold package is t ### ignored pacnew A list of pacnew files that are silently ignored during parsing, any other pacnews will trigger a warning and prevent further upgrades. ### custom pacman hooks and packages -Custom pacman hooks and packages output matching is configurable via `/etc/pacroller/known_output_override.py`. +Custom pacman hooks and packages output matching is configurable via `/etc/pacroller/known_output_override.py`. +### check systemd status +The "systemd-check" option allows pacroller to check fo degraded systemd services before an upgrade. +### clear package cache +Pacroller wipes /var/cache/pacman/pkg after a successful upgrade if the option "clear_pkg_cache" is set. +### save pacman output +Every time an upgrade is performed, the pacman output is stored into /var/log/pacroller. This can be configured via the "save_stdout" keyword. ## Limitations - Your favourite package may not be supported, however it's easy to add another set of rules.