X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=doc%2Fman%2Finnduct.8;h=a4c028f9a98922ea8243c02e62c49a72ed1ed479;hb=03afab2d8ef7b2f62424cf96192d378ca15e8ad4;hp=055d083085466bc77731e9e0a0751a0cae9a355b;hpb=8637044e5d6c13c4ddf8dc83440a59b060b25a3d;p=inn-innduct.git

diff --git a/doc/man/innduct.8 b/doc/man/innduct.8
index 055d083..a4c028f 100644
--- a/doc/man/innduct.8
+++ b/doc/man/innduct.8
@@ -88,7 +88,8 @@ be logged and a nonzero exit.
 .TP
 .BR \-\-no-daemon
 Do not daemonise.  innduct runs in the foreground and all messages
-(including all debug messages) are written to stderr.
+(including all debug messages) are written to stderr.  A control
+command line is also available on stdin/stdout.
 .TP
 .BI \-\-no-streaming
 Do not try to use the streaming extensions to NNTP (for use eg if the
@@ -106,26 +107,37 @@ Read
 instead of the default
 .BR inn.conf .
 .TP
-.BR \-\-cli= \fIDIR\fR / |\fIPATH\fR
-Bind the control command line socket to
-.IB DIR / site _cli
-(if the value ends with a
-.BR /)
-or
-.I PATH
-(if it doesn't).  See CONTROLLING INNDUCT, below.
-This option may be essential, if the
-path to
-.I feedfile
-is too long, as there is a fairly short limit on the paths to AF_UNIX
-sockets.  The default is
-.IR feedfile \fB_cli\fR.  
-.TP
 .BI \-\-port= PORT
 Connect to port
 .I PORT
 at the remote site rather than to the NNTP port (119).
 .TP
+.BI \-\-chdir= pathrun
+Change directory to
+.IR pathrun
+at startup.  The default is
+.I pathrun
+from inn.conf.
+.TP
+.BR \-\-cli= \fICLI-DIR\fR / |\fICLI-PATH\fR| none
+Listen for control command line connections on
+.IB CLI-DIR / site
+(if the value ends with a
+.BR /)
+or
+.I CLI-PATH
+(if it doesn't).  See CONTROLLING INNDUCT, below.
+Note that there is a fairly short limit on the paths to AF_UNIX
+sockets.  If specified as
+.IR CLI-DIR \fB/\fR,
+the directory will be created with mode 700 if necessary.
+The default is
+.B innduct/
+which means to create that directory in
+.I pathrun
+and listen on
+.RB \fIpathrun\fR /innduct/ \fIsite\fR.
+.TP
 .BI \-\-help
 Just print a brief usage message and list of the options to stdout.
 .SH TUNING OPTIONS
@@ -321,14 +333,14 @@ corrupted; you just won't see some of the article stats.
 .LP
 innduct listens on an AF_UNIX socket, and provides a command-line
 interface which can be used to trigger various events and for
-debugging.  The socket is called
-.IB feedfile _cli
+debugging.  innduct listens (by default on
+.IR pathrun \fB/innduct/\fR site )
 and when connected reads and writes lines (with unix line endings).
-It can most easily be accessed with a program like
+The cli can most easily be accessed with a program like
 .I netcat-openbsd
 (eg
-.B nc.openbsd -U
-.IR feedfile \fB_cli\fR)
+.B nc.openbsd -U /var/run/news/innduct/
+.IR site )
 or
 .IR socat .
 The prompt is
@@ -424,6 +436,10 @@ two ascii-art diagrams in innduct.c for details of the protocol.)  Do
 not mess with the feedfile and other associated files, other than as
 explained here:
 .IX Header "FILES"
+.IP \fIpathrun\fR
+.IX Item "default directory"
+Default current working directory for innduct, and also default
+parent directory for the command line socket.
 .IP \fIpathoutgoing\fR/\fIsite\fR
 .IX Item "default feedfile"
 Default
@@ -485,7 +501,7 @@ safely remove backlog files.  \fIsomething\fR may not contain \fB#\fR
 you rename it to match the pattern \fIfeedfile\fR\fB_backlog\fR*, as
 otherwise innduct may find and process the file and read it to EOF
 before you have finished creating it.
-.IP \fIfeedfile\fR_cli
+.IP \fIpathrun\fR\fB/innduct/\fB\fIsite\fR
 .IX Item "control command line socket"
 Default AF_UNIX listening socket for the control command line.  See
 CONTROLLING INNDUCT, above.
@@ -495,10 +511,17 @@ On request via a control connection innduct dumps a summary of its
 state to this text file.  This is mostly useful for debugging.
 .IP /etc/news/inn.conf
 .IX Item inn.conf
-Used to find
+Used for
 .IR pathoutgoing
-if none is specified, for finding how to communicate with innd,
-and also for
+(to compute default
+.IR feedfile
+and associated paths),
+.IR pathrun
+(to compute default
+.IR CLI-DIR
+and
+.IR CLI-PATH ),
+for finding how to communicate with innd, and also for
 .IR sourceaddress
 and/or
 .IR sourceaddress6 .