diff options
Diffstat (limited to 'memeat.1')
| -rw-r--r-- | memeat.1 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/memeat.1 b/memeat.1 new file mode 100644 index 0000000..acdf7cd --- /dev/null +++ b/memeat.1 @@ -0,0 +1,20 @@ +.TH memeat 1 "2021-10-08" +.SH NAME +memeat \- allocates memory until killed +.SH SYNOPSIS +.SY memeat +.RI [ maximum ] +.YS +.SH DESCRIPTION +This program will allocate all available memory mebibyte by mebibyte over some time. If optional +.I maximum +is provided, then program will terminate after reaching this amount of allocated memory in mebibytes. In case this +value is invalid or does not make sense, then program will not attempt to consume the memory, and will indicate a +failure in the exit status. +.SH EXIT STATUS +Program is expected to be terminated externally, so exit status may depend on the execution environment. If +.I maximum +is specified, then 0 will be returned after reaching the boundary, or 1 will be returned if the provided argument +could not be understood. +.SH SEE ALSO +.BR free (3) |