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