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