with-authinfo-kludge.1: Explain that we don't configure the client.

[with-authinfo-kludge] / with-authinfo-kludge.1

diff --git a/with-authinfo-kludge.1 b/with-authinfo-kludge.1
index c8f1827..de0e417 100644 (file)
--- a/with-authinfo-kludge.1
+++ b/with-authinfo-kludge.1
@@ -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:


@@ -328,6 +328,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


@@ -472,7 +480,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 +501,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,12 +568,13 @@ 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
 (If it exists, but is not in fact a directory,
 then later operations will fail.)
 .PP


@@ -618,10 +631,6 @@ to share the same proxy machinery.
 This is somewhat wasteful.
 Fixing this would necessitate some other way of
 orchestrating the setup and teardown of runtime directories.
 This is somewhat wasteful.
 Fixing this would necessitate some other way of
 orchestrating the setup and teardown of runtime directories.

-.PP
-Maybe there ought to be a way to set
-a separate runtime directory for each server.
-But, really, I had to draw a line somewhere.

 .
 .\"--------------------------------------------------------------------------
 .SH SEE ALSO
 .
 .\"--------------------------------------------------------------------------
 .SH SEE ALSO