.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::ResourceLimits 3pm"
.TH Mail::SpamAssassin::Plugin::ResourceLimits 3pm 2024-04-02 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mail::SpamAssassin::Plugin::ResourceLimits \- Limit the memory and/or CPU of child spamd processes
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  # This plugin is for admin only and cannot be specified in user config.
\&  loadplugin     Mail::SpamAssassin::Plugin::ResourceLimits
\&
\&  # Sets to RLIMIT_CPU from BSD::Resource. The quota is based on max CPU Time seconds.
\&  resource_limit_cpu 120
\&
\&  # Sets to RLIMIT_RSS and RLIMIT_AS via BSD::Resource.
\&  resource_limit_cpu 536870912
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module leverages BSD::Resource to assure your spamd child processes do not exceed
specified CPU or memory limit. If this happens, the child process will die.
See the BSD::Resource for more details.
.PP
NOTE: Because this plugin uses BSD::Resource, it will not function on Windows.
.SH "ADMINISTRATOR SETTINGS"
.IX Header "ADMINISTRATOR SETTINGS"
.IP "resource_limit_cpu 120    (default: 0 or no limit)" 4
.IX Item "resource_limit_cpu 120 (default: 0 or no limit)"
How many cpu cycles are allowed on this process before it dies.
.IP "resource_limit_mem 536870912    (default: 0 or no limit)" 4
.IX Item "resource_limit_mem 536870912 (default: 0 or no limit)"
The maximum number of bytes of memory allowed both for:
.RS 4
.IP \(bu 4
(virtual) address space bytes
.IP \(bu 4
resident set size
.RE
.RS 4
.RE