xref: /openbsd/usr.sbin/npppd/npppd/npppd-users.5 (revision 73471bf0)
1.\"	$OpenBSD: npppd-users.5,v 1.9 2019/09/02 21:18:41 deraadt Exp $
2.\"
3.\" Copyright (c) 2012 YASUOKA Masahiko <yasuoka@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\" The following requests are required for all man pages.
17.\"
18.Dd $Mdocdate: September 2 2019 $
19.Dt NPPPD-USERS 5
20.Os
21.Sh NAME
22.Nm npppd-users
23.Nd user database file
24.Sh DESCRIPTION
25The
26.Nm
27file describes
28the various attributes of users.
29Refer to
30.Xr cgetent 3
31for a description of the file layout.
32Each entry in the database is used to describe one user.
33The record name is the username.
34The following attributes can be specified:
35.Bl -column "framed-ip-network"
36.It Sy Name Ta Sy Description
37.It password Ta
38User's password.
39Some characters are needed to be represented by the escape sequence.
40See
41.Xr cgetent 3
42for the escape sequence.
43.It framed-ip-address Ta
44IPv4 address to be assigned for the user.
45.It framed-ip-netmask Ta
46IPv4 netmask to be used for the user.
47.It calling-number Ta
48Calling phone number to check user's phone number.
49.El
50.Sh FILES
51.Bl -tag -width "/etc/npppd/npppd-users"
52.It Pa /etc/npppd/npppd-users
53User database file.
54.El
55.Sh EXAMPLES
56.Bd -literal
57taro:\\
58    :password=taro's password:\\
59    :framed-ip-address=192.168.0.101:
60
61hana:\\
62    :password=hana's password:\\
63    :framed-ip-address=192.168.0.102:
64.Ed
65.Sh SEE ALSO
66.Xr cgetent 3 ,
67.Xr npppd.conf 5 ,
68.Xr npppd 8
69.Sh BUGS
70Colon
71.Pq Sq \&:
72characters or vertical bar
73.Pq Sq |
74characters cannot be used in the username.
75