lib/libcompat/4.1/getpw.3

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getpw.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libcompat/4.1/getpw.3,v 1.5.2.5 2001/12/17 10:08:28 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt GETPW 3
  37 .Os
  38 .Sh NAME
  39 .Nm getpw
  40 .Nd get name from uid
  41 .Sh LIBRARY
  42 .Lb libcompat
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .Ft int
  46 .Fn getpw "uid_t uid" "char *buf"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 The
  50 .Fn getpw
  51 function is made obsolete by
  52 .Xr getpwuid 3 .
  53 .Ef
  54 .Pp
  55 The
  56 .Fn getpw
  57 function reads the file
  58 .Pa /etc/passwd ,
  59 and if it finds
  60 the specified
  61 .Fa uid ,
  62 copies the password entry line into the string pointed to by
  63 .Fa buf .
  64 the null terminated entry line from the password database,
  65 and appends the
  66 .Dv NUL
  67 character.
  68 .Sh RETURN VALUES
  69 The
  70 .Fn getpw
  71 function returns the zero if successful, otherwise
  72 a non-zero if the entry does not exist.
  73 .Sh FILES
  74 .Bl -tag -width /etc/passwd -compact
  75 .It Pa /etc/passwd
  76 .El
  77 .Sh SEE ALSO
  78 .Xr getpwent 3 ,
  79 .Xr passwd 5
  80 .Sh HISTORY
  81 A
  82 .Fn getpw
  83 function appeared in
  84 .At v6 .
  85 .Sh BUGS
  86 The area pointed to by
  87 .Fa buf
  88 must be large enough to hold the user name.
  89 .Pp
  90 All of the bugs from
  91 .Xr getpwent 3
  92 hold valid as well.