(split) LDP v3.24 -> v3.29 の定型的な変更内容を反映。

[linuxjm/LDP_man-pages.git] / draft / man3 / getgrnam.3

.\" Hey Emacs! This file is -*- nroff -*- source.
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\"
.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
.\" Modified 2003-11-15 by aeb
.\"
.\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
.\"     all rights reserved.
.\" Translated 1997-12-19, HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
.\" Updated & Modefied 1999-02-26, Shouichi Saito
.\" Updated & Modified 2004-06-05, Yuichi SATO <ysato444@yahoo.co.jp>
.\" Updated & Modified 2005-09-06, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2008-12-24, Akihiro MOTOKI, LDP v3.14
.\"
.TH GETGRNAM 3 2009-03-30 "" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O getgrnam, getgrnam_r, getgrgid, getgrgid_r \- get group file entry
getgrnam, getgrnam_r, getgrgid, getgrgid_r \- ¥°¥ë¡¼¥×¥Õ¥¡¥¤¥ë¥¨¥ó¥È¥ê¤Î¼è¤ê½Ð¤·
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.B #include <sys/types.h>
.B #include <grp.h>
.sp
.BI "struct group *getgrnam(const char *" name );
.sp
.BI "struct group *getgrgid(gid_t " gid );
.sp
.BI "int getgrnam_r(const char *" name ", struct group *" grp ,
.br
.BI "          char *" buf ", size_t " buflen ", struct group **" result );
.sp
.BI "int getgrgid_r(gid_t " gid ", struct group *" grp ,
.br
.BI "          char *" buf ", size_t " buflen ", struct group **" result );
.fi
.sp
.in -4n
.\"O Feature Test Macro Requirements for glibc (see
.\"O .BR feature_test_macros (7)):
glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
.RB ( feature_test_macros (7)
»²¾È):
.ad l
.in
.sp
.BR getgrnam_r (),
.BR getgrgid_r ():
.RS 4
_POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _BSD_SOURCE ||
_SVID_SOURCE || _POSIX_SOURCE
.RE
.ad b
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The
.\"O .BR getgrnam ()
.\"O function returns a pointer to a structure containing
.\"O the broken-out fields of the record in the group database
.\"O (e.g., the local group file
.\"O .IR /etc/group ,
.\"O NIS, and LDAP)
.\"O that matches the group name
.\"O .IR name .
.BR getgrnam ()
´Ø¿ô¤Ï¡¢¥°¥ë¡¼¥×̾
.I name
¤Ë¥Þ¥Ã¥Á¤¹¤ë¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤Î¥¨¥ó¥È¥ê¤ò
Í×ÁÇËè¤Ëʬ²ò¤·¡¢³ÆÍ×ÁǤò³ÊǼ¤·¤¿¹½Â¤ÂΤؤΥݥ¤¥ó¥¿¤òÊÖ¤¹
(¥Ñ¥¹¥ï¡¼¥É¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤ÎÎã:
¥í¡¼¥«¥ë¤Î¥°¥ë¡¼¥×¥Õ¥¡¥¤¥ë
.IR /etc/group ,
NIS, LDAP)¡£
.PP
.\"O The
.\"O .BR getgrgid ()
.\"O function returns a pointer to a structure containing
.\"O the broken-out fields of the record in the group database
.\"O that matches the group ID
.\"O .IR gid .
.BR getgrgid ()
´Ø¿ô¤Ï¡¢¥°¥ë¡¼¥× ID
.I uid
¤Ë¥Þ¥Ã¥Á¤¹¤ë¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤Î¥¨¥ó¥È¥ê¤ò
Í×ÁÇËè¤Ëʬ²ò¤·¡¢³ÆÍ×ÁǤò³ÊǼ¤·¤¿¹½Â¤ÂΤؤΥݥ¤¥ó¥¿¤òÊÖ¤¹¡£
.PP
.\"O The
.\"O .BR getgrnam_r ()
.\"O and
.\"O .BR getgrgid_r ()
.\"O functions obtain the same information, but store the retrieved
.\"O .I group
.\"O structure
.\"O in the space pointed to by
.\"O .IR grp .
.BR getgrnam_r ()
¤È
.BR getgrgid_r ()
´Ø¿ô¤Ï (¾åµ­¤Î´Ø¿ô¤È) Ʊ¤¸¾ðÊó¤ò¼èÆÀ¤¹¤ë¤¬¡¢
¼èÆÀ¤·¤¿
.I group
¹½Â¤ÂΤò
.I grp
¤¬»Ø¤¹Îΰè¤Ë³ÊǼ¤¹¤ë¡£
.\"O This
.\"O .I group
.\"O structure contains pointers to strings, and these strings
.\"O are stored in the buffer
.\"O .I buf
.\"O of size
.\"O .IR buflen .
¤³¤Î
.I group
¹½Â¤ÂΤˤÏʸ»úÎó¤Ø¤Î¥Ý¥¤¥ó¥¿¤¬´Þ¤Þ¤ì¡¢
¤³¤ì¤é¤Îʸ»úÎó¤Ï¥µ¥¤¥º
.I buflen
¤Î¥Ð¥Ã¥Õ¥¡
.I buf
¤Ë³ÊǼ¤µ¤ì¤ë¡£
.\"O A pointer to the result (in case of success) or NULL (in case no entry
.\"O was found or an error occurred) is stored in
.\"O .IR *result .
À®¸ù¤·¤¿¾ì¹ç
.I *gbufp
¤Ë¤Ï·ë²Ì¤Ø¤Î¥Ý¥¤¥ó¥¿¤¬³ÊǼ¤µ¤ì¤ë¡£
¥¨¥ó¥È¥ê¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤ä¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ë¤Ï
.I *result
¤Ë¤Ï NULL ¤¬Æþ¤ë¡£
.PP
.\"O The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
\fIgroup\fP ¹½Â¤ÂΤϡ¢\fI<grp.h>\fP ¤Ç°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë:
.sp
.in +4n
.nf
struct group {
.\"O     char   *gr_name;       /* group name */
.\"O     char   *gr_passwd;     /* group password */
.\"O     gid_t   gr_gid;        /* group ID */
.\"O     char  **gr_mem;        /* group members */
    char   *gr_name;       /* ¥°¥ë¡¼¥×̾ */
    char   *gr_passwd;     /* ¥°¥ë¡¼¥×¤Î¥Ð¥¹¥ï¡¼¥É */
    gid_t   gr_gid;        /* ¥°¥ë¡¼¥× ID */
    char  **gr_mem;        /* ¥°¥ë¡¼¥×¤Î¥á¥ó¥Ð */
};
.fi
.in
.PP
.\"O The maximum needed size for
.\"O .I buf
.\"O can be found using
.\"O .BR sysconf (3)
.\"O with the argument
.\"O .BR _SC_GETGR_R_SIZE_MAX .
.I buf
¤ËºÇÂçɬÍפʥµ¥¤¥º¤Ï¡¢
.BR sysconf (3)
¤Ë°ú¤­¿ô
.B _SC_GETGR_R_SIZE_MAX
¤ò»ØÄꤷ¤Æ¼Â¹Ô¤¹¤ë¤³¤È¤Çʬ¤«¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O The
.\"O .BR getgrnam ()
.\"O and
.\"O .BR getgrgid ()
.\"O functions return a pointer to a
.\"O .I group
.\"O structure, or NULL if the matching entry
.\"O is not found or an error occurs.
.BR getgrnam ()
¤È
.BR getgrgid ()
´Ø¿ô¤Ï¡¢
.I group
¹½Â¤ÂΤؤΥݥ¤¥ó¥¿¤òÊÖ¤¹¡£
¥Þ¥Ã¥Á¤¹¤ë¥¨¥ó¥È¥ê¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤ä¡¢
¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ï NULL ¤òÊÖ¤¹¡£
.\"O If an error occurs,
.\"O .I errno
.\"O is set appropriately.
.\"O If one wants to check
.\"O .I errno
.\"O after the call, it should be set to zero before the call.
¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¾ì¹ç¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
¸Æ¤Ó½Ð¤·¤Î¸å¤Ç
.I errno
¤ò¥Á¥§¥Ã¥¯¤·¤¿¤¤¾ì¹ç¤Ï¡¢
¸Æ¤Ó½Ð¤·¤ÎÁ°¤Ë (¤³¤ÎÃͤò) 0 ¤ËÀßÄꤷ¤Æ¤ª¤¯¤Ù¤­¤Ç¤¢¤ë¡£
.LP
.\"O The return value may point to a static area, and may be overwritten
.\"O by subsequent calls to
.\"O .BR getgrent (3),
.\"O .BR getgrgid (),
.\"O or
.\"O .BR getgrnam ().
.\"O (Do not pass the returned pointer to
.\"O .BR free (3).)
ÊÖ¤êÃͤÏÀÅŪ¤ÊÎΰè¤ò»Ø¤·¤Æ¤ª¤ê¡¢¤½¤Î¸å¤Î
.BR getgrent (3),
.BR getgrgid (),
.BR getgrnam ()
¤Î¸Æ¤Ó½Ð¤·¤Ç¾å½ñ¤­¤µ¤ì¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
(ÊÖ¤µ¤ì¤¿¥Ý¥¤¥ó¥¿¤ò
.BR free (3)
¤ËÅϤµ¤Ê¤¤¤³¤È¡£)
.LP
.\"O On success,
.\"O .BR getgrnam_r ()
.\"O and
.\"O .BR getgrgid_r ()
.\"O return zero, and set
.\"O .IR *result
.\"O to
.\"O .IR grp .
.\"O If no matching group record was found,
.\"O these functions return 0 and store NULL in
.\"O .IR *result .
.\"O In case of error, an error number is returned, and NULL is stored in
.\"O .IR *result .
À®¸ù¤¹¤ë¤È¡¢
.BR getgrnam_r ()
¤È
.BR getgrgid_r ()
¤Ï 0 ¤òÊÖ¤·¡¢
.I *result
¤Ë
.I grp
¤òÀßÄꤹ¤ë¡£
¥Þ¥Ã¥Á¤¹¤ë¥°¥ë¡¼¥×¡¦¥¨¥ó¥È¥ê¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤Ë¤Ï¡¢
0 ¤òÊÖ¤·¡¢
.I *result
¤Ë NULL ¤òÀßÄꤹ¤ë¡£
¥¨¥é¡¼¤Î¾ì¹ç¡¢¥¨¥é¡¼ÈÖ¹æ¤òÊÖ¤·¡¢
.I *result
¤Ë NULL ¤òÀßÄꤹ¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.\"O .BR 0 " or " ENOENT " or " ESRCH " or " EBADF " or " EPERM " or ... "
.BR 0 " ¤Þ¤¿¤Ï " ENOENT " ¤Þ¤¿¤Ï " ESRCH " ¤Þ¤¿¤Ï " EBADF " ¤Þ¤¿¤Ï " EPERM " ¤Þ¤¿¤Ï ... "
.\"O The given
.\"O .I name
.\"O or
.\"O .I gid
.\"O was not found.
»ØÄꤵ¤ì¤¿
.I name
¤Þ¤¿¤Ï
.I gid
¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¡£
.TP
.B EINTR
.\"O A signal was caught.
¥·¥°¥Ê¥ë¤¬¥­¥ã¥Ã¥Á¤µ¤ì¤¿¡£
.TP
.B EIO
.\"O I/O error.
I/O ¥¨¥é¡¼¡£
.TP
.B EMFILE
.\"O The maximum number
.\"O .RB ( OPEN_MAX )
.\"O of files was open already in the calling process.
¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤Ë¤ª¤¤¤Æ¡¢
´û¤ËºÇÂç¿ô
.RB ( OPEN_MAX )
¤Î¥Õ¥¡¥¤¥ë¤¬¥ª¡¼¥×¥ó¤µ¤ì¤Æ¤¤¤ë¡£
.TP
.B ENFILE
.\"O The maximum number of files was open already in the system.
¥·¥¹¥Æ¥à¾å¤Ç´û¤ËºÇÂç¿ô¤Î¥Õ¥¡¥¤¥ë¤¬¥ª¡¼¥×¥ó¤µ¤ì¤Æ¤¤¤ë¡£
.TP
.B ENOMEM
.\"O .\" not in POSIX
.\"O Insufficient memory to allocate
.\"O .I group
.\"O structure.
.\"O .\" to allocate the group structure, or to allocate buffers
.\" POSIX ¤Ë¤Ï¤Ê¤¤
.I group
¹½Â¤ÂΤò³ä¤êÅö¤Æ¤ë¤¿¤á¤Î¥á¥â¥ê¤¬ÉÔ½½Ê¬¡£
.\" ¥°¥ë¡¼¥×¾ðÊó¹½Â¤ÂΤò³ä¤êÅö¤Æ¤ë¤¿¤á¡¢¤Þ¤¿¤Ï¥Ð¥Ã¥Õ¥¡¤ò³ä¤êÅö¤Æ¤ë¤¿¤á¤Î
.TP
.B ERANGE
.\"O Insufficient buffer space supplied.
Í¿¤¨¤é¤ì¤¿¥Ð¥Ã¥Õ¥¡¶õ´Ö¤¬ÉÔ½½Ê¬¤Ç¤¢¤ë¡£
.\"O .SH FILES
.SH ¥Õ¥¡¥¤¥ë
.TP
.I /etc/group
.\"O local group database file
¥í¡¼¥«¥ë¤Î¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¥Õ¥¡¥¤¥ë
.\"O .SH "CONFORMING TO"
.SH ½àµò
SVr4, 4.3BSD, POSIX.1-2001.
.\"O .SH NOTES
.SH Ãí°Õ
.\"O The formulation given above under "RETURN VALUE" is from POSIX.1-2001.
¾åµ­¤Î¡ÖÊÖ¤êÃ͡װʲ¼¤Îµ­½Ò¤Ï POSIX.1-2001 ¤Ëµò¤ë¡£
.\"O It does not call "not found" an error, hence does not specify what value
.\"O .I errno
.\"O might have in this situation.
.\"O But that makes it impossible to recognize
.\"O errors.
.\"O One might argue that according to POSIX
.\"O .I errno
.\"O should be left unchanged if an entry is not found.
.\"O Experiments on various
.\"O UNIX-like systems shows that lots of different values occur in this
.\"O situation: 0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM and probably others.
¤³¤Îɸ½à¤Ï¡Ö(¥¨¥ó¥È¥ê¤¬) ¸«¤Ä¤«¤é¤Ê¤¤¤³¤È¡×¤ò¥¨¥é¡¼¤È¤·¤Æ¤¤¤Ê¤¤¤Î¤Ç¡¢
¤½¤Î¤è¤¦¤Ê¾ì¹ç¤Ë
.I errno
¤¬¤É¤Î¤è¤¦¤ÊÃͤˤʤ뤫¤òÄê¤á¤Æ¤¤¤Ê¤¤¡£
¤½¤Î¤¿¤á¡¢¥¨¥é¡¼¤òǧ¼±¤¹¤ë¤³¤È¤ÏÉÔ²Äǽ¤Ç¤¢¤ë¡£
POSIX ¤Ë½àµò¤·¤Æ¡¢¥¨¥ó¥È¥ê¤¬¸«¤Ä¤«¤é¤Ê¤¤¾ì¹ç¤Ï
.I errno
¤òÊѹ¹¤·¤Ê¤¤¤è¤¦¤Ë¤¹¤Ù¤­¤Ç¤¢¤ë¡¢¤È¼çÄ¥¤¹¤ë¿Í¤â¤¤¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
ÍÍ¡¹¤Ê UNIX ·Ï¤Î¥·¥¹¥Æ¥à¤Ç»î¤·¤Æ¤ß¤ë¤È¡¢¤½¤Î¤è¤¦¤Ê¾ì¹ç¤Ë¤Ï
0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM ¤È¤¤¤Ã¤¿ÍÍ¡¹¤ÊÃͤ¬ÊÖ¤µ¤ì¤ë¡£
¾¤ÎÃͤ¬ÊÖ¤µ¤ì¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
.\"O .\" more precisely:
.\"O .\" AIX 5.1 - gives ESRCH
.\"O .\" OSF1 4.0g - gives EWOULDBLOCK
.\"O .\" libc, glibc up to version 2.6, Irix 6.5 - give ENOENT
.\"O .\" glibc since version 2.7 - give 0
.\"O .\" FreeBSD 4.8, OpenBSD 3.2, NetBSD 1.6 - give EPERM
.\"O .\" SunOS 5.8 - gives EBADF
.\"O .\" Tru64 5.1b, HP-UX-11i, SunOS 5.7 - give 0
.\" ¤è¤êÀµ³Î¤Ë¤Ï:
.\" AIX 5.1 ¤Ï ESRCH ¤òÊÖ¤¹¡£
.\" OSF1 4.0g ¤Ï EWOULDBLOCK ¤òÊÖ¤¹¡£
.\" libc, glibc (¥Ð¡¼¥¸¥ç¥ó 2.6 ¤Þ¤Ç), Irix 6.5 ¤Ï ENOENT ¤òÊÖ¤¹¡£
.\" glibc (¥Ð¡¼¥¸¥ç¥ó 2.7 °Ê¹ß) ¤Ï 0 ¤òÊÖ¤¹¡£
.\" FreeBSD 4.8, OpenBSD 3.2, NetBSD 1.6 ¤Ï EPERM ¤òÊÖ¤¹¡£
.\" SunOS 5.8 ¤Ï EBADF ¤òÊÖ¤¹¡£
.\" Tru64 5.1b, HP-UX-11i, SunOS 5.7 ¤Ï 0 ¤òÊÖ¤¹¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR endgrent (3),
.BR fgetgrent (3),
.BR getgrent (3),
.BR getpwnam (3),
.BR setgrent (3),
.BR group (5)