summaryrefslogtreecommitdiffstats
path: root/man/man1/postkick.1
blob: 779a35344e9983186ad23400518f9e2c06c20f37 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
.TH POSTKICK 1 
.ad
.fi
.SH NAME
postkick
\-
kick a Postfix service
.SH "SYNOPSIS"
.na
.nf
.fi
\fBpostkick\fR [\fB\-c \fIconfig_dir\fR] [\fB\-v\fR]
\fIclass service request\fR
.SH DESCRIPTION
.ad
.fi
The \fBpostkick\fR(1) command sends \fIrequest\fR to the
specified \fIservice\fR over a local transport channel.
This command makes Postfix private IPC accessible
for use in, for example, shell scripts.

Options:
.IP "\fB\-c\fR \fIconfig_dir\fR"
Read the \fBmain.cf\fR configuration file in the named directory
instead of the default configuration directory.
.IP \fB\-v\fR
Enable verbose logging for debugging purposes. Multiple \fB\-v\fR
options make the software increasingly verbose.
.PP
Arguments:
.IP \fIclass\fR
Name of a class of local transport channel endpoints,
either \fBpublic\fR (accessible by any local user) or
\fBprivate\fR (administrative access only).
.IP \fIservice\fR
The name of a local transport endpoint within the named class.
.IP \fIrequest\fR
A string. The list of valid requests is service\-specific.
.SH DIAGNOSTICS
.ad
.fi
Problems and transactions are logged to the standard error
stream.
.SH "ENVIRONMENT"
.na
.nf
.ad
.fi
.IP \fBMAIL_CONFIG\fR
Directory with Postfix configuration files.
.IP \fBMAIL_VERBOSE\fR
Enable verbose logging for debugging purposes.
.SH "CONFIGURATION PARAMETERS"
.na
.nf
.ad
.fi
The following \fBmain.cf\fR parameters are especially relevant to
this program.
The text below provides only a parameter summary. See
\fBpostconf\fR(5) for more details including examples.
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
The default location of the Postfix main.cf and master.cf
configuration files.
.IP "\fBapplication_event_drain_time (100s)\fR"
How long the \fBpostkick\fR(1) command waits for a request to enter the
Postfix daemon process input buffer before giving up.
.IP "\fBimport_environment (see 'postconf -d' output)\fR"
The list of environment variables that a privileged Postfix
process will import from a non\-Postfix parent process, or name=value
environment overrides.
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
The location of the Postfix top\-level queue directory.
.SH "FILES"
.na
.nf
/var/spool/postfix/private, private class endpoints
/var/spool/postfix/public, public class endpoints
.SH "SEE ALSO"
.na
.nf
qmgr(8), queue manager trigger protocol
pickup(8), local pickup daemon
postconf(5), configuration parameters
.SH "LICENSE"
.na
.nf
.ad
.fi
The Secure Mailer license must be distributed with this software.
.SH "AUTHOR(S)"
.na
.nf
Wietse Venema
IBM T.J. Watson Research
P.O. Box 704
Yorktown Heights, NY 10598, USA

Wietse Venema
Google, Inc.
111 8th Avenue
New York, NY 10011, USA