From ee2509d1a240d24d3c8ff0c0ca8e25c710dbbfa2 Mon Sep 17 00:00:00 2001 From: Edward Tomasz Napierala Date: Thu, 14 Apr 2011 18:37:27 +0000 Subject: [PATCH] Add manual page for rctl.conf(5). --- share/man/man5/Makefile | 1 + share/man/man5/rctl.conf.5 | 74 ++++++++++++++++++++++++++++++++++++++ usr.bin/rctl/rctl.8 | 3 +- 3 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 share/man/man5/rctl.conf.5 diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile index 7aad66b907e5..fdf3b3311f0e 100644 --- a/share/man/man5/Makefile +++ b/share/man/man5/Makefile @@ -57,6 +57,7 @@ MAN= acct.5 \ protocols.5 \ quota.user.5 \ rc.conf.5 \ + rctl.conf.5 \ regdomain.5 \ reiserfs.5 \ remote.5 \ diff --git a/share/man/man5/rctl.conf.5 b/share/man/man5/rctl.conf.5 new file mode 100644 index 000000000000..3bcc6141575d --- /dev/null +++ b/share/man/man5/rctl.conf.5 @@ -0,0 +1,74 @@ +.\" Copyright (c) 2011 Edward Tomasz Napierala +.\" Copyright (c) 1999 Chris Costello +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd April 14, 2011 +.Dt RCTL.CONF 5 +.Os +.Sh NAME +.Nm rctl.conf +.Nd resource limits database defaults +.Sh DESCRIPTION +The +.Pa /etc/rctl.conf +file is read in when the system goes into multi-user mode to set default +contents of the RCTL database. +The +.Pa /etc/rctl.conf +is in the format of the +.Xr rctl 8 +command, i.e.\& +.Bd -literal -offset indent +subject:subject-id:resource:action=amount/per +.Ed +.Pp +Comments are denoted by a +.Dq # +at the beginning of a line. +Comments can also exist at the end of a line, +as seen in the +.Sx EXAMPLES +section, below. +.Sh FILES +.Bl -tag -width /etc/rctl.conf -compact +.It Pa /etc/rctl.conf +Initial settings for +.Xr rctl 8 . +.El +.Sh EXAMPLES +To limit the number of processes for users in login class "testing", +use a rule like +.Bd -literal -offset indent +# Resource limits for the "testing" class. +loginclass:testing:nproc:deny=100/user # At most 100 processes per user +.Ed +.Sh SEE ALSO +.Xr rctl 8 +.Sh HISTORY +The +.Nm +file appeared in +.Fx 9.0 . diff --git a/usr.bin/rctl/rctl.8 b/usr.bin/rctl/rctl.8 index 75cc28a1bb47..f30f4c3f024f 100644 --- a/usr.bin/rctl/rctl.8 +++ b/usr.bin/rctl/rctl.8 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 30, 2011 +.Dd April 14, 2011 .Dt RCTL 8 .Os .Sh NAME @@ -185,6 +185,7 @@ Display resource usage information for jail with JID 5. .Pp Display all the rules applicable to process with PID 512. .Sh SEE ALSO +.Xr rctl.conf 5 , .Xr jailstat 8 , .Xr userstat 8 .Sh HISTORY