2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" All rights reserved.
5 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
6 .\" Network Associates Laboratories, the Security Research Division of
7 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8 .\" ("CBOSS"), as part of the DARPA CHATS research program.
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\" notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\" notice, this list of conditions and the following disclaimer in the
17 .\" documentation and/or other materials provided with the distribution.
18 .\" 3. The name of the author may not be used to endorse or promote
19 .\" products derived from this software without specific prior written
22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .Dt OPENPAM_READLINE 3
41 .Nd read a line from a file
46 .In security/pam_appl.h
47 .In security/openpam.h
49 .Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp"
53 function reads a line from a file, and returns it
54 in a NUL-terminated buffer allocated with
59 function performs a certain amount of processing
61 Comments (introduced by a hash sign) are stripped, as is leading and
63 Any amount of linear whitespace is collapsed to a single space.
64 Blank lines are ignored.
65 If a line ends in a backslash, the backslash is stripped and the next
72 the integer variable it points to is
73 incremented every time a newline character is read.
79 the length of the line (not including the
80 terminating NUL character) is stored in the variable it points to.
82 The caller is responsible for releasing the returned buffer by passing
98 function is an OpenPAM extension.
102 function and this manual page were developed for the
104 Project by ThinkSec AS and Network Associates Laboratories, the
105 Security Research Division of Network Associates, Inc.& under
106 DARPA/SPAWAR contract N66001-01-C-8035
108 as part of the DARPA CHATS research program.