From 13c7335ee35bfdb080fc58c3c2a58cd965030682 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Sch=C3=A4ferdiek?= Date: Fri, 27 Jan 2023 00:53:23 +0100 Subject: [PATCH] Fix check_updates and update man reference to point to correct examples --- _man/src/check_updates.1.md | 2 +- _man/src/disk_space_alert.1.md | 2 +- _man/src/docker_check.1.md | 2 +- _man/src/docker_compose_update.1.md | 2 +- _man/src/dynv6.1.md | 2 +- _man/src/memory_usage_alert.1.md | 2 +- _man/src/notifier.1.md | 2 +- _man/src/smart_tests_long.1.md | 2 +- _man/src/system-helpers.1.md | 2 +- _man/src/systemd_check.1.md | 2 +- _man/src/systemd_failure_notify.1.md | 2 +- usr/local/bin/check_updates | 5 ++--- usr/local/bin/docker_check | 2 +- usr/share/man/man1/check_updates.1 | 3 ++- usr/share/man/man1/disk_space_alert.1 | 3 ++- usr/share/man/man1/docker_check.1 | 3 ++- usr/share/man/man1/docker_compose_update.1 | 3 ++- usr/share/man/man1/dynv6.1 | 2 +- usr/share/man/man1/memory_usage_alert.1 | 3 ++- usr/share/man/man1/notifier.1 | 3 ++- usr/share/man/man1/smart_tests_long.1 | 3 ++- usr/share/man/man1/system-helpers.1 | 6 +++--- usr/share/man/man1/systemd_check.1 | 3 ++- usr/share/man/man1/systemd_failure_notify.1 | 2 +- 24 files changed, 35 insertions(+), 28 deletions(-) diff --git a/_man/src/check_updates.1.md b/_man/src/check_updates.1.md index 82ed570..5de8e32 100644 --- a/_man/src/check_updates.1.md +++ b/_man/src/check_updates.1.md @@ -23,7 +23,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.check_updates.conf* and add *CHECK_UPDATES_UPDATES_CMD="..."*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/check_updates*. +Create a *$HOME/.check_updates.conf* and add *CHECK_UPDATES_UPDATES_CMD="..."*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/check_updates*. # EXIT VALUES **0** diff --git a/_man/src/disk_space_alert.1.md b/_man/src/disk_space_alert.1.md index 483093a..4523b71 100644 --- a/_man/src/disk_space_alert.1.md +++ b/_man/src/disk_space_alert.1.md @@ -23,7 +23,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.disk_space_alert.conf* and add *DISK_SPACE_ALERT_THRESHOLD="95"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/disk_space_alert*. +Create a *$HOME/.disk_space_alert.conf* and add *DISK_SPACE_ALERT_THRESHOLD="95"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/disk_space_alert*. # EXIT VALUES **0** diff --git a/_man/src/docker_check.1.md b/_man/src/docker_check.1.md index 725ef04..782db46 100644 --- a/_man/src/docker_check.1.md +++ b/_man/src/docker_check.1.md @@ -23,7 +23,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.docker_check.conf* and add *DOCKER_CHECK_NOTIFY_LEVELS="(WARNING)"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/docker_check*. +Create a *$HOME/.docker_check.conf* and add *DOCKER_CHECK_NOTIFY_LEVELS="(WARNING)"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/docker_check*. # EXIT VALUES **0** diff --git a/_man/src/docker_compose_update.1.md b/_man/src/docker_compose_update.1.md index f27dd81..c8821fc 100644 --- a/_man/src/docker_compose_update.1.md +++ b/_man/src/docker_compose_update.1.md @@ -26,7 +26,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.docker_compose_update.conf* and necessary configuration. Examples can be found in */usr/share/doc/docker_compose_update*. +Create a *$HOME/.docker_compose_update.conf* and necessary configuration. Examples can be found in */usr/share/doc/system-helpers/docker_compose_update*. # EXIT VALUES **0** diff --git a/_man/src/dynv6.1.md b/_man/src/dynv6.1.md index e002f06..d374530 100644 --- a/_man/src/dynv6.1.md +++ b/_man/src/dynv6.1.md @@ -26,7 +26,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.dynv6.conf* and add *DYNV6_TOKEN="mySecretToken"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/dynv6*. +Create a *$HOME/.dynv6.conf* and add *DYNV6_TOKEN="mySecretToken"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/dynv6*. # EXIT VALUES **0** diff --git a/_man/src/memory_usage_alert.1.md b/_man/src/memory_usage_alert.1.md index 7837d96..15b027d 100644 --- a/_man/src/memory_usage_alert.1.md +++ b/_man/src/memory_usage_alert.1.md @@ -22,7 +22,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.memory_usage_alert.conf* and add *MEMORY_USAGE_ALERT_THRESHOLD="1024"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/memory_usage_alert*. +Create a *$HOME/.memory_usage_alert.conf* and add *MEMORY_USAGE_ALERT_THRESHOLD="1024"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/memory_usage_alert*. # EXIT VALUES **0** diff --git a/_man/src/notifier.1.md b/_man/src/notifier.1.md index 5ec1f50..6ad15c8 100644 --- a/_man/src/notifier.1.md +++ b/_man/src/notifier.1.md @@ -25,7 +25,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.notifier.conf* and add *NOTIFIER_MAIL_ADDRESS="alias@domain.tld"*. Notifications will be delivered to alias@domain.tld or via gotify if enabled. Examples can be found in */usr/share/doc/notifier*. +Create a *$HOME/.notifier.conf* and add *NOTIFIER_MAIL_ADDRESS="alias@domain.tld"*. Notifications will be delivered to alias@domain.tld or via gotify if enabled. Examples can be found in */usr/share/doc/system-helpers/notifier*. # EXIT VALUES **0** diff --git a/_man/src/smart_tests_long.1.md b/_man/src/smart_tests_long.1.md index e026726..f499ad1 100644 --- a/_man/src/smart_tests_long.1.md +++ b/_man/src/smart_tests_long.1.md @@ -22,7 +22,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.smartctl_tests_long.conf* and add *SMARTCTL_TESTS_LONG_DEVICES="(nvme1 sdc sdf)"*. Notifications will be delivered via **notifier** for default block device **sda**. Examples can be found in */usr/share/doc/smart_tests_long*. +Create a *$HOME/.smartctl_tests_long.conf* and add *SMARTCTL_TESTS_LONG_DEVICES="(nvme1 sdc sdf)"*. Notifications will be delivered via **notifier** for default block device **sda**. Examples can be found in */usr/share/doc/system-helpers/smart_tests_long*. # EXIT VALUES **0** diff --git a/_man/src/system-helpers.1.md b/_man/src/system-helpers.1.md index e95c273..0f0fcea 100644 --- a/_man/src/system-helpers.1.md +++ b/_man/src/system-helpers.1.md @@ -22,5 +22,5 @@ shell scripts for common tasks. Provided systemd services mostly support notifications if they have failed via **systemd_failure_notify** which uses **notifier** (see **man notifier**). -See */usr/share/doc/system-helpers* for example configurations which should +See */usr/share/doc/system-helpers/system-helpers* for example configurations which should be copied inside **$HOME** or **/etc** depending on the helper script. \ No newline at end of file diff --git a/_man/src/systemd_check.1.md b/_man/src/systemd_check.1.md index 9456979..a5e073e 100644 --- a/_man/src/systemd_check.1.md +++ b/_man/src/systemd_check.1.md @@ -22,7 +22,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.systemd_check.conf* and add *SYSTEMD_CHECK_LIST_FILE="/other/path/to/list"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/systemd_check*. +Create a *$HOME/.systemd_check.conf* and add *SYSTEMD_CHECK_LIST_FILE="/other/path/to/list"*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/systemd_check*. # EXIT VALUES **0** diff --git a/_man/src/systemd_failure_notify.1.md b/_man/src/systemd_failure_notify.1.md index 2dec89b..25c378c 100644 --- a/_man/src/systemd_failure_notify.1.md +++ b/_man/src/systemd_failure_notify.1.md @@ -19,7 +19,7 @@ You can copy this script to */usr/local/bin* and use create a custom **CONFIG_FI # EXAMPLE -Create a *$HOME/.systemd_failure_notify.conf*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/systemd_failure_notify*. +Create a *$HOME/.systemd_failure_notify.conf*. Notifications will be delivered via **notifier**. Examples can be found in */usr/share/doc/system-helpers/systemd_failure_notify*. Then, add **systemd_failure_notify@serviceName** in a systemd unit file in the **OnFailure** directive: diff --git a/usr/local/bin/check_updates b/usr/local/bin/check_updates index 037bfdb..538dbb5 100755 --- a/usr/local/bin/check_updates +++ b/usr/local/bin/check_updates @@ -64,13 +64,12 @@ check_required() { type hostname &> /dev/null || { echo "Requiring 'hostname' but it's not installed"; exit 1; } } -CHECK_UPDATES_UPDATES=$(eval "${CHECK_UPDATES_UPDATES_CMD}") -CHECK_UPDATES_UPDATES_AMOUNT=$(eval "${CHECK_UPDATES_UPDATES_AMOUNT_CMD}") - source_config "$HOME/.check_updates.conf" "/etc/check_updates.conf" apply_defaults check_required +CHECK_UPDATES_UPDATES=$(eval "${CHECK_UPDATES_UPDATES_CMD}") +CHECK_UPDATES_UPDATES_AMOUNT=$(eval "${CHECK_UPDATES_UPDATES_AMOUNT_CMD}") HOSTNAME=$(hostname) if [[ "$CHECK_UPDATES_UPDATES_AMOUNT" -gt "0" ]]; then diff --git a/usr/local/bin/docker_check b/usr/local/bin/docker_check index 35d6c1b..3feaaa4 100755 --- a/usr/local/bin/docker_check +++ b/usr/local/bin/docker_check @@ -68,7 +68,7 @@ else fi if [[ ! -f $listFileToUse ]]; then - echo "$listFileToUse doesn't exist. Add a file which holds one systemd service or timer per line."; + echo "$listFileToUse doesn't exist. Add a file which holds one docker container or timer per line."; echo ""; usage; exit 1; diff --git a/usr/share/man/man1/check_updates.1 b/usr/share/man/man1/check_updates.1 index c50b97f..5359458 100644 --- a/usr/share/man/man1/check_updates.1 +++ b/usr/share/man/man1/check_updates.1 @@ -63,7 +63,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.check_updates.conf\f[R] and add \f[I]CHECK_UPDATES_UPDATES_CMD=\[lq]\&...\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/check_updates\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/check_updates\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/disk_space_alert.1 b/usr/share/man/man1/disk_space_alert.1 index 9c1cb7a..2896b30 100644 --- a/usr/share/man/man1/disk_space_alert.1 +++ b/usr/share/man/man1/disk_space_alert.1 @@ -60,7 +60,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.disk_space_alert.conf\f[R] and add \f[I]DISK_SPACE_ALERT_THRESHOLD=\[lq]95\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/disk_space_alert\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/disk_space_alert\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/docker_check.1 b/usr/share/man/man1/docker_check.1 index 89a8b24..583dc1b 100644 --- a/usr/share/man/man1/docker_check.1 +++ b/usr/share/man/man1/docker_check.1 @@ -67,7 +67,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.docker_check.conf\f[R] and add \f[I]DOCKER_CHECK_NOTIFY_LEVELS=\[lq](WARNING)\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/docker_check\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/docker_check\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/docker_compose_update.1 b/usr/share/man/man1/docker_compose_update.1 index 279839d..c54c73f 100644 --- a/usr/share/man/man1/docker_compose_update.1 +++ b/usr/share/man/man1/docker_compose_update.1 @@ -88,7 +88,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. .PP Create a \f[I]$HOME/.docker_compose_update.conf\f[R] and necessary configuration. -Examples can be found in \f[I]/usr/share/doc/docker_compose_update\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/docker_compose_update\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/dynv6.1 b/usr/share/man/man1/dynv6.1 index 11e24d7..8c5ca39 100644 --- a/usr/share/man/man1/dynv6.1 +++ b/usr/share/man/man1/dynv6.1 @@ -73,7 +73,7 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.dynv6.conf\f[R] and add \f[I]DYNV6_TOKEN=\[lq]mySecretToken\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/dynv6\f[R]. +Examples can be found in \f[I]/usr/share/doc/system-helpers/dynv6\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/memory_usage_alert.1 b/usr/share/man/man1/memory_usage_alert.1 index 81d5e50..4946365 100644 --- a/usr/share/man/man1/memory_usage_alert.1 +++ b/usr/share/man/man1/memory_usage_alert.1 @@ -51,7 +51,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.memory_usage_alert.conf\f[R] and add \f[I]MEMORY_USAGE_ALERT_THRESHOLD=\[lq]1024\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/memory_usage_alert\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/memory_usage_alert\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/notifier.1 b/usr/share/man/man1/notifier.1 index c0e140c..51e2f9d 100644 --- a/usr/share/man/man1/notifier.1 +++ b/usr/share/man/man1/notifier.1 @@ -64,7 +64,8 @@ Create a \f[I]$HOME/.notifier.conf\f[R] and add \f[I]NOTIFIER_MAIL_ADDRESS=\[lq]alias\[at]domain.tld\[rq]\f[R]. Notifications will be delivered to alias\[at]domain.tld or via gotify if enabled. -Examples can be found in \f[I]/usr/share/doc/notifier\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/notifier\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/smart_tests_long.1 b/usr/share/man/man1/smart_tests_long.1 index a8fa483..31d9eaf 100644 --- a/usr/share/man/man1/smart_tests_long.1 +++ b/usr/share/man/man1/smart_tests_long.1 @@ -55,7 +55,8 @@ Create a \f[I]$HOME/.smartctl_tests_long.conf\f[R] and add \f[I]SMARTCTL_TESTS_LONG_DEVICES=\[lq](nvme1 sdc sdf)\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R] for default block device \f[B]sda\f[R]. -Examples can be found in \f[I]/usr/share/doc/smart_tests_long\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/smart_tests_long\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/system-helpers.1 b/usr/share/man/man1/system-helpers.1 index 2a29cd4..113ad21 100644 --- a/usr/share/man/man1/system-helpers.1 +++ b/usr/share/man/man1/system-helpers.1 @@ -54,8 +54,8 @@ Provided systemd services mostly support notifications if they have failed via \f[B]systemd_failure_notify\f[R] which uses \f[B]notifier\f[R] (see \f[B]man notifier\f[R]). .PP -See \f[I]/usr/share/doc/system-helpers\f[R] for example configurations -which should be copied inside \f[B]$HOME\f[R] or \f[B]/etc\f[R] -depending on the helper script. +See \f[I]/usr/share/doc/system-helpers/system-helpers\f[R] for example +configurations which should be copied inside \f[B]$HOME\f[R] or +\f[B]/etc\f[R] depending on the helper script. .SH AUTHORS Alexander Sch\[:a]ferdiek. diff --git a/usr/share/man/man1/systemd_check.1 b/usr/share/man/man1/systemd_check.1 index aa18bd9..b5cb934 100644 --- a/usr/share/man/man1/systemd_check.1 +++ b/usr/share/man/man1/systemd_check.1 @@ -58,7 +58,8 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.systemd_check.conf\f[R] and add \f[I]SYSTEMD_CHECK_LIST_FILE=\[lq]/other/path/to/list\[rq]\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. -Examples can be found in \f[I]/usr/share/doc/systemd_check\f[R]. +Examples can be found in +\f[I]/usr/share/doc/system-helpers/systemd_check\f[R]. .SH EXIT VALUES .TP \f[B]0\f[R] diff --git a/usr/share/man/man1/systemd_failure_notify.1 b/usr/share/man/man1/systemd_failure_notify.1 index bfe0f68..ec70309 100644 --- a/usr/share/man/man1/systemd_failure_notify.1 +++ b/usr/share/man/man1/systemd_failure_notify.1 @@ -47,7 +47,7 @@ custom \f[B]CONFIG_FILE\f[R] as user. Create a \f[I]$HOME/.systemd_failure_notify.conf\f[R]. Notifications will be delivered via \f[B]notifier\f[R]. Examples can be found in -\f[I]/usr/share/doc/systemd_failure_notify\f[R]. +\f[I]/usr/share/doc/system-helpers/systemd_failure_notify\f[R]. .PP Then, add \f[B]systemd_failure_notify\[at]serviceName\f[R] in a systemd unit file in the \f[B]OnFailure\f[R] directive: