external/ibm-public/postfix/dist/man/man8/scache.8

   1 .\"     $NetBSD$
   2 .\"
   3 .TH SCACHE 8
   4 .ad
   5 .fi
   6 .SH NAME
   7 scache
   8 \-
   9 Postfix shared connection cache server
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBscache\fR [generic Postfix daemon options]
  14 .SH DESCRIPTION
  15 .ad
  16 .fi
  17 The \fBscache\fR(8) server maintains a shared multi-connection
  18 cache. This information can be used by, for example, Postfix
  19 SMTP clients or other Postfix delivery agents.
  20
  21 The connection cache is organized into logical destination
  22 names, physical endpoint names, and connections.
  23
  24 As a specific example, logical SMTP destinations specify
  25 (transport, domain, port), and physical SMTP endpoints
  26 specify (transport, IP address, port).  An SMTP connection
  27 may be saved after a successful mail transaction.
  28
  29 In the general case, one logical destination may refer to
  30 zero or more physical endpoints, one physical endpoint may
  31 be referenced by zero or more logical destinations, and
  32 one endpoint may refer to zero or more connections.
  33
  34 The exact syntax of a logical destination or endpoint name
  35 is application dependent; the \fBscache\fR(8) server does
  36 not care.  A connection is stored as a file descriptor together
  37 with application-dependent information that is needed to
  38 re-activate a connection object. Again, the \fBscache\fR(8)
  39 server is completely unaware of the details of that
  40 information.
  41
  42 All information is stored with a finite time to live (ttl).
  43 The connection cache daemon terminates when no client is
  44 connected for \fBmax_idle\fR time units.
  45
  46 This server implements the following requests:
  47 .IP "\fBsave_endp\fI ttl endpoint endpoint_properties file_descriptor\fR"
  48 Save the specified file descriptor and connection property data
  49 under the specified endpoint name. The endpoint properties
  50 are used by the client to re-activate a passivated connection
  51 object.
  52 .IP "\fBfind_endp\fI endpoint\fR"
  53 Look up cached properties and a cached file descriptor for the
  54 specified endpoint.
  55 .IP "\fBsave_dest\fI ttl destination destination_properties endpoint\fR"
  56 Save the binding between a logical destination and an
  57 endpoint under the destination name, together with destination
  58 specific connection properties. The destination properties
  59 are used by the client to re-activate a passivated connection
  60 object.
  61 .IP "\fBfind_dest\fI destination\fR"
  62 Look up cached destination properties, cached endpoint properties,
  63 and a cached file descriptor for the specified logical destination.
  64 .SH "SECURITY"
  65 .na
  66 .nf
  67 .ad
  68 .fi
  69 The \fBscache\fR(8) server is not security-sensitive. It does not
  70 talk to the network, and it does not talk to local users.
  71 The \fBscache\fR(8) server can run chrooted at fixed low privilege.
  72
  73 The \fBscache\fR(8) server is not a trusted process. It must
  74 not be used to store information that is security sensitive.
  75 .SH DIAGNOSTICS
  76 .ad
  77 .fi
  78 Problems and transactions are logged to \fBsyslogd\fR(8).
  79 .SH BUGS
  80 .ad
  81 .fi
  82 The session cache cannot be shared among multiple machines.
  83
  84 When a connection expires from the cache, it is closed without
  85 the appropriate protocol specific handshake.
  86 .SH "CONFIGURATION PARAMETERS"
  87 .na
  88 .nf
  89 .ad
  90 .fi
  91 Changes to \fBmain.cf\fR are picked up automatically as \fBscache\fR(8)
  92 processes run for only a limited amount of time. Use the command
  93 "\fBpostfix reload\fR" to speed up a change.
  94
  95 The text below provides only a parameter summary. See
  96 \fBpostconf\fR(5) for more details including examples.
  97 .SH "RESOURCE CONTROLS"
  98 .na
  99 .nf
 100 .ad
 101 .fi
 102 .IP "\fBconnection_cache_ttl_limit (2s)\fR"
 103 The maximal time-to-live value that the \fBscache\fR(8) connection
 104 cache server
 105 allows.
 106 .IP "\fBconnection_cache_status_update_time (600s)\fR"
 107 How frequently the \fBscache\fR(8) server logs usage statistics with
 108 connection cache hit and miss rates for logical destinations and for
 109 physical endpoints.
 110 .SH "MISCELLANEOUS CONTROLS"
 111 .na
 112 .nf
 113 .ad
 114 .fi
 115 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 116 The default location of the Postfix main.cf and master.cf
 117 configuration files.
 118 .IP "\fBdaemon_timeout (18000s)\fR"
 119 How much time a Postfix daemon process may take to handle a
 120 request before it is terminated by a built-in watchdog timer.
 121 .IP "\fBipc_timeout (3600s)\fR"
 122 The time limit for sending or receiving information over an internal
 123 communication channel.
 124 .IP "\fBmax_idle (100s)\fR"
 125 The maximum amount of time that an idle Postfix daemon process waits
 126 for an incoming connection before terminating voluntarily.
 127 .IP "\fBprocess_id (read-only)\fR"
 128 The process ID of a Postfix command or daemon process.
 129 .IP "\fBprocess_name (read-only)\fR"
 130 The process name of a Postfix command or daemon process.
 131 .IP "\fBsyslog_facility (mail)\fR"
 132 The syslog facility of Postfix logging.
 133 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
 134 The mail system name that is prepended to the process name in syslog
 135 records, so that "smtpd" becomes, for example, "postfix/smtpd".
 136 .SH "SEE ALSO"
 137 .na
 138 .nf
 139 smtp(8), SMTP client
 140 postconf(5), configuration parameters
 141 master(8), process manager
 142 syslogd(8), system logging
 143 .SH "README FILES"
 144 .na
 145 .nf
 146 .ad
 147 .fi
 148 Use "\fBpostconf readme_directory\fR" or
 149 "\fBpostconf html_directory\fR" to locate this information.
 150 .na
 151 .nf
 152 CONNECTION_CACHE_README, Postfix connection cache
 153 .SH "LICENSE"
 154 .na
 155 .nf
 156 .ad
 157 .fi
 158 The Secure Mailer license must be distributed with this software.
 159 .SH "HISTORY"
 160 .na
 161 .nf
 162 This service was introduced with Postfix version 2.2.
 163 .SH "AUTHOR(S)"
 164 .na
 165 .nf
 166 Wietse Venema
 167 IBM T.J. Watson Research
 168 P.O. Box 704
 169 Yorktown Heights, NY 10598, USA