2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 2003 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
|
|
|
|
.\" Distributed under GPL
|
|
|
|
.\"
|
|
|
|
.\" Polished a bit, added a little, aeb
|
|
|
|
.\"
|
2007-05-18 08:43:42 +00:00
|
|
|
.TH SETALIASENT 3 2003-09-09 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
setaliasent, endaliasent, getaliasent, getaliasent_r,
|
|
|
|
getaliasbyname, getaliasbyname_r \- read an alias entry
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <aliases.h>
|
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "void setaliasent(void);"
|
2007-04-12 22:42:49 +00:00
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "void endaliasent(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "struct aliasent *getaliasent(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
.BI "int getaliasent_r(struct aliasent *" result ","
|
|
|
|
.br
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI " char *" buffer ", size_t " buflen ", struct aliasent **" res );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
.BI "struct aliasent *getaliasbyname(const char *" name );
|
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "int getaliasbyname_r(const char *" name ", struct aliasent *" result ,
|
2004-11-03 13:51:07 +00:00
|
|
|
.br
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI " char *" buffer ", size_t " buflen ", struct aliasent **" res );
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
One of the databases available with the Name Service Switch (NSS)
|
2007-04-12 22:42:49 +00:00
|
|
|
is the aliases database, that contains mail aliases.
|
|
|
|
(To find out which databases are supported, try \fIgetent \-\-help\fP.)
|
2004-11-03 13:51:07 +00:00
|
|
|
Six functions are provided to access the aliases database.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function returns a pointer to a structure containing
|
|
|
|
the group information from the aliases database.
|
2007-04-12 22:42:49 +00:00
|
|
|
The first time it is called it returns the first entry;
|
2004-11-03 13:51:07 +00:00
|
|
|
thereafter, it returns successive entries.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR setaliasent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function rewinds the file pointer to the beginning of the
|
|
|
|
aliases database.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR endaliasent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function closes the aliases database.
|
|
|
|
.PP
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasent_r ()
|
2007-04-12 22:42:49 +00:00
|
|
|
is the reentrant version of the previous function.
|
2007-04-03 15:32:52 +00:00
|
|
|
The requested structure
|
2004-11-03 13:51:07 +00:00
|
|
|
is stored via the first argument but the programmer needs to fill the other
|
2007-04-03 15:32:52 +00:00
|
|
|
arguments also.
|
|
|
|
Not providing enough space causes the function to fail.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasbyname ()
|
2007-04-12 22:42:49 +00:00
|
|
|
takes the name argument and searches the aliases database.
|
|
|
|
The entry is returned as a pointer to a
|
|
|
|
.IR "struct aliasent" .
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasbyname_r ()
|
2007-04-12 22:42:49 +00:00
|
|
|
is the reentrant version of the previous function.
|
2007-04-03 15:32:52 +00:00
|
|
|
The requested structure
|
2007-04-03 17:53:26 +00:00
|
|
|
is stored via the second argument but the programmer needs to fill the other
|
2007-04-12 22:42:49 +00:00
|
|
|
arguments also.
|
2007-04-03 15:32:52 +00:00
|
|
|
Not providing enough space causes the function to fail.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2007-04-03 15:32:52 +00:00
|
|
|
.I "struct aliasent"
|
2007-04-12 22:42:49 +00:00
|
|
|
is defined in
|
2007-04-03 15:32:52 +00:00
|
|
|
.IR <aliases.h> :
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-04-03 15:32:52 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
struct aliasent {
|
2007-10-16 19:18:17 +00:00
|
|
|
char *alias_name; /* alias name */
|
2007-04-12 22:42:49 +00:00
|
|
|
size_t alias_members_len;
|
2008-09-18 12:30:40 +00:00
|
|
|
char **alias_members; /* alias name list */
|
2007-04-03 15:32:52 +00:00
|
|
|
int alias_local;
|
2004-11-03 13:51:07 +00:00
|
|
|
};
|
|
|
|
.fi
|
2007-12-19 06:57:44 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
The functions
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasent_r ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getaliasbyname_r ()
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
return a nonzero value on error.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH FILES
|
|
|
|
The default alias database is the file
|
|
|
|
.IR /etc/aliases .
|
|
|
|
This can be changed in the
|
|
|
|
.I /etc/nsswitch.conf
|
|
|
|
file.
|
|
|
|
.SH "CONFORMING TO"
|
2007-12-25 21:28:09 +00:00
|
|
|
These routines are glibc-specific.
|
2010-11-01 06:20:22 +00:00
|
|
|
The NeXT system has similar routines:
|
2007-12-19 07:19:23 +00:00
|
|
|
.in +4n
|
2007-05-19 04:30:20 +00:00
|
|
|
.nf
|
2007-06-13 22:21:38 +00:00
|
|
|
|
2007-05-19 04:30:20 +00:00
|
|
|
#include <aliasdb.h>
|
2007-06-13 22:21:38 +00:00
|
|
|
|
2007-05-19 04:30:20 +00:00
|
|
|
void alias_setent(void);
|
|
|
|
void alias_endent(void);
|
|
|
|
alias_ent *alias_getent(void);
|
|
|
|
alias_ent *alias_getbyname(char *name);
|
|
|
|
.fi
|
2007-12-19 07:19:23 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH EXAMPLE
|
2007-04-12 22:42:49 +00:00
|
|
|
The following example compiles with
|
2005-07-06 08:00:30 +00:00
|
|
|
.IR "gcc example.c \-o example" .
|
2004-11-03 13:51:07 +00:00
|
|
|
It will dump all names in the alias database.
|
|
|
|
.sp
|
|
|
|
.nf
|
|
|
|
#include <aliases.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <errno.h>
|
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
int
|
|
|
|
main(void)
|
2007-04-05 12:36:57 +00:00
|
|
|
{
|
|
|
|
struct aliasent *al;
|
|
|
|
setaliasent();
|
|
|
|
for (;;) {
|
|
|
|
al = getaliasent();
|
2007-04-12 22:42:49 +00:00
|
|
|
if (al == NULL)
|
2007-04-05 12:36:57 +00:00
|
|
|
break;
|
2007-06-20 21:39:45 +00:00
|
|
|
printf("Name: %s\\n", al\->alias_name);
|
2007-04-05 12:36:57 +00:00
|
|
|
}
|
|
|
|
if (errno) {
|
|
|
|
perror("reading alias");
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
|
|
|
endaliasent();
|
|
|
|
exit(EXIT_SUCCESS);
|
2004-11-03 13:51:07 +00:00
|
|
|
}
|
|
|
|
.fi
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR getgrent (3),
|
|
|
|
.BR getpwent (3),
|
|
|
|
.BR getspent (3),
|
|
|
|
.BR aliases (5)
|
|
|
|
.\"
|
|
|
|
.\" /etc/sendmail/aliases
|
|
|
|
.\" Yellow Pages
|
|
|
|
.\" newaliases, postalias
|