doc: Update for Unix-domain sockets on Windows
authorPeter Eisentraut
Thu, 2 Apr 2020 06:01:30 +0000 (08:01 +0200)
committerPeter Eisentraut
Thu, 2 Apr 2020 06:01:30 +0000 (08:01 +0200)
Update the documentation to reflect that Unix-domain sockets are now
usable on Windows.

doc/src/sgml/config.sgml
doc/src/sgml/libpq.sgml
doc/src/sgml/ref/pgupgrade.sgml
doc/src/sgml/storage.sgml

index 2de21903a1516759c034775fe929459721a5d4d1..243d0198689f508d5137efb5cc1f6229b6bd864b 100644 (file)
@@ -751,6 +751,8 @@ include_dir 'conf.d'
         only TCP/IP sockets can be used to connect to the server.
         The default value is normally
         /tmp, but that can be changed at build time.
+        On Windows, the default is empty, which means no Unix-domain socket is
+        created by default.
         This parameter can only be set at server start.
        
 
@@ -762,11 +764,6 @@ include_dir 'conf.d'
         created in each of the unix_socket_directories directories.
         Neither file should ever be removed manually.
        
-
-       
-        This parameter is irrelevant on Windows, which does not have
-        Unix-domain sockets.
-       
       
      
 
@@ -789,8 +786,8 @@ include_dir 'conf.d'
        
 
        
-        This parameter is irrelevant on Windows, which does not have
-        Unix-domain sockets.
+        This parameter is not supported on Windows.  Any setting will be
+        ignored.
        
       
      
@@ -836,8 +833,6 @@ include_dir 'conf.d'
         10, that ignore socket permissions entirely.  There, one can achieve a
         similar effect by pointing unix_socket_directories to a
         directory having search permission limited to the desired audience.
-        This parameter is also irrelevant on Windows, which does not have
-        Unix-domain sockets.
        
       
      
index 9a24c19ccbf7520b36a86884ccdbebd5d195351a..c2b3cdabad121ad1c057e89fb592d6baae482676 100644 (file)
@@ -959,8 +959,9 @@ postgresql://[2001:db8::1234]/database
    
     The host component is interpreted as described for the parameter 
     linkend="libpq-connect-host"/>.  In particular, a Unix-domain socket
-    connection is chosen if the host part is either empty or starts with a
-    slash, otherwise a TCP/IP connection is initiated.  Note, however, that the
+    connection is chosen if the host part is either empty or looks like an
+    absolute path name,
+    otherwise a TCP/IP connection is initiated.  Note, however, that the
     slash is a reserved character in the hierarchical part of the URI.  So, to
     specify a non-standard Unix-domain socket directory, either omit the host
     specification in the URI and specify the host as a parameter, or
@@ -1035,16 +1036,19 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
       host
       
        
-        Name of host to connect to.host name
-        If a host name begins with a slash, it specifies Unix-domain
-        communication rather than TCP/IP communication; the value is the
-        name of the directory in which the socket file is stored.
-        The default behavior when host is
-        not specified, or is empty, is to connect to a Unix-domain
+        Name of host to connect to.host
+        name If a host name looks like an absolute path
+        name, it specifies Unix-domain communication rather than TCP/IP
+        communication; the value is the name of the directory in which the
+        socket file is stored.  (On Unix, an absolute path name begins with a
+        slash.  On Windows, paths starting with drive letters are also
+        recognized.)  The default behavior when host is not
+        specified, or is empty, is to connect to a Unix-domain
         socketUnix domain socket in
         /tmp (or whatever socket directory was specified
-        when PostgreSQL was built). On machines without
-        Unix-domain sockets, the default is to connect to localhost.
+        when PostgreSQL was built).  On Windows and
+        on machines without Unix-domain sockets, the default is to connect to
+        localhost.
        
        
         A comma-separated list of host names is also accepted, in which case
@@ -1123,8 +1127,8 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
        
        
         Without either a host name or host address,
-        libpq will connect using a
-        local Unix-domain socket; or on machines without Unix-domain
+        libpq will connect using a local
+        Unix-domain socket; or on Windows and on machines without Unix-domain
         sockets, it will attempt to connect to localhost.
        
        
index 49de1d57ab23c6589feac4c39f574edb6e8926ff..997ef1e12a41263d5af67631d55e7bc7252d1559 100644 (file)
@@ -751,7 +751,7 @@ psql --username=postgres --file=script.sql postgres
    can use the  option to put the socket files in some
    directory with a shorter path name.  For security, be sure that that
    directory is not readable or writable by any other users.
-   (This is not relevant on Windows.)
+   (This is not supported on Windows.)
   
 
   
index 1c19e863d2a0d76b80e983e091f029ec3196f316..3234adb639f58b3a4edb00b0e6d58018795b2e5f 100644 (file)
@@ -169,7 +169,7 @@ last started with
   cluster data directory path,
   postmaster start timestamp,
   port number,
-  Unix-domain socket directory path (empty on Windows),
+  Unix-domain socket directory path (could be empty),
   first valid listen_address (IP address or *, or empty if
   not listening on TCP),
   and shared memory segment ID