sail.6: mdoc conversion
[dragonfly.git] / lib / libutil / login_auth.3
1 .\" Copyright (c) 1995 David Nugent <davidn@blaze.net.au>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, is permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice immediately at the beginning of the file, without modification,
9 .\"    this list of conditions, and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. This work was done expressly for inclusion into FreeBSD.  Other use
14 .\"    is permitted provided this notation is included.
15 .\" 4. Absolutely no warranty of function or purpose is made by the author
16 .\"    David Nugent.
17 .\" 5. Modifications may be freely made to this file providing the above
18 .\"    conditions are met.
19 .\"
20 .\" $FreeBSD: src/lib/libutil/login_auth.3,v 1.9.2.4 2001/12/17 10:08:32 ru Exp $
21 .\"
22 .Dd December 29, 1996
23 .Dt LOGIN_AUTH 3
24 .Os
25 .Sh NAME
26 .\" .Nm authenticate
27 .\" .Nm auth_script
28 .\" .Nm auth_env
29 .\" .Nm auth_scan
30 .\" .Nm auth_rmfiles
31 .Nm auth_checknologin ,
32 .Nm auth_cat
33 .\" .Nm auth_ttyok
34 .\" .Nm auth_hostok
35 .\" .Nm auth_timesok
36 .Nd "authentication style support library for login class capabilities database"
37 .Sh LIBRARY
38 .Lb libutil
39 .Sh SYNOPSIS
40 .In sys/types.h
41 .In login_cap.h
42 .\" .Ft int
43 .\". Fn authenticate "const char *name" "const char *classname" "const char *style" "const char *service"
44 .\" .Ft int
45 .\" .Fn auth_script "const char * path" ...
46 .\" .Ft void
47 .\" .Fn auth_env "void"
48 .\" .Ft int
49 .\" .Fn auth_scan "int ok"
50 .\" .Ft void
51 .\" .Fn auth_rmfiles "void"
52 .Ft void
53 .Fn auth_checknologin "login_cap_t *lc"
54 .Ft int
55 .Fn auth_cat "const char *file"
56 .\" .Ft int
57 .\" .Fn auth_ttyok "login_cap_t *lc" "const char *tty"
58 .\" .Ft int
59 .\" .Fn auth_hostok "login_cap_t *lc" "const char *hostname" "char const *ip"
60 .\" .Ft int
61 .\" .Fn auth_timesok "login_cap_t *lc" "time_t now"
62 .Sh DESCRIPTION
63 This set of functions support the login class authorisation style interface provided
64 by
65 .Xr login.conf 5 .
66 .\" .Sh RETURN VALUES
67 .Sh SEE ALSO
68 .Xr getcap 3 ,
69 .Xr login_cap 3 ,
70 .Xr login_class 3 ,
71 .Xr login.conf 5 ,
72 .Xr termcap 5