system-helpers/usr/share/man/man1/memory_usage_alert.1

.\" Automatically generated by Pandoc 3.0.1
.\"
.\" 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 "memory_usage_alert" "1" "January 2023" "memory_usage_alert" ""
.hy
.SH NAME
.PP
memory_usage_alert - Checks available memory and sends out
notifications.
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]memory_usage_alert\f[R]
.SH DESCRIPTION
.PP
\f[B]memory_usage_alert\f[R] checks available memory and sends
notifications if certain limits are reached.
It comes with systemd services.
.PP
By default, \f[B]memory_usage_alert\f[R] tries to read from
\f[I]$HOME/.memory_usage_alert.conf\f[R] and
\f[I]/etc/memory_usage_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 are optional or have reasonable defaults: -
\f[B]MEMORY_USAGE_ALERT_THRESHOLD=512\f[R] threshold to warn about (in
\f[I]megabytes\f[R])
.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/.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/system-helpers/memory_usage_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äferdiek.