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 .\" $DragonFly: src/lib/libcompat/4.1/getpw.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETPW 3
  38 .Os
  39 .Sh NAME
  40 .Nm getpw
  41 .Nd get name from uid
  42 .Sh LIBRARY
  43 .Lb libcompat
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .Ft int
  47 .Fn getpw "uid_t uid" "char *buf"
  48 .Sh DESCRIPTION
  49 .Bf -symbolic
  50 The
  51 .Fn getpw
  52 function is made obsolete by
  53 .Xr getpwuid 3 .
  54 .Ef
  55 .Pp
  56 The
  57 .Fn getpw
  58 function reads the file
  59 .Pa /etc/passwd ,
  60 and if it finds
  61 the specified
  62 .Fa uid ,
  63 copies the password entry line into the string pointed to by
  64 .Fa buf .
  65 the null terminated entry line from the password database,
  66 and appends the
  67 .Dv NUL
  68 character.
  69 .Sh RETURN VALUES
  70 The
  71 .Fn getpw
  72 function returns the zero if successful, otherwise
  73 a non-zero if the entry does not exist.
  74 .Sh FILES
  75 .Bl -tag -width /etc/passwd -compact
  76 .It Pa /etc/passwd
  77 .El
  78 .Sh SEE ALSO
  79 .Xr getpwent 3 ,
  80 .Xr passwd 5
  81 .Sh HISTORY
  82 A
  83 .Fn getpw
  84 function appeared in
  85 .At v6 .
  86 .Sh BUGS
  87 The area pointed to by
  88 .Fa buf
  89 must be large enough to hold the user name.
  90 .Pp
  91 All of the bugs from
  92 .Xr getpwent 3
  93 hold valid as well.