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