summary refs log tree commit diff
path: root/Doc/Zsh/params.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@zsh.org>2016-06-13 16:06:22 +0100
committerPeter Stephenson <pws@zsh.org>2016-06-13 16:06:22 +0100
commit3859aac04e6331a939e3d6b33431ba24fb68e055 (patch)
tree2bac8760a1408953551e4bcacffab6cd260d3123 /Doc/Zsh/params.yo
parent7badf262c1a33c8c5f7ee8ccc152733fcb5a05f7 (diff)
downloadzsh-3859aac04e6331a939e3d6b33431ba24fb68e055.tar.gz
zsh-3859aac04e6331a939e3d6b33431ba24fb68e055.tar.xz
zsh-3859aac04e6331a939e3d6b33431ba24fb68e055.zip
users/21632: Use of REPORTMEMORY variable
If the child's resisdent set size in megabytes exceeds this, print
out the resource (TIMEFMT) string.  Document you need to add memory
usage to this by hand.
Diffstat (limited to 'Doc/Zsh/params.yo')
-rw-r--r--Doc/Zsh/params.yo14
1 files changed, 14 insertions, 0 deletions
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index d23c459a0..b02d24efe 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -1390,6 +1390,20 @@ item(tt(READNULLCMD) <S>)(
 The command name to assume if a single input redirection
 is specified with no command.  Defaults to tt(more).
 )
+vindex(REPORTMEMORY)
+item(tt(REPORTMEMORY))(
+If nonnegative, commands whose maximum resident set size (roughly
+speaking, main memory usage) in megabytes is greater than this
+value have timing statistics reported.  The format used to output
+statistics is the value of the tt(TIMEFMT) parameter, which is the same
+as for the tt(REPORTTIME) variable and the tt(time) builtin; note that
+by default this does not output memory usage.  Appending
+tt(" max RSS %M") to the value of tt(TIMEFMT) causes it to output the
+value that triggered the report.  If tt(REPORTTIME) is also in use,
+at most a single report is printed for both triggers.  This feature
+requires the tt(getrusage()) system call, commonly supported by modern
+Unix-like systems.
+)
 vindex(REPORTTIME)
 item(tt(REPORTTIME))(
 If nonnegative, commands whose combined user and system execution times