libutil: Fix a bunch of manual page issues.
authorSascha Wildner <saw@online.de>
Tue, 11 Feb 2014 10:43:51 +0000 (11:43 +0100)
committerSascha Wildner <saw@online.de>
Tue, 11 Feb 2014 10:44:13 +0000 (11:44 +0100)
lib/libutil/flopen.3
lib/libutil/fparseln.3
lib/libutil/humanize_number.3
lib/libutil/login_cap.3
lib/libutil/login_class.3
lib/libutil/pidfile.3
lib/libutil/pw_util.3

index c3d97e8..5b4e1b4 100644 (file)
@@ -69,7 +69,7 @@ and the file is already locked,
 will fail and set
 .Va errno
 to
-.Dv EWOULDBLOCK .
+.Er EWOULDBLOCK .
 .Pp
 As with
 .Fn open ,
index a634722..227206d 100644 (file)
@@ -37,6 +37,7 @@
 .Sh LIBRARY
 .Lb libutil
 .Sh SYNOPSIS
+.In sys/types.h
 .In stdio.h
 .In libutil.h
 .Ft "char *"
@@ -122,7 +123,6 @@ Remove escape preceding any other character.
 .It Dv FPARSELN_UNESCALL
 All of the above.
 .El
-.Pp
 .El
 .Sh RETURN VALUES
 Upon successful completion a pointer to the parsed line is returned;
index d308485..43299fc 100644 (file)
 .Dt HUMANIZE_NUMBER 3
 .Os
 .Sh NAME
-
 .Nm dehumanize_number ,
 .Nm humanize_number
 .Nd format a number into a human readable form and vice versa
 .Sh LIBRARY
 .Lb libutil
 .Sh SYNOPSIS
+.In sys/types.h
 .In libutil.h
 .Ft int
 .Fn dehumanize_number "const char *str" "int64_t *result"
@@ -72,7 +72,7 @@ then divide
 by 1024 until it will.
 In this case, prefix
 .Fa suffix
-with the appropriate designator.
+with the appropriate SI designator.
 The
 .Fn humanize_number
 function follows the traditional computer science conventions by
@@ -174,7 +174,7 @@ The provided string may hold one of the suffixes, which will be interpreted
 and used to scale up its accompanying numerical value.
 .Sh RETURN VALUES
 Upon success, the
-.Nm
+.Fn humanize_number
 function returns the number of characters that would have been stored in
 .Fa buf
 (excluding the terminating
@@ -210,6 +210,7 @@ The string in
 .Fa str
 represented a number that does not fit in
 .Fa result .
+.El
 .Sh STANDARDS
 The
 .Dv HN_DIVISOR_1000
index 4a9d5dd..286e7e9 100644 (file)
@@ -184,7 +184,7 @@ field is used internally by the library to contain the
 expanded login capabilities record.
 Programs with unusual requirements may wish to use this
 with the lower-level
-.Fn getcap
+.Xr getcap 3
 style functions to access the record directly.
 .Pp
 The
index 278a9e5..2345912 100644 (file)
@@ -39,7 +39,7 @@
 .Fn setusercontext "login_cap_t *lc" "const struct passwd *pwd" "uid_t uid" "unsigned int flags"
 .Ft void
 .Fn setclassresources "login_cap_t *lc"
-.Ft int
+.Ft void
 .Fn setclassenvironment "login_cap_t *lc" "const struct passwd *pwd" "int paths"
 .Sh DESCRIPTION
 These functions provide a higher level interface to the login class
@@ -171,12 +171,11 @@ and
 functions are subsets of the setcontext functions above, but may
 be useful in isolation.
 .Sh RETURN VALUES
-.Fn setclassenvironment
-,
+The
 .Fn setclasscontext
 and
 .Fn setusercontext
-return -1 if an error occurred, or 0 on success.
+functions return -1 if an error occurred, or 0 on success.
 If an error occurs when attempting to set the user, login, group
 or resources, a message is reported to
 .Xr syslog 3 ,
index 8d70ebd..639543f 100644 (file)
@@ -46,7 +46,7 @@
 .Ft int
 .Fn pidfile_remove "struct pidfh *pfh"
 .Ft int
-.Fn pidfile_fileno "struct pidfh *pfh"
+.Fn pidfile_fileno "const struct pidfh *pfh"
 .Sh DESCRIPTION
 The
 .Nm pidfile
index 1655c9b..2241dea 100644 (file)
@@ -58,7 +58,7 @@
 .Ft void
 .Fn pw_fini "void"
 .Ft int
-.Fn pw_init "const char *dir" const char *master"
+.Fn pw_init "const char *dir" "const char *master"
 .Ft "char *"
 .Fn pw_make "const struct passwd *pw"
 .Ft "char *"
@@ -222,7 +222,7 @@ and it is the caller's responsibility to free it with
 The
 .Fn pw_mkdb
 function regenerates the password database by running
-.Xr pw_mkdb 8 .
+.Xr pwd_mkdb 8 .
 If
 .Fa user
 only the record corresponding to that user will be updated.
@@ -283,4 +283,4 @@ DARPA/SPAWAR contract N66001-01-C-8035
 as part of the DARPA CHATS research program.
 .Pp
 This manual page was written by
-.An Baptiste Daroussin Aq bapt@FreeBSD.org .
+.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org .