Introduce .Lb macro to libutil manpages
Sort .Nm values in some manpages Remove explicit note about compiling with -lutil, it's implicitly declared by .Lb macro now.
This commit is contained in:
parent
f36822867a
commit
e0ac996a75
@ -27,17 +27,13 @@
|
||||
.Nm setproctitle
|
||||
.Nd set the process title for
|
||||
.Xr ps 1
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft void
|
||||
.Fn setproctitle "const char *fmt" "..."
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn setproctitle
|
||||
|
@ -25,17 +25,13 @@
|
||||
.Sh NAME
|
||||
.Nm _secure_path
|
||||
.Nd determine if a file appears to be secure
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn _secure_path "const char *path" "uid_t uid" "gid_t gid"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
This function does some basic security checking on a given path.
|
||||
It is intended to be used by processes running with root privileges
|
||||
@ -71,7 +67,7 @@ to eliminate race conditions between use of this function and
|
||||
access to the file referenced.
|
||||
.Sh SEE ALSO
|
||||
.Xr lstat 2 ,
|
||||
.Xr syslog 3 .
|
||||
.Xr syslog 3
|
||||
.Sh HISTORY
|
||||
Code from which this function was derived was contributed to the
|
||||
.Fx
|
||||
|
@ -32,17 +32,13 @@
|
||||
.Nm auth_getval
|
||||
.Nd functions for reading values from
|
||||
.Pa /etc/auth.conf
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft char *
|
||||
.Fn auth_getval "const char *name"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
|
||||
The function
|
||||
@ -51,8 +47,8 @@ returns the value assocated with the field called
|
||||
.Fa name
|
||||
or NULL if no such field is found or the auth file cannot be opened.
|
||||
.Sh SEE ALSO
|
||||
.Xr properties_read 3 ,
|
||||
.Xr properties_free 3 ,
|
||||
.Xr properties_read 3 ,
|
||||
.Xr property_find 3 ,
|
||||
.Xr auth.conf 5
|
||||
.Sh FILES
|
||||
|
@ -44,12 +44,6 @@
|
||||
.Fa "FILE *stream" "size_t *len" "size_t *lineno"
|
||||
.Fa "const char delim[3]" "int flags"
|
||||
.Fc
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn fparseln
|
||||
|
@ -31,18 +31,14 @@
|
||||
.Sh NAME
|
||||
.Nm login
|
||||
.Nd "log a new login record to the utmp and wtmp files"
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <utmp.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft void
|
||||
.Fn login "struct utmp *ut"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn login
|
||||
|
@ -34,6 +34,8 @@
|
||||
.\" .Nm auth_hostok
|
||||
.\" .Nm auth_timesok
|
||||
.Nd authentication style support library for login class capabilities database.
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <login_cap.h>
|
||||
@ -57,12 +59,6 @@
|
||||
.\" .Fn auth_hostok "login_cap_t *lc" "const char *hostname" "char const *ip"
|
||||
.\" .Ft int
|
||||
.\" .Fn auth_timesok "login_cap_t *lc" "time_t now"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
This set of functions support the login class authorisation style interface provided
|
||||
by
|
||||
|
@ -23,19 +23,21 @@
|
||||
.Os FreeBSD
|
||||
.Dt LOGIN_CAP 3
|
||||
.Sh NAME
|
||||
.Nm login_getclassbyname ,
|
||||
.Nm login_close ,
|
||||
.Nm login_getclass ,
|
||||
.Nm login_getpwclass ,
|
||||
.Nm login_getuserclass ,
|
||||
.Nm login_getcapstr ,
|
||||
.Nm login_getcaplist ,
|
||||
.Nm login_getcaptime ,
|
||||
.Nm login_getcapnum ,
|
||||
.Nm login_getcapsize ,
|
||||
.Nm login_getcapbool ,
|
||||
.Nm login_getstyle
|
||||
.Nm login_getcaplist ,
|
||||
.Nm login_getcapnum ,
|
||||
.Nm login_getcapstr ,
|
||||
.Nm login_getcapsize ,
|
||||
.Nm login_getcaptime ,
|
||||
.Nm login_getclass ,
|
||||
.Nm login_getclassbyname ,
|
||||
.Nm login_getpwclass ,
|
||||
.Nm login_getstyle ,
|
||||
.Nm login_getuserclass
|
||||
.Nd functions for accessing the login class capabilities database.
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <login_cap.h>
|
||||
@ -65,12 +67,6 @@
|
||||
.Fn login_getcapbool "login_cap_t *lc" "const char *cap" "int def"
|
||||
.Ft char *
|
||||
.Fn login_getstyle "login_cap_t *lc" "char *style" "const char *auth"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
These functions represent a programming interface to the login
|
||||
classes database provided in
|
||||
@ -318,7 +314,8 @@ Case of the units suffix is ignored.
|
||||
Time values are normally used for setting resource, accounting and
|
||||
session limits.
|
||||
If supported by the operating system and compiler (which is true of
|
||||
FreeBSD), the value returned is a quad (long long), of type
|
||||
.Fx ),
|
||||
the value returned is a quad (long long), of type
|
||||
.Em rlim_t .
|
||||
A value "inf" or "infinity" may be used to express an infinite
|
||||
value, in which case RLIM_INFINITY is returned.
|
||||
|
@ -24,10 +24,12 @@
|
||||
.Dt LOGIN_CLASS 3
|
||||
.Sh NAME
|
||||
.Nm setclasscontext ,
|
||||
.Nm setusercontext ,
|
||||
.Nm setclassenvironment ,
|
||||
.Nm setclassresources ,
|
||||
.Nm setclassenvironment
|
||||
.Nm setusercontext
|
||||
.Nd functions for using the login class capabilities database.
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <login_cap.h>
|
||||
@ -39,12 +41,6 @@
|
||||
.Fn setclassresources "login_cap_t *lc"
|
||||
.Ft void
|
||||
.Fn setclassenvironment "login_cap_t *lc" "const struct passwd *pwd" "int paths"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
These functions provide a higher level interface to the login class
|
||||
database than those documented in
|
||||
|
@ -27,6 +27,8 @@
|
||||
.Nm auth_hostok ,
|
||||
.Nm auth_timeok
|
||||
.Nd functions for checking login class based login restrictions
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <time.h>
|
||||
@ -37,12 +39,6 @@
|
||||
.Fn auth_hostok "login_cap_t *lc" "const char *host" "char const *ip"
|
||||
.Ft int
|
||||
.Fn auth_timeok "login_cap_t *lc" "time_t t"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
This set of functions checks to see if login is allowed based on login
|
||||
class capability entries in the login database,
|
||||
|
@ -27,6 +27,8 @@
|
||||
.Nm in_ltm ,
|
||||
.Nm in_ltms
|
||||
.Nd functions for parsing and checking login time periods
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <time.h>
|
||||
@ -37,12 +39,6 @@
|
||||
.Fn in_ltm "const login_time_t *lt" "struct tm *t" "time_t *ends"
|
||||
.Ft int
|
||||
.Fn in_ltms "const login_time_t *lt" "struct tm *t" "time_t *ends"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
This set of functions may be used for parsing and checking login and
|
||||
session times against a predefined list of allowed login times as
|
||||
|
@ -31,16 +31,12 @@
|
||||
.Sh NAME
|
||||
.Nm login_tty
|
||||
.Nd prepare a tty for a new login session
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn login_tty "int fd"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn login_tty
|
||||
|
@ -31,17 +31,13 @@
|
||||
.Sh NAME
|
||||
.Nm logout
|
||||
.Nd remove an entry from the utmp file
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn logout "char *line"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn logout
|
||||
|
@ -31,17 +31,13 @@
|
||||
.Sh NAME
|
||||
.Nm logwtmp
|
||||
.Nd append a new record to the wtmp file
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft void
|
||||
.Fn logwtmp "const char *line" "const char *name" "const char *host"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn logwtmp
|
||||
|
@ -33,6 +33,8 @@
|
||||
.Nm propery_find ,
|
||||
.Nm properties_free
|
||||
.Nd functions to allow creating simple property lists from ASCII file data.
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
@ -42,12 +44,6 @@
|
||||
.Fn property_find "properties list" "const char *name"
|
||||
.Ft void
|
||||
.Fn properties_free "properties list"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
.nf
|
||||
typedef struct _properties {
|
||||
|
@ -32,6 +32,8 @@
|
||||
.Nm openpty ,
|
||||
.Nm forkpty
|
||||
.Nd auxiliary functions to obtain a pseudo-terminal
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <sys/ioctl.h>
|
||||
@ -41,12 +43,6 @@
|
||||
.Fn openpty "int *amaster" "int *aslave" "char *name" "struct termios *termp" "struct winsize *winp"
|
||||
.Ft int
|
||||
.Fn forkpty "int *amaster" "char *name" "struct termios *termp" "struct winsize *winp"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn openpty
|
||||
|
@ -30,18 +30,14 @@
|
||||
.Sh NAME
|
||||
.Nm realhostname
|
||||
.Nd "convert an IP number to the real host name"
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <netinet/in.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn realhostname "char *host" "size_t hsize" "const struct in_addr *ip"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn realhostname
|
||||
|
@ -57,18 +57,14 @@
|
||||
.Sh NAME
|
||||
.Nm realhostname_sa
|
||||
.Nd "convert an struct sockaddr to the real host name"
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <netinet/in.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn realhostname_sa "char *host" "size_t hsize" "struct sockaddr *addr" "int addrlen"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn realhostname_sa
|
||||
|
@ -27,17 +27,13 @@
|
||||
.Nm setproctitle
|
||||
.Nd set the process title for
|
||||
.Xr ps 1
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft void
|
||||
.Fn setproctitle "const char *fmt" "..."
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn setproctitle
|
||||
|
@ -30,17 +30,13 @@
|
||||
.Sh NAME
|
||||
.Nm trimdomain
|
||||
.Nd "trim the current domain name from a host name"
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft void
|
||||
.Fn trimdomain "char *fullhost" "int hostsize"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn trimdomain
|
||||
|
@ -33,6 +33,8 @@
|
||||
.Nm uu_unlock ,
|
||||
.Nm uu_lockerr
|
||||
.Nd acquire and release control of a serial device
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/types.h>
|
||||
.Fd #include <libutil.h>
|
||||
@ -44,12 +46,6 @@
|
||||
.Fn uu_unlock "const char *ttyname"
|
||||
.Ft const char *
|
||||
.Fn uu_lockerr "int uu_lockresult"
|
||||
.Pp
|
||||
Link with
|
||||
.Va -lutil
|
||||
on the
|
||||
.Xr cc 1
|
||||
command line.
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn uu_lock
|
||||
|
Loading…
Reference in New Issue
Block a user