From bd470143221a72158104dc8ae87a43d92e3b8c91 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Tue, 11 Feb 2025 16:51:02 +0100
Subject: [PATCH] reboot: update markdown help
---
docs/20_Checks/check_reboot_required.md | 38 ++++++++++++++++++++++---
1 file changed, 34 insertions(+), 4 deletions(-)
diff --git a/docs/20_Checks/check_reboot_required.md b/docs/20_Checks/check_reboot_required.md
index 56406b4..7e7b6aa 100644
--- a/docs/20_Checks/check_reboot_required.md
+++ b/docs/20_Checks/check_reboot_required.md
@@ -20,16 +20,45 @@ From this repository ypu need next to this script:
`$ check_reboot_required [-h]`
-### Parameters
+```txt
+______________________________________________________________________
+
+CHECK_REBOOT_REQUIRED
+v1.5
+
+(c) Institute for Medical Education - University of Bern
+Licence: GNU GPL 3
+
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_reboot_required.html
+______________________________________________________________________
+
+Check if a reboot is required.
+It works for Centos and Debian/ Ubuntu and Manjaro
+
+If the reboot is required:
+
+* On Centos it shows the kernel number that will be installed,
+* On Debian/ Ubuntu it shows the packages that require the reboot,
+* On Manjaro it shows if a newer kernel or which libs require the reboot.
+ The check for libs uses lsof.
+
+If your distro is based on Arch, Centos or Debian then it easily can be added
+in the script if it does not work. Report the distro name to the author.
+
+SYNTAX:
+check_reboot_required
-```text
OPTIONS:
-h or --help show this help.
PARAMETERS:
- None
+ None.
+
+EXAMPLE:
+check_reboot_required
+
```
## Examples
@@ -54,5 +83,6 @@ WARNING: [centos] need to reboot for kernel package kernel is not installed (c
```txt
./check_reboot_required
-UNKNOWN: distro [manjaro] was detected but is not supported (yet).
+UNKNOWN: distro [otherlinux] was detected but is not supported (yet).
+If your distro is based on Arch, Centos or Debian then it easily can be added in the script. Report the distro name to the author.
```
--
GitLab