release/man3/setaliasent.3

   1 .\" Copyright 2003 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Distributed under GPL
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Polished a bit, added a little, aeb
   8 .\"
   9 .\"*******************************************************************
  10 .\"
  11 .\" This file was generated with po4a. Translate the source file.
  12 .\"
  13 .\"*******************************************************************
  14 .TH SETALIASENT 3 2003\-09\-09 GNU "Linux Programmer's Manual"
  15 .SH 名前
  16 setaliasent, endaliasent, getaliasent, getaliasent_r, getaliasbyname,
  17 getaliasbyname_r \- エイリアスエントリを読み込む
  18 .SH 書式
  19 \fB#include <aliases.h>\fP
  20 .sp
  21 \fBvoid setaliasent(void);\fP
  22 .sp
  23 \fBvoid endaliasent(void);\fP
  24 .sp
  25 \fBstruct aliasent *getaliasent(void);\fP
  26 .sp
  27 \fBint getaliasent_r(struct aliasent *\fP\fIresult\fP\fB,\fP
  28 .br
  29 \fB char *\fP\fIbuffer\fP\fB, size_t \fP\fIbuflen\fP\fB, struct aliasent **\fP\fIres\fP\fB);\fP
  30 .sp
  31 \fBstruct aliasent *getaliasbyname(const char *\fP\fIname\fP\fB);\fP
  32 .sp
  33 \fBint getaliasbyname_r(const char *\fP\fIname\fP\fB, struct aliasent
  34 *\fP\fIresult\fP\fB,\fP
  35 .br
  36 \fB char *\fP\fIbuffer\fP\fB, size_t \fP\fIbuflen\fP\fB, struct aliasent **\fP\fIres\fP\fB);\fP
  37 .SH 説明
  38 ネームサービススイッチ (Name Service Switch, NSS) で 利用可能なデータベースの 1 つとして、
  39 メールエイリアスを保持するエイリアスデータベースがある。 (どのデータベースがサポートされているかを調べるには、 getent \-\-help
  40 を実行すること。)  エイリアスデータベースにアクセスするために、 6 つの関数が提供されている。
  41 .PP
  42 \fBgetaliasent\fP()  関数はエイリアスデータベースから取り出した グループ情報を含む構造体へのポインタを返す。 1
  43 回目に関数が呼ばれたときには、最初のエントリを返す; それ以降はその後のエントリを返す。
  44 .PP
  45 \fBsetaliasent\fP()  関数はファイルポインタをエイリアスデータベースの先頭に巻き戻す。
  46 .PP
  47 \fBendaliasent\fP()  関数はエイリアスデータベースをクローズする。
  48 .PP
  49 \fBgetaliasent_r\fP()  関数は上記の関数のリエントラント版である。 要求された構造体は第 1 引き数に格納されるが、
  50 プログラマは他の引き数も埋めてやる必要がある。 充分な領域が与えられないと、この関数は失敗する。
  51 .PP
  52 関数 \fBgetaliasbyname\fP()  は name 引き数をとり、エイリアスデータベースを検索する。 エントリは \fIstruct
  53 aliasent\fP へのポインタとして返される。
  54 .PP
  55 \fBgetaliasbyname_r\fP()  は上記の関数のリエントラント版である。 要求された構造体は第 2 引き数に格納されるが、
  56 プログラマは他の引き数も埋めてやる必要がある。 充分な領域が与えられないと、この関数は失敗する。
  57 .PP
  58 \fIstruct aliasent\fP は \fI<aliases.h>\fP で定義されている。
  59 .in +4n
  60 .nf
  61
  62 struct aliasent {
  63     char    *alias_name;             /* エイリアス名 */
  64     size_t   alias_members_len;
  65     char   **alias_members;          /* エイリアス名のリスト */
  66     int      alias_local;
  67 };
  68 .fi
  69 .in
  70 .SH 返り値
  71 関数 \fBgetaliasent_r\fP()  と \fBgetaliasbyname_r\fP()  は、エラーの場合に 0 以外の値を返す。
  72 .SH ファイル
  73 デフォルトのエイリアスデータベースは、ファイル \fI/etc/aliases\fP である。 これは \fI/etc/nsswitch.conf\fP
  74 ファイルで変更できる。
  75 .SH 準拠
  76 このルーチンは glibc 固有のものである。 NeXT システムには同様のルーチンがある。
  77 .in +4n
  78 .nf
  79
  80 #include <aliasdb.h>
  81
  82 void alias_setent(void);
  83 void alias_endent(void);
  84 alias_ent *alias_getent(void);
  85 alias_ent *alias_getbyname(char *name);
  86 .fi
  87 .in
  88 .SH 例
  89 以下の例は \fIgcc example.c \-o example\fP でコンパイルできる。 これはエイリアスデータベースにある全ての名前をダンプする。
  90 .sp
  91 .nf
  92 #include <aliases.h>
  93 #include <stdio.h>
  94 #include <stdlib.h>
  95 #include <errno.h>
  96
  97 int
  98 main(void)
  99 {
 100     struct aliasent *al;
 101     setaliasent();
 102     for (;;) {
 103         al = getaliasent();
 104         if (al == NULL)
 105             break;
 106         printf("Name: %s\en", al\->alias_name);
 107     }
 108     if (errno) {
 109         perror("reading alias");
 110         exit(EXIT_FAILURE);
 111     }
 112     endaliasent();
 113     exit(EXIT_SUCCESS);
 114 .fi
 115 .SH 関連項目
 116 .\"
 117 .\" /etc/sendmail/aliases
 118 .\" Yellow Pages
 119 .\" newaliases, postalias
 120 \fBgetgrent\fP(3), \fBgetpwent\fP(3), \fBgetspent\fP(3), \fBaliases\fP(5)
 121 .SH この文書について
 122 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 123 である。プロジェクトの説明とバグ報告に関する情報は
 124 http://www.kernel.org/doc/man\-pages/ に書かれている。