PERFORCE change 188469 for review

[Edward Tomasz Napierala]

http://p4web.freebsd.org/@@188469?ac=10

Change 188469 by trasz at trasz_victim on 2011/02/02 21:02:49

	Improve the manual page even more.

Affected files ...

.. //depot/projects/soc2009/trasz_limits/usr.bin/rctl/rctl.8#7 edit

Differences ...

==== //depot/projects/soc2009/trasz_limits/usr.bin/rctl/rctl.8#7 (text+ko) ====

@@ -90,18 +90,16 @@
 It can be either process, user, login class, or jail.
 .Pp
 Subject ID identifies the subject.  It can be user name,
-login class name, or a numerical UID, or JID.
+numerical user ID, login class name, or numerical jail ID.
 .Pp
 Resource identifies the resource the rule controls.
 .Pp
 Action defines what will happen when a process exceeds the allowed amount.
-It can be either deny, delay, log, sighup, sigint, sigkill, sigsegv, sigxcpu,
-or sigxfsz.
 .Pp
 Amount defines how much of the resource a process can use before
 the defined action triggers.
 .Pp
-The per field defines what entity the limit gets accounted for.
+The per field defines what entity the amount gets accounted for.
 For example, rule "loginclass:users:vmem:deny=100M/process" means
 that each process of any user belonging to login class "users" may allocate
 up to 100MB of virtual memory.
@@ -117,9 +115,10 @@
 .Pp
 A filter is a rule for which one of more fields other than per is left empty.
 For example, a filter that matches every rule could be written as ":::=/",
-or, in short, ":".  A filter that matches all the login classes would be
-"loginclass:".  A filter that matches all defined limits for maxprocesses
-resource would be "::maxprocesses".
+or, in short, ":".
+A filter that matches all the login classes would be "loginclass:".
+A filter that matches all defined rules for maxprocesses resource would be
+"::maxprocesses".
 .Pp
 .Sh RESOURCES
 .Bl -column -offset 3n "msgqqueued"
@@ -167,6 +166,22 @@
 .Pp
 .Sh EXIT STATUS
 .Ex -std
+.Sh EXAMPLES
+.Dl rctl -a user:joe:vmem:deny=1g
+.Pp
+Prevent user "joe" from allocating more than 1GB of virtual memory.
+.Pp
+.Dl rctl -r :
+.Pp
+Remove all RCTL rules.
+.Pp
+.Dl rctl -hu jail:5
+.Pp
+Display resource usage information for jail with JID 5.
+.Pp
+.Dl rctl -l process:512
+.Pp
+Display all the rules applicable to process with PID 512.
 .Sh SEE ALSO
 .Xr jailstat 8 ,
 .Xr userstat 8