diff options
Diffstat (limited to 'contrib/sendmail/libmilter/docs/smfi_setconn.html')
-rw-r--r-- | contrib/sendmail/libmilter/docs/smfi_setconn.html | 113 |
1 files changed, 57 insertions, 56 deletions
diff --git a/contrib/sendmail/libmilter/docs/smfi_setconn.html b/contrib/sendmail/libmilter/docs/smfi_setconn.html index 07461ccc..70a510e 100644 --- a/contrib/sendmail/libmilter/docs/smfi_setconn.html +++ b/contrib/sendmail/libmilter/docs/smfi_setconn.html @@ -1,92 +1,93 @@ -<html> -<head><title>smfi_setconn</title></head> -<body> +<HTML> +<HEAD><TITLE>smfi_setconn</TITLE></HEAD> +<BODY> <!-- -$Id: smfi_setconn.html,v 1.14 2003/05/26 05:09:16 gshapiro Exp $ +$Id: smfi_setconn.html,v 1.17 2006/12/21 18:30:35 ca Exp $ --> -<h1>smfi_setconn</h1> +<H1>smfi_setconn</H1> -<table border="0" cellspacing=4 cellpadding=4> +<TABLE border="0" cellspacing=4 cellpadding=4> <!---------- Synopsis -----------> -<tr><th valign="top" align=left width=150>SYNOPSIS</th><td> -<pre> +<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> +<PRE> #include <libmilter/mfapi.h> int smfi_setconn( char *oconn; ); -</pre> +</PRE> Set the socket through which this filter should communicate with sendmail. -</td></tr> +</TD></TR> <!----------- Description ----------> -<tr><th valign="top" align=left>DESCRIPTION</th><td> -<table border="1" cellspacing=1 cellpadding=4> -<tr align="left" valign=top> -<th width="80">Called When</th> -<td>smfi_setconn must be called once before <a href="smfi_main.html">smfi_main</a>.</td> -</tr> -<tr align="left" valign=top> -<th width="80">Effects</th> -<td>Sets the socket through which the filter communicates with sendmail.</td> -</tr> -</table> +<TR><TH valign="top" align=left>DESCRIPTION</TH><TD> +<TABLE border="1" cellspacing=1 cellpadding=4> +<TR align="left" valign=top> +<TH width="80">Called When</TH> +<TD>smfi_setconn must be called once before <A href="smfi_main.html">smfi_main</A>.</TD> +</TR> +<TR align="left" valign=top> +<TH width="80">Effects</TH> +<TD>Sets the socket through which the filter communicates with sendmail.</TD> +</TR> +</TABLE> <!----------- Arguments ----------> -<tr><th valign="top" align=left>ARGUMENTS</th><td> - <table border="1" cellspacing=0> - <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr> - <tr valign="top"><td>oconn</td> - <td>The address of the desired communication socket. +<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> + <TABLE border="1" cellspacing=0> + <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> + <TR valign="top"><TD>oconn</TD> + <TD>The address of the desired communication socket. The address should be a NULL-terminated string in "proto:address" format: - <ul> - <li><code>{unix|local}:/path/to/file</code> -- A named pipe. - <li><code>inet:port@{hostname|ip-address}</code> -- An IPV4 socket. - <li><code>inet6:port@{hostname|ip-address}</code> -- An IPV6 socket. - </ul> - </td></tr> - </table> -</td></tr> + <UL> + <LI><CODE>{unix|local}:/path/to/file</CODE> -- A named pipe. + <LI><CODE>inet:port@{hostname|ip-address}</CODE> -- An IPV4 socket. + <LI><CODE>inet6:port@{hostname|ip-address}</CODE> -- An IPV6 socket. + </UL> + </TD></TR> + </TABLE> +</TD></TR> <!----------- Return values ----------> -<tr> -<th valign="top" align=left>RETURN VALUES</th> +<TR> +<TH valign="top" align=left>RETURN VALUES</TH> -<td>smfi_setconn will not fail on an invalid address. -The failure will only be detected in <a href="smfi_main.html">smfi_main</a></td>. +<TD>smfi_setconn will not fail on an invalid address. +The failure will only be detected in <A href="smfi_main.html">smfi_main</A>. Nevertheless, smfi_setconn may fail for other reasons, e.g., due to a lack of memory. -</tr> +</TD> +</TR> -<tr> -<th valign="top" align=left>NOTES</th> +<TR> +<TH valign="top" align=left>NOTES</TH> -<td> -<ul> - <li>If possible, filters should not run as root when communicating +<TD> +<UL> + <LI>If possible, filters should not run as root when communicating over unix/local domain sockets. - <li>Unix/local sockets should have their permissions set to + <LI>Unix/local sockets should have their permissions set to 0600 (read/write permission only for the socket's owner) or 0660 (read/write permission for the socket's owner and group) which is useful if the sendmail RunAsUser option is used. The permissions for a unix/local domain socket are determined as - usual by <code>umask</code>, which should be set to 007 or 077. + usual by <CODE>umask</CODE>, which should be set to 007 or 077. Note some operating systems (e.g, Solaris) don't use the permissions of the socket. On those systems, place the socket in a protected directory. -</ul> -</td> -</tr> +</UL> +</TD> +</TR> -</table> +</TABLE> -<hr size="1"> -<font size="-1"> +<HR size="1"> +<FONT size="-1"> Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers. All rights reserved. -<br> +<BR> By using this file, you agree to the terms and conditions set forth in the LICENSE. -</font> -</body> -</html> +</FONT> +</BODY> +</HTML> |