dist/openpam/doc/man/openpam_readline.3

   1 .\"     $NetBSD: openpam_readline.3,v 1.4 2006/02/05 02:37:45 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
   6 .\" All rights reserved.
   7 .\"
   8 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   9 .\" Network Associates Laboratories, the Security Research Division of
  10 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
  11 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. The name of the author may not be used to endorse or promote
  22 .\"    products derived from this software without specific prior written
  23 .\"    permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  40 .Dt OPENPAM_READLINE 3
  41 .Os
  42 .Sh NAME
  43 .Nm openpam_readline
  44 .Nd read a line from a file
  45 .Sh LIBRARY
  46 .Lb libpam
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In security/pam_appl.h
  50 .In security/openpam.h
  51 .Ft "char *"
  52 .Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp"
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 function reads a line from a file, and returns it
  57 in a NUL-terminated buffer allocated with
  58 .Xr malloc 3 .
  59 .Pp
  60 The
  61 .Nm
  62 function performs a certain amount of processing
  63 on the data it reads.
  64 Comments (introduced by a hash sign) are stripped, as is leading and
  65 trailing whitespace.
  66 Any amount of linear whitespace is collapsed to a single space.
  67 Blank lines are ignored.
  68 If a line ends in a backslash, the backslash is stripped and the next
  69 line is appended.
  70 .Pp
  71 If
  72 .Fa lineno
  73 is not
  74 .Dv NULL ,
  75 the integer variable it points to is
  76 incremented every time a newline character is read.
  77 .Pp
  78 If
  79 .Fa lenp
  80 is not
  81 .Dv NULL ,
  82 the length of the line (not including the
  83 terminating NUL character) is stored in the variable it points to.
  84 .Pp
  85 The caller is responsible for releasing the returned buffer by passing
  86 it to
  87 .Xr free 3 .
  88 .Sh RETURN VALUES
  89 The
  90 .Nm
  91 function returns
  92 .Dv NULL
  93 on failure.
  94 .Sh SEE ALSO
  95 .Xr free 3 ,
  96 .Xr malloc 3 ,
  97 .Xr pam 3
  98 .Sh STANDARDS
  99 The
 100 .Nm
 101 function is an OpenPAM extension.
 102 .Sh AUTHORS
 103 The
 104 .Nm
 105 function and this manual page were developed for the
 106 .Fx
 107 Project by ThinkSec AS and Network Associates Laboratories, the
 108 Security Research Division of Network Associates, Inc.\& under
 109 DARPA/SPAWAR contract N66001-01-C-8035
 110 .Pq Dq CBOSS ,
 111 as part of the DARPA CHATS research program.