document new config options

This commit is contained in:
JerryXiao 2021-05-25 15:36:06 +08:00
parent f54da6c074
commit 5de6e6455e
Signed by: Jerry
GPG key ID: 22618F758B5BE2E5

View file

@ -17,7 +17,7 @@ run [-d --debug]
pacroller writes an exception to the status database, and refuses to run again pacroller writes an exception to the status database, and refuses to run again
without resetting its failure status. without resetting its failure status.
status [-v --verbose] [-m --max <number>] status [-v --verbose] [-m --max <number>]
print details of a previous successful upgrade print details of a previously successful upgrade
reset reset
reset the current failure status reset the current failure status
``` ```
@ -26,7 +26,7 @@ There is also a systemd timer for scheduled automatic upgrades.
## Configuration ## Configuration
Pacroller reads `/etc/pacroller/config.json` on startup. Pacroller reads `/etc/pacroller/config.json` on startup.
### custom sync commands ### 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 ### needrestart
If the "needrestart" option is enabled, needrestart should be called after a successful upgrade. If the "needrestart" option is enabled, needrestart should be called after a successful upgrade.
### hold packages ### hold packages
@ -35,7 +35,13 @@ If pacroller observes any changes of the matching group or the hold package is t
### ignored pacnew ### ignored pacnew
A list of pacnew files that are silently ignored during parsing, any other pacnews will trigger a warning and prevent further upgrades. 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
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 ## Limitations
- Your favourite package may not be supported, however it's easy to add another set of rules. - Your favourite package may not be supported, however it's easy to add another set of rules.