1.\" Copyright (c) 2002 Kyle Martin. All rights reserved. 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 6.\" 1. Redistributions of source code must retain the above copyright 7.\" notice, this list of conditions and the following disclaimer. 8.\" 2. Redistributions in binary form must reproduce the above copyright 9.\" notice, this list of conditions and the following disclaimer in the 10.\" documentation and/or other materials provided with the distribution. 11.\" 12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 15.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 22.\" SUCH DAMAGE. 23.\" 24.\" $FreeBSD$ 25.\" 26.Dd August 8, 2002 27.Dt ULIMIT 3 28.Os 29.Sh NAME 30.Nm ulimit 31.Nd get and set process limits 32.Sh LIBRARY 33.Lb libc 34.Sh SYNOPSIS 35.In ulimit.h 36.Ft long 37.Fn ulimit "int cmd" "..." 38.Sh DESCRIPTION 39The 40.Fn ulimit 41function will get and set process limits. 42Currently this is limited to the maximum file size. 43The 44.Va cmd 45parameter is one of the following: 46.Pp 47.Bl -tag -offset -width UL_GETSIZE 48.It Dv UL_GETSIZE 49will return the maximum file size in units of 512 blocks of 50the current process. 51.Pp 52.It Dv UL_SETSIZE 53will attempt to set the maximum file size of the current 54process and its children with the second argument expressed as a long. 55.El 56.Sh RETURN VALUES 57Upon successful completion, 58.Fn ulimit 59returns the value requested; 60otherwise the value -1 is returned and 61.Ar errno 62is set to indicate the error. 63.Sh ERRORS 64The 65.Fn ulimit 66function will fail if: 67.Bl -tag -width Er 68.It Bq Er EINVAL 69The command specified was invalid. 70.It Bq Er EPERM 71The limit specified to 72.Fn ulimit 73would have raised the maximum limit value, 74and the caller is not the super-user. 75.El 76.Sh SEE ALSO 77.Xr getrlimit 2 78.Sh STANDARDS 79The 80.Fn ulimit 81function conforms to 82.St -p1003.1-2001 . 83.Sh HISTORY 84The 85.Fn ulimit 86function first appeared in 87.Fx 5.0 . 88.Sh BUGS 89The 90.Fn ulimit 91function provides limited precision for 92setting and retrieving process limits. 93If there is a need for greater precision than the 94type 95.Vt long 96provides, the 97.Xr getrlimit 2 98and 99.Xr setrlimit 2 100functions should be considered. 101