1.\" $NetBSD: ulimit.3,v 1.8 2008/04/30 13:10:50 martin Exp $ 2.\" 3.\" Copyright (c) 1999 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Klaus Klein. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd September 13, 1999 31.Dt ULIMIT 3 32.Os 33.Sh NAME 34.Nm ulimit 35.Nd get and set process limits 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In ulimit.h 40.Ft long int 41.Fn ulimit "int cmd" ... 42.Sh DESCRIPTION 43The 44.Fn ulimit 45function provides a method to query or alter resource limits of the calling 46process. 47The method to be performed is specified by the 48.Fa cmd 49argument; possible values are: 50.Bl -tag -width UL_GETFSIZEXX 51.It Li UL_GETFSIZE 52Return the soft file size limit of the process. 53The value returned is in units of 512-byte blocks. 54If the result cannot be represented in an object of type 55.Fa long int , 56the result is unspecified. 57.It Li UL_SETFSIZE 58Set the hard and soft file size limits of the process to the value of the 59second argument passed, which is in units of 512-byte blocks, and which is 60expected to be of type 61.Fa long int . 62The new file size limit of the process is returned. 63Any process may decrease the limit, but raising it is only permitted if 64the caller is the super-user. 65.El 66.Pp 67If successful, the 68.Fn ulimit 69function will not change the setting of 70.Va errno . 71.Pp 72The 73.Fn ulimit 74function is an obsolete interface; applications are encouraged to use 75.Xr getrlimit 2 76and 77.Xr setrlimit 2 78instead. 79.Sh RETURN VALUES 80If successful, the 81.Fn ulimit 82function returns the value of the requested limit. 83Otherwise, it returns \-1, sets 84.Va errno 85to indicate an error, and the limit is not changed. 86Therefore, to detect an error condition applications should set 87.Va errno 88to 0, call 89.Fn ulimit , 90and check if \-1 is returned and 91.Va errno 92is non-zero. 93.Sh ERRORS 94The 95.Fn ulimit 96function will fail if: 97.Bl -tag -width Er 98.It Bq Er EINVAL 99The 100.Fa cmd 101argument is not valid. 102.It Bq Er EPERM 103It was attempted to increase a limit, and the caller is not the super-user. 104.El 105.Sh SEE ALSO 106.Xr getrlimit 2 , 107.Xr setrlimit 2 108.Sh STANDARDS 109The 110.Fn ulimit 111function conforms to 112.St -xsh5 . 113