Sat Jul 11 14:18:08 2015 UTC ()
Clean-up documentation of login.conf(5)

Remove redundant word "limit" from sentences "Maximum ...".
Note that vmemoryuse might specify both maximum and current limits.
Remove redundant 'in bytes' from the description of vmemoryuse, it's noted
in the next section describing the argument type 'size'.

Changes inspired by <riastradh> in PR xsrc/49912


(kamil)
diff -r1.30 -r1.31 src/share/man/man5/login.conf.5
cvs diff -r1.30 -r1.31 src/share/man/man5/login.conf.5 (expand / switch to unified diff)

--- src/share/man/man5/login.conf.5 2015/07/11 09:54:06 1.30
+++ src/share/man/man5/login.conf.5 2015/07/11 14:18:08 1.31
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: login.conf.5,v 1.30 2015/07/11 09:54:06 wiz Exp $ 1.\" $NetBSD: login.conf.5,v 1.31 2015/07/11 14:18:08 kamil Exp $
2.\" 2.\"
3.\" Copyright (c) 1995,1996,1997 Berkeley Software Design, Inc. 3.\" Copyright (c) 1995,1996,1997 Berkeley Software Design, Inc.
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" Redistribution and use in source and binary forms, with or without 6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions 7.\" modification, are permitted provided that the following conditions
8.\" are met: 8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright 9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer. 10.\" notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in the 12.\" notice, this list of conditions and the following disclaimer in the
13.\" documentation and/or other materials provided with the distribution. 13.\" documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software 14.\" 3. All advertising materials mentioning features or use of this software
@@ -84,39 +84,39 @@ from the value. @@ -84,39 +84,39 @@ from the value.
84The types are described after the capability table. 84The types are described after the capability table.
85.Bl -column minpasswordlen program default 85.Bl -column minpasswordlen program default
86.It Sy Name Type Default Description 86.It Sy Name Type Default Description
87.\" 87.\"
88.sp 88.sp
89.It Sy copyright Ta file Ta "" Ta 89.It Sy copyright Ta file Ta "" Ta
90File containing additional copyright information. 90File containing additional copyright information.
91(If the file exists, 91(If the file exists,
92.Xr login 1 92.Xr login 1
93displays it before the welcome message.) 93displays it before the welcome message.)
94.\" 94.\"
95.sp 95.sp
96.It Sy coredumpsize Ta size Ta "" Ta 96.It Sy coredumpsize Ta size Ta "" Ta
97Maximum coredump size limit. 97Maximum coredump size.
98.\" 98.\"
99.sp 99.sp
100.It Sy cputime Ta time Ta "" Ta 100.It Sy cputime Ta time Ta "" Ta
101CPU usage limit. 101CPU usage limit.
102.\" 102.\"
103.sp 103.sp
104.It Sy datasize Ta size Ta "" Ta 104.It Sy datasize Ta size Ta "" Ta
105Maximum data size limit. 105Maximum data size.
106.\" 106.\"
107.sp 107.sp
108.It Sy filesize Ta size Ta "" Ta 108.It Sy filesize Ta size Ta "" Ta
109Maximum file size limit. 109Maximum file size.
110.\" 110.\"
111.sp 111.sp
112.It Sy host.allow Ta string Ta "" Ta 112.It Sy host.allow Ta string Ta "" Ta
113A comma-separated list of host name or IP address patterns 113A comma-separated list of host name or IP address patterns
114from which a class is allowed access. 114from which a class is allowed access.
115Access is instead denied from any hosts preceded 115Access is instead denied from any hosts preceded
116by 116by
117.Sq Li \&! . 117.Sq Li \&! .
118Patterns can contain the 118Patterns can contain the
119.Xr sh 1 Ns -style 119.Xr sh 1 Ns -style
120.Sq Li * 120.Sq Li *
121and 121and
122.Sq Li \&? 122.Sq Li \&?
@@ -163,31 +163,31 @@ Maximum number of login attempts allowed @@ -163,31 +163,31 @@ Maximum number of login attempts allowed
163Number of login attempts after which to start random back-off. 163Number of login attempts after which to start random back-off.
164.\" 164.\"
165.sp 165.sp
166.It Sy maxproc Ta number Ta "" Ta 166.It Sy maxproc Ta number Ta "" Ta
167Maximum number of processes. 167Maximum number of processes.
168.\" 168.\"
169.sp 169.sp
170.It Sy maxthread Ta number Ta "" Ta 170.It Sy maxthread Ta number Ta "" Ta
171Maximum number of threads. 171Maximum number of threads.
172The first thread of each process is not counted against this. 172The first thread of each process is not counted against this.
173.\" 173.\"
174.sp 174.sp
175.It Sy memorylocked Ta size Ta "" Ta 175.It Sy memorylocked Ta size Ta "" Ta
176Maximum locked in core memory size limit. 176Maximum locked in core memory size.
177.\" 177.\"
178.sp 178.sp
179.It Sy memoryuse Ta size Ta "" Ta 179.It Sy memoryuse Ta size Ta "" Ta
180Maximum in core memoryuse size limit. 180Maximum in core memoryuse size.
181.\" 181.\"
182.sp 182.sp
183.It Sy minpasswordlen Ta number Ta "" Ta 183.It Sy minpasswordlen Ta number Ta "" Ta
184The minimum length a local password may be. 184The minimum length a local password may be.
185Used by the 185Used by the
186.Xr passwd 1 186.Xr passwd 1
187utility. 187utility.
188.\" 188.\"
189.sp 189.sp
190.It Sy nologin Ta file Ta "" Ta 190.It Sy nologin Ta file Ta "" Ta
191If the file exists it will be displayed 191If the file exists it will be displayed
192and the login session will be terminated. 192and the login session will be terminated.
193.\" 193.\"
@@ -219,92 +219,93 @@ warn the user of this. @@ -219,92 +219,93 @@ warn the user of this.
219.br 219.br
220Default search path. 220Default search path.
221.\" 221.\"
222.sp 222.sp
223.It Sy priority Ta number Ta "" Ta 223.It Sy priority Ta number Ta "" Ta
224Initial priority (nice) level. 224Initial priority (nice) level.
225.\" 225.\"
226.sp 226.sp
227.It Sy requirehome Ta bool Ta Li false Ta 227.It Sy requirehome Ta bool Ta Li false Ta
228Require home directory to login. 228Require home directory to login.
229.\" 229.\"
230.sp 230.sp
231.It Sy sbsize Ta size Ta "" Ta 231.It Sy sbsize Ta size Ta "" Ta
232Maximum socket buffer size limit. 232Maximum socket buffer size.
233.\" 233.\"
234.sp 234.sp
235.It Sy setenv Ta list Ta "" Ta 235.It Sy setenv Ta list Ta "" Ta
236Comma or whitespace separated list 236Comma or whitespace separated list
237of environment variables and values to be set. 237of environment variables and values to be set.
238Commas and whitespace can be escaped using \e\e. 238Commas and whitespace can be escaped using \e\e.
239.\" 239.\"
240.sp 240.sp
241.It Sy shell Ta program Ta "" Ta 241.It Sy shell Ta program Ta "" Ta
242Session shell to execute rather than the shell specified in the password file. 242Session shell to execute rather than the shell specified in the password file.
243The 243The
244.Ev SHELL 244.Ev SHELL
245environment variable will contain the shell specified in the password file. 245environment variable will contain the shell specified in the password file.
246.\" 246.\"
247.sp 247.sp
248.It Sy stacksize Ta size Ta "" Ta 248.It Sy stacksize Ta size Ta "" Ta
249Maximum stack size limit. 249Maximum stack size.
250.\" 250.\"
251.sp 251.sp
252.It Sy tc Ta string Ta "" Ta 252.It Sy tc Ta string Ta "" Ta
253A "continuation" entry, which must be the last capability provided. 253A "continuation" entry, which must be the last capability provided.
254More capabilities are read from the named entry. 254More capabilities are read from the named entry.
255The capabilities given before 255The capabilities given before
256.Sy tc 256.Sy tc
257override those in the entry invoked by 257override those in the entry invoked by
258.Sy tc . 258.Sy tc .
259.\" 259.\"
260.sp 260.sp
261.It Sy term Ta string Ta Li su Ta 261.It Sy term Ta string Ta Li su Ta
262Default terminal type if not able to determine from other means. 262Default terminal type if not able to determine from other means.
263.\" 263.\"
264.sp 264.sp
265.It Sy umask Ta number Ta Li 022 Ta 265.It Sy umask Ta number Ta Li 022 Ta
266Initial umask. 266Initial umask.
267Should always have a leading 267Should always have a leading
268.Li 0 268.Li 0
269to assure octal interpretation. 269to assure octal interpretation.
270See 270See
271.Xr umask 2 . 271.Xr umask 2 .
272.\" 272.\"
273.sp 273.sp
274.It Sy vmemoryuse Ta size Ta "" Ta 274.It Sy vmemoryuse Ta size Ta "" Ta
275Maximum virtual address space size in bytes. 275Maximum virtual address space size.
276.\" 276.\"
277.sp 277.sp
278.It Sy welcome Ta file Ta Li /etc/motd Ta 278.It Sy welcome Ta file Ta Li /etc/motd Ta
279File containing welcome message. 279File containing welcome message.
280.Xr login 1 280.Xr login 1
281displays this and 281displays this and
282.Xr sshd 8 282.Xr sshd 8
283sends this. 283sends this.
284.El 284.El
285.Pp 285.Pp
286The resource limit entries 286The resource limit entries
287.Sy ( coredumpsize , 287.Sy ( coredumpsize ,
288.Sy cputime , 288.Sy cputime ,
289.Sy datasize , 289.Sy datasize ,
290.Sy filesize , 290.Sy filesize ,
291.Sy maxproc , 291.Sy maxproc ,
292.Sy memorylocked , 292.Sy memorylocked ,
293.Sy memoryuse , 293.Sy memoryuse ,
294.Sy openfiles , 294.Sy openfiles ,
295.Sy sbsize , 295.Sy sbsize ,
 296.Sy stacksize
296and 297and
297.Sy stacksize ) 298.Sy vmemoryuse )
298actually specify both the maximum and current limits (see 299actually specify both the maximum and current limits (see
299.Xr getrlimit 2 ) . 300.Xr getrlimit 2 ) .
300The current limit is the one normally used, 301The current limit is the one normally used,
301although the user is permitted to increase the current limit to the 302although the user is permitted to increase the current limit to the
302maximum limit. 303maximum limit.
303The maximum and current limits may be specified individually by appending 304The maximum and current limits may be specified individually by appending
304a 305a
305.Sq Sy \-max 306.Sq Sy \-max
306or 307or
307.Sq Sy \-cur 308.Sq Sy \-cur
308to the capability name (e.g., 309to the capability name (e.g.,
309.Sy openfiles-max 310.Sy openfiles-max
310and 311and