draft/man3/getpw.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sat Jul 24 19:23:25 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de)
  29 .\"
  30 .\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
  31 .\"     all rights reserved.
  32 .\" Translated 1997-12-19, HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
  33 .\" Modified 1999-12-08, Kentaro Shirakata <argrath@yo.rim.or.jp>
  34 .\" Modified 2005-09-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  35 .\" Modified 2008-07-23, Kentaro Shirakata <argrath@ub32.org>
  36 .\"
  37 .TH GETPW 3 2010-10-21 "GNU" "Linux Programmer's Manual"
  38 .\"O .SH NAME
  39 .SH Ì¾Á°
  40 .\"O getpw \- Re-construct password line entry
  41 getpw \- ¥Ñ¥¹¥ï¡¼¥É¹Ô¥¨¥ó¥È¥ê¤ò¼èÆÀ¤¹¤ë
  42 .\"O .SH SYNOPSIS
  43 .SH ½ñ¼°
  44 .nf
  45 .\"O .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  46 .BR "#define _GNU_SOURCE" "             /* feature_test_macros(7) »²¾È */"
  47 .B #include <sys/types.h>
  48 .B #include <pwd.h>
  49 .sp
  50 .BI "int getpw(uid_t " uid ", char *" buf );
  51 .fi
  52 .\"O .SH DESCRIPTION
  53 .SH ÀâÌÀ
  54 .\"O The
  55 .\"O .BR getpw ()
  56 .\"O function reconstructs the password line entry for
  57 .\"O the given user ID \fIuid\fP in the buffer \fIbuf\fP.
  58 .\"O The returned buffer contains a line of format
  59 .BR getpw ()
  60 ´Ø¿ô¤Ï¡¢¥Ð¥Ã¥Õ¥¡ \fIbuf\fP ¤Ë»ØÄê¥æ¡¼¥¶ ID  \fIuid\fP ¤Î
  61 ¥Ñ¥¹¥ï¡¼¥É¹Ô¥¨¥ó¥È¥ê¤ò¼èÆÀ¤¹¤ë¡£
  62 ÊÖ¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡¤Ï¡¢°Ê²¼¤Î·Á¼°¤Î¹Ô¤ò´Þ¤à¡£
  63 .sp
  64 .in +4n
  65 .B name:passwd:uid:gid:gecos:dir:shell
  66 .in
  67 .PP
  68 .\"O The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  69 \fIpasswd\fP ¹½Â¤ÂÎ¤Ï \fI<pwd.h>\fP ¤Ç°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë:
  70 .sp
  71 .in +4n
  72 .nf
  73 struct passwd {
  74     char   *pw_name;       /* username */
  75     char   *pw_passwd;     /* user password */
  76     uid_t   pw_uid;        /* user ID */
  77     gid_t   pw_gid;        /* group ID */
  78     char   *pw_gecos;      /* user information */
  79     char   *pw_dir;        /* home directory */
  80     char   *pw_shell;      /* shell program */
  81 };
  82 .fi
  83 .in
  84 .PP
  85 .\"O For more information about the fields of this structure, see
  86 .\"O .BR passwd (5).
  87 ¤³¤Î¹½Â¤ÂÎ¤Î¥Õ¥£¡¼¥ë¥É¤Î¾ÜºÙ¤Ï
  88 .BR passwd (5)
  89 ¤ò»²¾È¤Î¤³¤È¡£
  90 .\"O .SH "RETURN VALUE"
  91 .SH ÊÖ¤êÃÍ
  92 .\"O The
  93 .\"O .BR getpw ()
  94 .\"O function returns 0 on success; on error, it returns \-1, and
  95 .\"O .I errno
  96 .\"O is set to indicate the error.
  97 .BR getpw ()
  98 ´Ø¿ô¤Ï¡¢À®¸ù¤·¤¿¾ì¹ç 0 ¤òÊÖ¤¹; ¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç \-1 ¤òÊÖ¤·¡¢¥¨¥é¡¼¤ò
  99 ¼¨¤¹¤¿¤á¤Ë
 100 .I error
 101 ¤¬¥»¥Ã¥È¤µ¤ì¤ë¡£
 102 .\"O .SH ERRORS
 103 .SH ¥¨¥é¡¼
 104 .TP
 105 .B EINVAL
 106 .\"O .I buf
 107 .\"O is NULL.
 108 .I buf
 109 ¤¬ NULL¡£
 110 .TP
 111 .B ENOENT
 112 .\"O No user corresponding to
 113 .\"O .IR uid .
 114 .I uid
 115 ¤ËÂÐ±þ¤¹¤ë¥æ¡¼¥¶¤¬¤¤¤Ê¤¤¡£
 116 .TP
 117 .B ENOMEM
 118 .\"O Insufficient memory to allocate
 119 .\"O .I passwd
 120 .\"O structure.
 121 .I passwd
 122 ¹½Â¤ÂÎ¤ò³ä¤êÅö¤Æ¤ë¤¿¤á¤Î¥á¥â¥ê¤¬ÉÔ½½Ê¬¡£
 123 .\"O .SH FILES
 124 .SH ¥Õ¥¡¥¤¥ë
 125 .TP
 126 .I /etc/passwd
 127 .\"O password database file
 128 ¥Ñ¥¹¥ï¡¼¥É¥Ç¡¼¥¿¥Ù¡¼¥¹¥Õ¥¡¥¤¥ë
 129 .\"O .SH "CONFORMING TO"
 130 .SH ½àµò
 131 .\"O SVr2.
 132 SVr2
 133 .\"O .SH BUGS
 134 .SH ¥Ð¥°
 135 .\"O The
 136 .\"O .BR getpw ()
 137 .\"O function is dangerous as it may overflow the provided buffer
 138 .\"O .IR buf .
 139 .BR getpw ()
 140 ´Ø¿ô¤Ï¡¢Í¿¤¨¤é¤ì¤¿¥Ð¥Ã¥Õ¥¡
 141 .I buf
 142 ¤¬¥ª¡¼¥Ð¡¼¥Õ¥í¡¼¤¹¤ë¤«¤â¤·¤ì¤Ê¤¤¤Î¤Ç´í¸±¤Ç¤¢¤ë¡£
 143 .\"O It is obsoleted by
 144 .\"O .BR getpwuid (3).
 145 ¤³¤Î´Ø¿ô¤Ï
 146 .BR getpwuid (3)
 147 ¤Ë¤è¤Ã¤Æ¸Å¤¤¤â¤Î¤È¤Ê¤Ã¤¿¡£
 148 .\"O .SH "SEE ALSO"
 149 .SH ´ØÏ¢¹àÌÜ
 150 .BR endpwent (3),
 151 .BR fgetpwent (3),
 152 .BR getpwent (3),
 153 .BR getpwnam (3),
 154 .BR getpwuid (3),
 155 .BR putpwent (3),
 156 .BR setpwent (3),
 157 .BR passwd (5)