external/ibm-public/postfix/dist/man/man1/postkick.1

   1 .\"     $NetBSD$
   2 .\"
   3 .TH POSTKICK 1
   4 .ad
   5 .fi
   6 .SH NAME
   7 postkick
   8 \-
   9 kick a Postfix service
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 .fi
  14 \fBpostkick\fR [\fB-c \fIconfig_dir\fR] [\fB-v\fR]
  15 \fIclass service request\fR
  16 .SH DESCRIPTION
  17 .ad
  18 .fi
  19 The \fBpostkick\fR(1) command sends \fIrequest\fR to the
  20 specified \fIservice\fR over a local transport channel.
  21 This command makes Postfix private IPC accessible
  22 for use in, for example, shell scripts.
  23
  24 Options:
  25 .IP "\fB-c\fR \fIconfig_dir\fR"
  26 Read the \fBmain.cf\fR configuration file in the named directory
  27 instead of the default configuration directory.
  28 .IP \fB-v\fR
  29 Enable verbose logging for debugging purposes. Multiple \fB-v\fR
  30 options make the software increasingly verbose.
  31 .PP
  32 Arguments:
  33 .IP \fIclass\fR
  34 Name of a class of local transport channel endpoints,
  35 either \fBpublic\fR (accessible by any local user) or
  36 \fBprivate\fR (administrative access only).
  37 .IP \fIservice\fR
  38 The name of a local transport endpoint within the named class.
  39 .IP \fIrequest\fR
  40 A string. The list of valid requests is service-specific.
  41 .SH DIAGNOSTICS
  42 .ad
  43 .fi
  44 Problems and transactions are logged to the standard error
  45 stream.
  46 .SH "ENVIRONMENT"
  47 .na
  48 .nf
  49 .ad
  50 .fi
  51 .IP \fBMAIL_CONFIG\fR
  52 Directory with Postfix configuration files.
  53 .IP \fBMAIL_VERBOSE\fR
  54 Enable verbose logging for debugging purposes.
  55 .SH "CONFIGURATION PARAMETERS"
  56 .na
  57 .nf
  58 .ad
  59 .fi
  60 The following \fBmain.cf\fR parameters are especially relevant to
  61 this program.
  62 The text below provides only a parameter summary. See
  63 \fBpostconf\fR(5) for more details including examples.
  64 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
  65 The default location of the Postfix main.cf and master.cf
  66 configuration files.
  67 .IP "\fBapplication_event_drain_time (100s)\fR"
  68 How long the \fBpostkick\fR(1) command waits for a request to enter the
  69 server's input buffer before giving up.
  70 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
  71 The location of the Postfix top-level queue directory.
  72 .SH "FILES"
  73 .na
  74 .nf
  75 /var/spool/postfix/private, private class endpoints
  76 /var/spool/postfix/public, public class endpoints
  77 .SH "SEE ALSO"
  78 .na
  79 .nf
  80 qmgr(8), queue manager trigger protocol
  81 pickup(8), local pickup daemon
  82 postconf(5), configuration parameters
  83 .SH "LICENSE"
  84 .na
  85 .nf
  86 .ad
  87 .fi
  88 The Secure Mailer license must be distributed with this software.
  89 .SH "AUTHOR(S)"
  90 .na
  91 .nf
  92 Wietse Venema
  93 IBM T.J. Watson Research
  94 P.O. Box 704
  95 Yorktown Heights, NY 10598, USA