.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "disk_space_alert" "1" "January 2023" "disk_space_alert" ""
.hy
.SH NAME
.PP
disk_space_alert - Checks available disk space and notifies.
Configuration is done in environment files.
.PD 0
.P
.PD
It\[cq]s part of \f[B]system-helpers\f[R].
.SH SYNOPSIS
.PP
\f[B]disk_space_alert\f[R]
.SH DESCRIPTION
.PP
\f[B]disk_space_alert\f[R] checks available diskspace for configured
\f[B]mounts\f[R] and notifies if certain limits are reached.
It comes with systemd services.
.PP
By default, \f[B]disk_space_alert\f[R] tries to read from
\f[I]$HOME/.disk_space_alert.conf\f[R] and
\f[I]/etc/disk_space_alert.conf\f[R] for configuration.
It will exit with a non-zero exit code if it cannot find a proper
configuration file.
.PP
The following can be customized:
.PD 0
.P
.PD
- \f[B]DISK_SPACE_ALERT_THRESHOLD=93\f[R] in percentage.
.PD 0
.P
.PD
- \f[B]DISK_SPACE_ALERT_MOUNTPOINTS=(\[lq]/\[rq])\f[R] is an array of
mountpoints.
.PD 0
.P
.PD
.PP
You can copy this script to \f[I]/usr/local/bin\f[R] and use create a
custom \f[B]CONFIG_FILE\f[R] as user.
.SH EXAMPLE
.PP
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].
.SH EXIT VALUES
.TP
\f[B]0\f[R]
Success
.TP
\f[B]1\f[R]
Error
.SH SEE ALSO
.PP
\f[B]notifier\f[R] - used as notification application
.SH AUTHORS
Alexander Sch\[:a]ferdiek.