summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuss Allbery <eagle@eyrie.org>2014-01-05 10:49:17 -0800
committerRuss Allbery <rra@stanford.edu>2014-01-05 12:59:57 -0800
commita5a819c8951ee9da5fec5560f266a88d3b2fd551 (patch)
treef82a5103443dbe01b33eb50d6972a87974fbf3c8 /docs
parentfd54b5d2e4c709e081edd0901d754967067280fe (diff)
Add support for upstart's expect stop protocol
Add support for upstart's expect stop daemon synchronization method. When starting remctld in stand-alone mode with upstart, pass the new -Z option to remctld, and it will raise SIGSTOP when ready to accept connections, signaling to upstart that the daemon has fully started. Change-Id: Ief816224a80b0d7ff68033b454cf05bfa319cdeb Reviewed-on: https://gerrit.stanford.edu/1355 Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
Diffstat (limited to 'docs')
-rw-r--r--docs/remctld.pod16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/remctld.pod b/docs/remctld.pod
index f4a76cb..9cd23b4 100644
--- a/docs/remctld.pod
+++ b/docs/remctld.pod
@@ -1,8 +1,9 @@
=for stopwords
-remctld remctl -dFhmSv keytab GSS-API tcpserver inetd subcommand AFS
+remctld remctl -dFhmSvZ keytab GSS-API tcpserver inetd subcommand AFS
backend logmask NUL acl ACL princ filename gput CMU GPUT xform ANYUSER IP
IPv4 IPv6 hostname SCPRINCIPAL sysctld Heimdal MICs Ushakov Allbery
subcommands REMUSER pcre PCRE triple-DES MERCHANTABILITY username arg
+SIGCONT SIGSTOP
=head1 NAME
@@ -10,7 +11,7 @@ remctld - Server for remctl, a remote command execution utility
=head1 SYNOPSIS
-remctld [B<-dFhmSv>] [B<-b> I<bind-address> [B<-b> I<bind-address> ...]]
+remctld [B<-dFhmSvZ>] [B<-b> I<bind-address> [B<-b> I<bind-address> ...]]
[B<-f> I<config>] [B<-k> I<keytab>] [B<-P> I<file>] [B<-p> I<port>]
[B<-s> I<service>]
@@ -99,7 +100,7 @@ I<file>. This option is ignored unless B<-m> is also given.
=item B<-p> I<port>
-When running in stand-alone mode, Listen on port I<port> rather than the
+When running in stand-alone mode, listen on port I<port> rather than the
default. This option does nothing unless used with B<-m>.
=item B<-S>
@@ -120,6 +121,15 @@ with the B<-k> option). This is normally the most desirable behavior.
Print the version of B<remctld> and exit.
+=item B<-Z>
+
+When B<remctld> is running in stand-alone mode, after it has set up its
+network socket and is ready to answer requests, raise SIGSTOP. This
+signals to upstart, when using C<expect stop>, that the daemon is ready to
+accept connections, and upstart will raise SIGCONT to allow B<remctld> to
+continue. This option is probably only useful when using upstart as the
+init system. Only makes sense in combination with B<-m>.
+
=back
=head1 CONFIGURATION FILE