with-authinfo-kludge: Add machinery to restore signals in child processes.
[with-authinfo-kludge] / with-authinfo-kludge.1
index 9a6f940..5a67856 100644 (file)
@@ -83,7 +83,7 @@ program is an
 .I adverbial modifier
 which runs another command
 (typically a newsreader)
 .I adverbial modifier
 which runs another command
 (typically a newsreader)
-in an environment in which at can,
+in an environment in which it can,
 transparently to it,
 make connections to certain NNTP servers
 which usually require
 transparently to it,
 make connections to certain NNTP servers
 which usually require
@@ -91,7 +91,7 @@ which usually require
 authentication before they'll permit clients to read or post.
 This is useful because support for
 .B AUTHINFO GENERIC
 authentication before they'll permit clients to read or post.
 This is useful because support for
 .B AUTHINFO GENERIC
-has never been especially widely supported by newsreaders
+has never been especially widely implemented by newsreaders
 and now seems to be being withdrawn from those newsreaders
 which used to support it.
 .PP
 and now seems to be being withdrawn from those newsreaders
 which used to support it.
 .PP
@@ -210,7 +210,7 @@ If any are present, they take the place of any configuration file:
 an error is reported if a
 .B \-f
 option was passed.
 an error is reported if a
 .B \-f
 option was passed.
-A server configuration starts with 
+A server configuration starts with
 an argument consisting of a server name prefixed by a
 .RB ` + '
 character:
 an argument consisting of a server name prefixed by a
 .RB ` + '
 character:
@@ -234,9 +234,11 @@ is treated exactly the same as a configuration-file section
 .PP
 See below for details about the configuration file.
 .PP
 .PP
 See below for details about the configuration file.
 .PP
-To hedge against the unlikely event that the desired
+To hedge against the
 .IR command 's
 .IR command 's
-name actually begins with
+name containing an
+.RB ` = '
+or, less plausibly, beginning with
 .RB ` + ',
 an argument consisting of a
 .RB ` + '
 .RB ` + ',
 an argument consisting of a
 .RB ` + '
@@ -328,6 +330,14 @@ name from the section heading
 and may be equal to the
 .I remote
 address (below) without causing difficulty.
 and may be equal to the
 .I remote
 address (below) without causing difficulty.
+Note that
+.B with-authinfo-kludge
+will not do anything to encourage the client
+to connect to the right address;
+its caller must arrange to configure the client correctly,
+e.g., by setting the
+.B NNTPSERVER
+environment variable appropriately.
 .TP
 .BI nntpauth= "parameter arguments\fR..."
 Set the AUTHINFO GENERIC authentication parameter and arguments
 .TP
 .BI nntpauth= "parameter arguments\fR..."
 Set the AUTHINFO GENERIC authentication parameter and arguments
@@ -352,6 +362,7 @@ set up by the
 .B via
 parameter.
 The default is to use
 .B via
 parameter.
 The default is to use
+.\" FIXME Fuck you openssh
 127.1.0.1:119.
 It is
 .I not
 127.1.0.1:119.
 It is
 .I not
@@ -444,6 +455,7 @@ if no home directory was determined.
 Let
 .I config-home
 denote the configuration home directory so determined.
 Let
 .I config-home
 denote the configuration home directory so determined.
+.\" FIXME XDG_CONFIG_DIRS too now
 .hP 5.
 A `tag' is chosen, as follows.
 If the
 .hP 5.
 A `tag' is chosen, as follows.
 If the
@@ -472,7 +484,7 @@ No configuration file could be found,
 so a default configuration is constructed, as follows.
 Let
 .I nntp-server
 so a default configuration is constructed, as follows.
 Let
 .I nntp-server
-be the value of the 
+be the value of the
 .B NNTPSERVER
 environment variable;
 if it is not set, then a fatal error is reported.
 .B NNTPSERVER
 environment variable;
 if it is not set, then a fatal error is reported.
@@ -493,6 +505,10 @@ The runtime directory is chosen as follows.
 If the
 .B \-d
 option is present, then its value is used.
 If the
 .B \-d
 option is present, then its value is used.
+Otherwise, if the configuration file specifies
+a value for the global
+.B rundir
+parameter then that it used.
 .hP 2.
 If the environment variable
 .B XDG_RUNTIME_DIR
 .hP 2.
 If the environment variable
 .B XDG_RUNTIME_DIR
@@ -556,17 +572,20 @@ Let
 be the local machine's hostname,
 as reported by
 .BR gethostname (2).
 be the local machine's hostname,
 as reported by
 .BR gethostname (2).
-If
+Then
 .IB cache-home /with-authinfo-kludge. hostname
 .IB cache-home /with-authinfo-kludge. hostname
-does not exist,
+is used as the runtime directory.
+.PP
+If the directory chosen by the above procedure does not exist,
 then it is created as a directory,
 with mode 0700 (and modified by the umask).
 then it is created as a directory,
 with mode 0700 (and modified by the umask).
-This directory is then used as the runtime directory.
 (If it exists, but is not in fact a directory,
 then later operations will fail.)
 .PP
 The runtime directory contains a number of other directories,
 named
 (If it exists, but is not in fact a directory,
 then later operations will fail.)
 .PP
 The runtime directory contains a number of other directories,
 named
+.\" FIXME junk, new, naming
+.\" session dirs now entirely different
 .IR tag . pid \fR.
 Each such directory corresponds to a running
 (or failed)
 .IR tag . pid \fR.
 Each such directory corresponds to a running
 (or failed)