original/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 .TH SETALIASENT 3 2003-09-09 "GNU" "Linux Programmer's Manual"
  10 .SH NAME
  11 setaliasent, endaliasent, getaliasent, getaliasent_r,
  12 getaliasbyname, getaliasbyname_r \- read an alias entry
  13 .SH SYNOPSIS
  14 .B #include <aliases.h>
  15 .sp
  16 .B "void setaliasent(void);"
  17 .sp
  18 .B "void endaliasent(void);"
  19 .sp
  20 .B "struct aliasent *getaliasent(void);"
  21 .sp
  22 .BI "int getaliasent_r(struct aliasent *" result ","
  23 .br
  24 .BI "        char *" buffer ", size_t " buflen ", struct aliasent **" res );
  25 .sp
  26 .BI "struct aliasent *getaliasbyname(const char *" name );
  27 .sp
  28 .BI "int getaliasbyname_r(const char *" name ", struct aliasent *" result ,
  29 .br
  30 .BI "        char *" buffer ", size_t " buflen ", struct aliasent **" res );
  31 .SH DESCRIPTION
  32 One of the databases available with the Name Service Switch (NSS)
  33 is the aliases database, that contains mail aliases.
  34 (To find out which databases are supported, try
  35 .IR "getent \-\-help" .)
  36 Six functions are provided to access the aliases database.
  37 .PP
  38 The
  39 .BR getaliasent ()
  40 function returns a pointer to a structure containing
  41 the group information from the aliases database.
  42 The first time it is called it returns the first entry;
  43 thereafter, it returns successive entries.
  44 .PP
  45 The
  46 .BR setaliasent ()
  47 function rewinds the file pointer to the beginning of the
  48 aliases database.
  49 .PP
  50 The
  51 .BR endaliasent ()
  52 function closes the aliases database.
  53 .PP
  54 .BR getaliasent_r ()
  55 is the reentrant version of the previous function.
  56 The requested structure
  57 is stored via the first argument but the programmer needs to fill the other
  58 arguments also.
  59 Not providing enough space causes the function to fail.
  60 .PP
  61 The function
  62 .BR getaliasbyname ()
  63 takes the name argument and searches the aliases database.
  64 The entry is returned as a pointer to a
  65 .IR "struct aliasent" .
  66 .PP
  67 .BR getaliasbyname_r ()
  68 is the reentrant version of the previous function.
  69 The requested structure
  70 is stored via the second argument but the programmer needs to fill the other
  71 arguments also.
  72 Not providing enough space causes the function to fail.
  73 .PP
  74 The
  75 .I "struct aliasent"
  76 is defined in
  77 .IR <aliases.h> :
  78 .in +4n
  79 .nf
  80
  81 struct aliasent {
  82     char    *alias_name;             /* alias name */
  83     size_t   alias_members_len;
  84     char   **alias_members;          /* alias name list */
  85     int      alias_local;
  86 };
  87 .fi
  88 .in
  89 .SH RETURN VALUE
  90 The functions
  91 .BR getaliasent_r ()
  92 and
  93 .BR getaliasbyname_r ()
  94 return a nonzero value on error.
  95 .SH FILES
  96 The default alias database is the file
  97 .IR /etc/aliases .
  98 This can be changed in the
  99 .I /etc/nsswitch.conf
 100 file.
 101 .SH CONFORMING TO
 102 These routines are glibc-specific.
 103 The NeXT system has similar routines:
 104 .in +4n
 105 .nf
 106
 107 #include <aliasdb.h>
 108
 109 void alias_setent(void);
 110 void alias_endent(void);
 111 alias_ent *alias_getent(void);
 112 alias_ent *alias_getbyname(char *name);
 113 .fi
 114 .in
 115 .SH EXAMPLE
 116 The following example compiles with
 117 .IR "gcc example.c \-o example" .
 118 It will dump all names in the alias database.
 119 .sp
 120 .nf
 121 #include <aliases.h>
 122 #include <stdio.h>
 123 #include <stdlib.h>
 124 #include <errno.h>
 125
 126 int
 127 main(void)
 128 {
 129     struct aliasent *al;
 130     setaliasent();
 131     for (;;) {
 132         al = getaliasent();
 133         if (al == NULL)
 134             break;
 135         printf("Name: %s\\n", al\->alias_name);
 136     }
 137     if (errno) {
 138         perror("reading alias");
 139         exit(EXIT_FAILURE);
 140     }
 141     endaliasent();
 142     exit(EXIT_SUCCESS);
 143 }
 144 .fi
 145 .SH SEE ALSO
 146 .BR getgrent (3),
 147 .BR getpwent (3),
 148 .BR getspent (3),
 149 .BR aliases (5)
 150 .\"
 151 .\" /etc/sendmail/aliases
 152 .\" Yellow Pages
 153 .\" newaliases, postalias
 154 .SH COLOPHON
 155 This page is part of release 3.68 of the Linux
 156 .I man-pages
 157 project.
 158 A description of the project,
 159 information about reporting bugs,
 160 and the latest version of this page,
 161 can be found at
 162 \%http://www.kernel.org/doc/man\-pages/.