[apple/system_cmds.git] / memory_pressure.tproj / memory_pressure.1

.\" Copyright (c) 2013, Apple Inc.  All rights reserved.
.\"
.Dd Mar 7, 2013
.Dt MEMORY_PRESSURE 1
.Os "Mac OS X"
.Sh NAME
.Nm memory_pressure
.Nd Tool to apply real or simulate memory pressure on the system.
.Sh SYNOPSIS
.Pp
.Nm memory_pressure [-l level] | [-p percent_free] | [-S -l level]
.Sh OPTIONS
.Pp
.Ar -l <level>  
Apply real or simulate memory pressure (if specified alongside simulate argument) on the system till low memory notifications corresponding to <level> are generated. Supported values are "warn" and "critical".
.Pp
.Ar -p <percent_free>    
Allocate memory till the available memory in the system is <percent_free> of total memory. If the percentage of available memory to total memory on the system drops, the tool will free memory till either the desired percentage is achieved or it runs out of memory to free.
.Pp
.Ar -S   
Simulate memory pressure on the system by placing it artificially for <sleep_seconds> duration at the "warn" or "critical" level.
.Pp
.Ar -s <sleep_seconds>   
Duration to wait before allocating or freeing memory if applying real pressure. In case of simulating memory pressure, this is the duration the system will be maintained at an artifical memory level.
.Sh DESCRIPTION
A tool to apply real or simulate memory pressure on the system
.Sh SEE ALSO
.Xr vm_stat 1
Commit	Line	Data
fc6d9e4b A	1	.\" Copyright (c) 2013, Apple Inc. All rights reserved.
	2	.\"
	3	.Dd Mar 7, 2013
	4	.Dt MEMORY_PRESSURE 1
	5	.Os "Mac OS X"
	6	.Sh NAME
	7	.Nm memory_pressure
	8	.Nd Tool to apply real or simulate memory pressure on the system.
	9	.Sh SYNOPSIS
	10	.Pp
	11	.Nm memory_pressure [-l level] \| [-p percent_free] \| [-S -l level]
	12	.Sh OPTIONS
	13	.Pp
	14	.Ar -l <level>
	15	Apply real or simulate memory pressure (if specified alongside simulate argument) on the system till low memory notifications corresponding to <level> are generated. Supported values are "warn" and "critical".
	16	.Pp
	17	.Ar -p <percent_free>
	18	Allocate memory till the available memory in the system is <percent_free> of total memory. If the percentage of available memory to total memory on the system drops, the tool will free memory till either the desired percentage is achieved or it runs out of memory to free.
	19	.Pp
	20	.Ar -S
	21	Simulate memory pressure on the system by placing it artificially for <sleep_seconds> duration at the "warn" or "critical" level.
	22	.Pp
	23	.Ar -s <sleep_seconds>
	24	Duration to wait before allocating or freeing memory if applying real pressure. In case of simulating memory pressure, this is the duration the system will be maintained at an artifical memory level.
	25	.Sh DESCRIPTION
	26	A tool to apply real or simulate memory pressure on the system
	27	.Sh SEE ALSO
	28	.Xr vm_stat 1