postfix-master/postkick.1.html

   1 <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
   2         "http://www.w3.org/TR/html4/loose.dtd">
   3 <html> <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
   5 <title> Postfix manual - postkick(1) </title>
   6 </head> <body> <pre>
   7 POSTKICK(1)                                                        POSTKICK(1)
   8
   9 <b>NAME</b>
  10        postkick - kick a Postfix service
  11
  12 <b>SYNOPSIS</b>
  13        <b>postkick</b> [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-v</b>] <i>class service request</i>
  14
  15 <b>DESCRIPTION</b>
  16        The  <a href="postkick.1.html"><b>postkick</b>(1)</a>  command  sends  <i>request</i> to the specified
  17        <i>service</i> over a  local  transport  channel.   This  command
  18        makes Postfix private IPC accessible for use in, for exam-
  19        ple, shell scripts.
  20
  21        Options:
  22
  23        <b>-c</b> <i>config</i><b>_</b><i>dir</i>
  24               Read the <a href="postconf.5.html"><b>main.cf</b></a> configuration file  in  the  named
  25               directory  instead  of  the  default  configuration
  26               directory.
  27
  28        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
  29               tiple  <b>-v</b>  options  make  the software increasingly
  30               verbose.
  31
  32        Arguments:
  33
  34        <i>class</i>  Name of a class of  local  transport  channel  end-
  35               points,  either  <b>public</b>  (accessible  by  any local
  36               user) or <b>private</b> (administrative access only).
  37
  38        <i>service</i>
  39               The name of a local transport endpoint  within  the
  40               named class.
  41
  42        <i>request</i>
  43               A  string.  The  list of valid requests is service-
  44               specific.
  45
  46 <b>DIAGNOSTICS</b>
  47        Problems and transactions are logged to the standard error
  48        stream.
  49
  50 <b>ENVIRONMENT</b>
  51        <b>MAIL_CONFIG</b>
  52               Directory with Postfix configuration files.
  53
  54        <b>MAIL_VERBOSE</b>
  55               Enable verbose logging for debugging purposes.
  56
  57 <b>CONFIGURATION PARAMETERS</b>
  58        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
  59        to this program.  The text below provides only a parameter
  60        summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam-
  61        ples.
  62
  63        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
  64               The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
  65               <a href="master.5.html">master.cf</a> configuration files.
  66
  67        <b><a href="postconf.5.html#application_event_drain_time">application_event_drain_time</a> (100s)</b>
  68               How  long  the  <a href="postkick.1.html"><b>postkick</b>(1)</a>  command  waits  for  a
  69               request to enter the server's input  buffer  before
  70               giving up.
  71
  72        <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
  73               The  location of the Postfix top-level queue direc-
  74               tory.
  75
  76 <b>FILES</b>
  77        /var/spool/postfix/private, private class endpoints
  78        /var/spool/postfix/public, public class endpoints
  79
  80 <b>SEE ALSO</b>
  81        <a href="qmgr.8.html">qmgr(8)</a>, queue manager trigger protocol
  82        <a href="pickup.8.html">pickup(8)</a>, local pickup daemon
  83        <a href="postconf.5.html">postconf(5)</a>, configuration parameters
  84
  85 <b>LICENSE</b>
  86        The Secure Mailer license must be  distributed  with  this
  87        software.
  88
  89 <b>AUTHOR(S)</b>
  90        Wietse Venema
  91        IBM T.J. Watson Research
  92        P.O. Box 704
  93        Yorktown Heights, NY 10598, USA
  94
  95                                                                    POSTKICK(1)
  96 </pre> </body> </html>