xref: /dflybsd-src/contrib/openpam/doc/man/openpam_readline.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from openpam_readline.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: openpam_readline.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt OPENPAM_READLINE 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm openpam_readline
8ade90846SJoerg Sonnenberger.Nd read a line from a file
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11577efdeeSPeter Avalos.In stdio.h
12ade90846SJoerg Sonnenberger.In security/pam_appl.h
13ade90846SJoerg Sonnenberger.In security/openpam.h
14ade90846SJoerg Sonnenberger.Ft "char *"
15ade90846SJoerg Sonnenberger.Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp"
16ade90846SJoerg Sonnenberger.Sh DESCRIPTION
17577efdeeSPeter Avalos.Bf Sy
18577efdeeSPeter AvalosThis function is deprecated and may be removed in a future release without further warning.
19ade90846SJoerg SonnenbergerThe
20577efdeeSPeter Avalos.Fn openpam_readlinev
21577efdeeSPeter Avalosfunction may be used to achieve similar results.
22577efdeeSPeter Avalos.Ef
23577efdeeSPeter Avalos.Pp
24577efdeeSPeter AvalosThe
25577efdeeSPeter Avalos.Fn openpam_readline
26ade90846SJoerg Sonnenbergerfunction reads a line from a file, and returns it
27ade90846SJoerg Sonnenbergerin a NUL-terminated buffer allocated with
28ade90846SJoerg Sonnenberger.Xr malloc 3 .
29ade90846SJoerg Sonnenberger.Pp
30ade90846SJoerg SonnenbergerThe
31577efdeeSPeter Avalos.Fn openpam_readline
32ade90846SJoerg Sonnenbergerfunction performs a certain amount of processing
33a474e9feSPeter Avaloson the data it reads:
34a474e9feSPeter Avalos.Bl -bullet
35a474e9feSPeter Avalos.It
36577efdeeSPeter AvalosComments (introduced by a hash sign) are stripped.
37a474e9feSPeter Avalos.It
38ade90846SJoerg SonnenbergerBlank lines are ignored.
39a474e9feSPeter Avalos.It
40a474e9feSPeter AvalosIf a line ends in a backslash, the backslash is stripped and the
41a474e9feSPeter Avalosnext line is appended.
42a474e9feSPeter Avalos.El
43ade90846SJoerg Sonnenberger.Pp
44ade90846SJoerg SonnenbergerIf
45ade90846SJoerg Sonnenberger.Fa lineno
46ade90846SJoerg Sonnenbergeris not
47ade90846SJoerg Sonnenberger.Dv NULL ,
48ade90846SJoerg Sonnenbergerthe integer variable it points to is
49ade90846SJoerg Sonnenbergerincremented every time a newline character is read.
50ade90846SJoerg Sonnenberger.Pp
51ade90846SJoerg SonnenbergerIf
52ade90846SJoerg Sonnenberger.Fa lenp
53ade90846SJoerg Sonnenbergeris not
54ade90846SJoerg Sonnenberger.Dv NULL ,
55ade90846SJoerg Sonnenbergerthe length of the line (not including the
56ade90846SJoerg Sonnenbergerterminating NUL character) is stored in the variable it points to.
57ade90846SJoerg Sonnenberger.Pp
58ade90846SJoerg SonnenbergerThe caller is responsible for releasing the returned buffer by passing
59ade90846SJoerg Sonnenbergerit to
60ade90846SJoerg Sonnenberger.Xr free 3 .
61577efdeeSPeter Avalos.Pp
62ade90846SJoerg Sonnenberger.Sh RETURN VALUES
63ade90846SJoerg SonnenbergerThe
64577efdeeSPeter Avalos.Fn openpam_readline
65ade90846SJoerg Sonnenbergerfunction returns
66ade90846SJoerg Sonnenberger.Dv NULL
67ade90846SJoerg Sonnenbergeron failure.
68ade90846SJoerg Sonnenberger.Sh SEE ALSO
69577efdeeSPeter Avalos.Xr openpam_readlinev 3 ,
70577efdeeSPeter Avalos.Xr openpam_readword 3 ,
71ade90846SJoerg Sonnenberger.Xr pam 3
72ade90846SJoerg Sonnenberger.Sh STANDARDS
73ade90846SJoerg SonnenbergerThe
74577efdeeSPeter Avalos.Fn openpam_readline
75ade90846SJoerg Sonnenbergerfunction is an OpenPAM extension.
76ade90846SJoerg Sonnenberger.Sh AUTHORS
77ade90846SJoerg SonnenbergerThe
78577efdeeSPeter Avalos.Fn openpam_readline
79577efdeeSPeter Avalosfunction and this manual page were
80577efdeeSPeter Avalosdeveloped for the
81ade90846SJoerg Sonnenberger.Fx
82577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
83f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
84ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
85ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
86ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
8710b5fe87SSascha Wildner.Pp
8810b5fe87SSascha WildnerThe OpenPAM library is maintained by
8910b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
90