diff options
author | ru <ru@FreeBSD.org> | 2004-07-02 23:52:20 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2004-07-02 23:52:20 +0000 |
commit | 01548ace1533487f9c0488f55112c9d8641f8184 (patch) | |
tree | 23294a96f715e1e5bc35c1029ec151c90ee95b96 /lib/libutil | |
parent | 47f5e31e2bb626743fa9e912918201fe505b1419 (diff) | |
download | FreeBSD-src-01548ace1533487f9c0488f55112c9d8641f8184.zip FreeBSD-src-01548ace1533487f9c0488f55112c9d8641f8184.tar.gz |
Mechanically kill hard sentence breaks.
Diffstat (limited to 'lib/libutil')
-rw-r--r-- | lib/libutil/auth.conf.5 | 3 | ||||
-rw-r--r-- | lib/libutil/login.3 | 6 | ||||
-rw-r--r-- | lib/libutil/login.conf.5 | 2 | ||||
-rw-r--r-- | lib/libutil/login_cap.3 | 2 | ||||
-rw-r--r-- | lib/libutil/login_ok.3 | 4 | ||||
-rw-r--r-- | lib/libutil/login_times.3 | 4 | ||||
-rw-r--r-- | lib/libutil/login_tty.3 | 6 | ||||
-rw-r--r-- | lib/libutil/logout.3 | 3 | ||||
-rw-r--r-- | lib/libutil/property.3 | 9 | ||||
-rw-r--r-- | lib/libutil/pty.3 | 18 | ||||
-rw-r--r-- | lib/libutil/realhostname.3 | 3 | ||||
-rw-r--r-- | lib/libutil/realhostname_sa.3 | 3 | ||||
-rw-r--r-- | lib/libutil/trimdomain.3 | 6 | ||||
-rw-r--r-- | lib/libutil/uucplock.3 | 12 |
14 files changed, 52 insertions, 29 deletions
diff --git a/lib/libutil/auth.conf.5 b/lib/libutil/auth.conf.5 index c80d067..0d1c0b9 100644 --- a/lib/libutil/auth.conf.5 +++ b/lib/libutil/auth.conf.5 @@ -26,7 +26,8 @@ contains various attributes important to the authentication code, most notably .Xr kerberos 5 -for the time being. This documentation will be updated as the +for the time being. +This documentation will be updated as the .Pa /etc/auth.conf file, which is very new, evolves. .Sh SEE ALSO diff --git a/lib/libutil/login.3 b/lib/libutil/login.3 index de13139..d88f719 100644 --- a/lib/libutil/login.3 +++ b/lib/libutil/login.3 @@ -49,7 +49,8 @@ entry being passed into the appropriate slot of the file, and appends it to the .Xr wtmp 5 -file. The calling process must have permission to write to both files. +file. +The calling process must have permission to write to both files. .Sh RETURN VALUES None. .Sh SEE ALSO @@ -60,6 +61,7 @@ None. .Sh BUGS The interface provided by .Fn login -is rather crude. The caller must know about the details of a +is rather crude. +The caller must know about the details of a .Va struct utmp . Some better abstraction needs to be worked out. diff --git a/lib/libutil/login.conf.5 b/lib/libutil/login.conf.5 index c3b91cf..e5e0d68 100644 --- a/lib/libutil/login.conf.5 +++ b/lib/libutil/login.conf.5 @@ -105,7 +105,7 @@ home directories etc.) A numeric value, either decimal (default), hexadecimal (with leading 0x), or octal (with a leading 0). With a numeric type, only one numeric value is allowed. -Numeric types may also be specified in string format (ie. the capability +Numeric types may also be specified in string format (i.e., the capability tag being delimited from the value by '=' instead of '#'). Whichever method is used, then all records in the database must use the same method to allow values to be correctly overridden in interpolated diff --git a/lib/libutil/login_cap.3 b/lib/libutil/login_cap.3 index b3a2d66..07fda65 100644 --- a/lib/libutil/login_cap.3 +++ b/lib/libutil/login_cap.3 @@ -369,7 +369,7 @@ kilobytes, megabytes, gigabytes, and on systems that support the .Ar long long type, terabytes. The suffix used determines the units, and multiple values and -units may be used in combination (e.g. 1m500k = 1.5 megabytes). +units may be used in combination (e.g.\& 1m500k = 1.5 megabytes). A value with no suffix is interpreted as bytes, B as 512-byte blocks, K as kilobytes, M as megabytes, G as gigabytes and T as terabytes. diff --git a/lib/libutil/login_ok.3 b/lib/libutil/login_ok.3 index c005e5d..8a6f291 100644 --- a/lib/libutil/login_ok.3 +++ b/lib/libutil/login_ok.3 @@ -64,7 +64,7 @@ tty group (see .Xr ttys 5 ) is not in the list. Access to ttys may be allowed or restricted specifically by tty device -name, a device name which includes a wildcard (e.g. ttyD* or cuaD*), +name, a device name which includes a wildcard (e.g.\& ttyD* or cuaD*), or may name a ttygroup, when group=<name> tags have been assigned in .Pa /etc/ttys . Matching of ttys and ttygroups is case sensitive. @@ -90,7 +90,7 @@ The function is used for matching, and the matching on hostnames is case insensitive. Note that this function expects that the hostname is fully expanded -(i.e. the local domain name added if necessary) and the IP address +(i.e., the local domain name added if necessary) and the IP address is in its canonical form. No hostname or address lookups are attempted. .Pp diff --git a/lib/libutil/login_times.3 b/lib/libutil/login_times.3 index 9419c7f..e1f57ce 100644 --- a/lib/libutil/login_times.3 +++ b/lib/libutil/login_times.3 @@ -96,7 +96,7 @@ and one bit unused. A series .Em LTM_* macros may be used for testing bits individually and in combination. -If no bits are set in this field - ie. it contains the value +If no bits are set in this field - i.e., it contains the value .Em LTM_NONE - then the entire period is assumed invalid. This is used as a convention to mark the termination of an array @@ -142,7 +142,7 @@ function returns a filled in structure of type login_time_t containing the parsed time period. If a parsing error occurs, the lt_dow field is set to .Em LTM_NONE -(i.e. 0). +(i.e., 0). .Pp The .Fn in_ltm diff --git a/lib/libutil/login_tty.3 b/lib/libutil/login_tty.3 index b7111e7..6303d68 100644 --- a/lib/libutil/login_tty.3 +++ b/lib/libutil/login_tty.3 @@ -40,11 +40,13 @@ .Sh DESCRIPTION The function .Fn login_tty -prepares a terminal for a new login session. The file descriptor +prepares a terminal for a new login session. +The file descriptor .Ar fd passed to .Fn login_tty -must be opened for reading and writing on a terminal device. It will be +must be opened for reading and writing on a terminal device. +It will be made the controlling terminal for the calling process, after allocating a new session with .Xr setsid 2 . diff --git a/lib/libutil/logout.3 b/lib/libutil/logout.3 index 2fe2d4f..426fe08 100644 --- a/lib/libutil/logout.3 +++ b/lib/libutil/logout.3 @@ -45,7 +45,8 @@ searches the .Xr utmp 5 file for the slot described by .Ar line -(usually a tty name). If such a slot could be found, it will be updated +(usually a tty name). +If such a slot could be found, it will be updated with a record where the .Em name and diff --git a/lib/libutil/property.3 b/lib/libutil/property.3 index d9b5d12..e5acef3 100644 --- a/lib/libutil/property.3 +++ b/lib/libutil/property.3 @@ -67,7 +67,8 @@ The .Fn property_find function returns the associated value string for the property named .Fa name -if found, otherwise NULL. The value returned may be up to +if found, otherwise NULL. +The value returned may be up to .Dv PROPERTY_MAX_VALUE bytes in length. .Pp @@ -84,9 +85,11 @@ where is an alphanumeric string (and any punctuation not including the `=' character) and .Fa value -is an arbitary string of text terminated by a newline character. If newlines +is an arbitary string of text terminated by a newline character. +If newlines are desired, the entire value should be enclosed in { } (curly-bracket) -characters. Any line beginning with a # or ; character is assumed to +characters. +Any line beginning with a # or ; character is assumed to be a comment and will be ignored. .Sh SEE ALSO .Xr auth_getval 3 diff --git a/lib/libutil/pty.3 b/lib/libutil/pty.3 index 19cf9f7..35f0b82 100644 --- a/lib/libutil/pty.3 +++ b/lib/libutil/pty.3 @@ -62,7 +62,8 @@ If the argument is not .Dv NULL , .Fn openpty -copies the pathname of the slave pty to this area. The caller is +copies the pathname of the slave pty to this area. +The caller is responsible for allocating the required space in this array. .Pp If the arguments @@ -86,12 +87,16 @@ The .Fn forkpty function first calls .Fn openpty -to obtain the next available pseudo-terminal from the system. Upon success, -it forks off a new process. In the child process, it closes the descriptor +to obtain the next available pseudo-terminal from the system. +Upon success, +it forks off a new process. +In the child process, it closes the descriptor for the master side of the pty, and calls .Xr login_tty 3 -for the slave pty. In the parent process, it closes the descriptor for the -slave side of the pty. The arguments +for the slave pty. +In the parent process, it closes the descriptor for the +slave side of the pty. +The arguments .Fa amaster , .Fa name , .Fa termp , @@ -133,7 +138,8 @@ may set it to any value as described for .Xr group 5 .Sh BUGS The calling process must have an effective UID of super-user in order -to perform all the intended actions. No notification will occur if +to perform all the intended actions. +No notification will occur if .Fn openpty or .Fn forkpty diff --git a/lib/libutil/realhostname.3 b/lib/libutil/realhostname.3 index 37b166a..e5cdbf1 100644 --- a/lib/libutil/realhostname.3 +++ b/lib/libutil/realhostname.3 @@ -43,7 +43,8 @@ The function .Fn realhostname converts .Ar ip -to the corresponding host name. This is done by resolving +to the corresponding host name. +This is done by resolving .Ar ip to a host name and then ensuring that the host name resolves back to diff --git a/lib/libutil/realhostname_sa.3 b/lib/libutil/realhostname_sa.3 index 72340aa..773c4af 100644 --- a/lib/libutil/realhostname_sa.3 +++ b/lib/libutil/realhostname_sa.3 @@ -72,7 +72,8 @@ The function .Fn realhostname_sa converts .Ar addr -to the corresponding host name. This is done by resolving +to the corresponding host name. +This is done by resolving .Ar addr to a host name and then ensuring that the host name resolves back to diff --git a/lib/libutil/trimdomain.3 b/lib/libutil/trimdomain.3 index 66b8369..f01e884 100644 --- a/lib/libutil/trimdomain.3 +++ b/lib/libutil/trimdomain.3 @@ -44,10 +44,12 @@ removes the current domain name from the passed .Ar fullhost name by writing a .Dv NUL -character over the first period of the passed name. The current domain +character over the first period of the passed name. +The current domain name is determined by calling .Xr gethostname 3 -and removing everything up to the first period. The name is determined +and removing everything up to the first period. +The name is determined the first time this function is called and is cached for future use. .Pp The diff --git a/lib/libutil/uucplock.3 b/lib/libutil/uucplock.3 index a69af95..d901831 100644 --- a/lib/libutil/uucplock.3 +++ b/lib/libutil/uucplock.3 @@ -127,7 +127,8 @@ the reason for failure is returned. .Fn uu_lockerr uses the current value of .Va errno -to determine the exact error. Care should be made not to allow +to determine the exact error. +Care should be made not to allow .Va errno to be changed between calls to .Fn uu_lock @@ -138,7 +139,8 @@ and may return any of the following values: .Pp .Dv UU_LOCK_OK : -The transfer was successful. The specified process now holds the device +The transfer was successful. +The specified process now holds the device lock. .Pp .Dv UU_LOCK_OWNER_ERR : @@ -152,7 +154,8 @@ If .Fn uu_lock returns one of the error values above, the global value .Va errno -can be used to determine the cause. Refer to the respective manual pages +can be used to determine the cause. +Refer to the respective manual pages for further details. .Pp .Fn uu_unlock @@ -174,6 +177,7 @@ the stale lock. .Pp The calling process must have write permissions to the .Pa /var/spool/lock -directory. There is no mechanism in place to ensure that the +directory. +There is no mechanism in place to ensure that the permissions of this directory are the same as those of the serial devices that might be locked. |