doc: libpq connection options can override command-line flags
authorBruce Momjian
Sat, 3 Oct 2020 02:19:31 +0000 (22:19 -0400)
committerBruce Momjian
Sat, 3 Oct 2020 02:19:31 +0000 (22:19 -0400)
Reported-by: Alexander Lakhin
Discussion: https://postgr.es/m/16486-b9c93d71c02c4907@postgresql.org

Backpatch-through: 9.5

doc/src/sgml/ref/clusterdb.sgml
doc/src/sgml/ref/pg_basebackup.sgml
doc/src/sgml/ref/pg_dump.sgml
doc/src/sgml/ref/pg_dumpall.sgml
doc/src/sgml/ref/pg_isready.sgml
doc/src/sgml/ref/pg_receivewal.sgml
doc/src/sgml/ref/pg_recvlogical.sgml
doc/src/sgml/ref/pg_restore.sgml
doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/ref/reindexdb.sgml
doc/src/sgml/ref/vacuumdb.sgml

index 177856ca74d257a54e0b5f01d5caa6236f6b5604..c53bacf8648c08e36b23813b173fa529b05b0519 100644 (file)
@@ -95,7 +95,10 @@ PostgreSQL documentation
         ) is not used, the database name is read
         from the environment variable PGDATABASE.  If
         that is not set, the user name specified for the connection is
-        used.
+        used.  The dbname can be a 
+        linkend="libpq-connstring">connection string.  If so,
+        connection string parameters will override any conflicting command
+        line options.
        
       
      
index 44e7b2444b7ea2fb014fbc647df53797775ff769..e993e8761c13f502c48c03fafb189a58477381bd 100644 (file)
@@ -653,8 +653,9 @@ PostgreSQL documentation
       
       
        
-        Specifies parameters used to connect to the server, as a connection
-        string. See  for more information.
+        Specifies parameters used to connect to the server, as a 
+        linkend="libpq-connstring">connction string;  these
+        will override any conflicting command line options.
        
        
         The option is called --dbname for consistency with other
index e9b5e75d60bf94b6dd495f5e11739f26c0d07993..3e48498db28fac2c8ae176d4150f2564ac7b2dc5 100644 (file)
@@ -1129,14 +1129,10 @@ PostgreSQL documentation
        Specifies the name of the database to connect to. This is
        equivalent to specifying 
        class="parameter">dbname as the first non-option
-       argument on the command line.
-      
-      
-       If this parameter contains an = sign or starts
-       with a valid URI prefix
-       (postgresql://
-       or postgres://), it is treated as a
-       conninfo string. See  for more information.
+       argument on the command line.  The dbname
+       can be a connection string.
+       If so, connection string parameters will override any conflicting
+       command line options.
       
       
      
index 43abc530a0f617380a76434b0d6c39f878c92bc5..4645e3820a22ceeb4fc64c4f5f64d25482c55665 100644 (file)
@@ -550,8 +550,9 @@ PostgreSQL documentation
       
       
        
-        Specifies parameters used to connect to the server, as a connection
-        string. See  for more information.
+        Specifies parameters used to connect to the server, as a 
+        linkend="libpq-connstring">connction string;  these
+        will override any conflicting command line options.
        
        
         The option is called --dbname for consistency with other
index 3d5b551b87f26493476dee1e8fe0b7ca7adf39d9..ba25ca65a40e00c39330eb0d44c26342ceaefb12 100644 (file)
@@ -47,15 +47,11 @@ PostgreSQL documentation
       
       
       
-       Specifies the name of the database to connect to.
-      
-      
-       If this parameter contains an = sign or starts
-       with a valid URI prefix
-       (postgresql://
-       or postgres://), it is treated as a
-       conninfo string. See 
-       linkend="libpq-connstring"/> for more information.
+       Specifies the name of the database to connect to. The
+       dbname can be a 
+       linkend="libpq-connstring">connection string.  If so,
+       connection string parameters will override any conflicting command
+       line options.
       
       
     
index cad4689ae6070617ed6f963b98e401deee93349d..ea257d1d1c29538150194668c3e4f97f74b7c88b 100644 (file)
@@ -252,8 +252,9 @@ PostgreSQL documentation
       
       
        
-        Specifies parameters used to connect to the server, as a connection
-        string. See  for more information.
+        Specifies parameters used to connect to the server, as a 
+        linkend="libpq-connstring">connction string;  these
+        will override any conflicting command line options.
        
        
         The option is called --dbname for consistency with other
index 41508fdc1e56cc6c9c9322c371580a1f3ba54315..6b1d98d06ef1f69c06840aba465e9b79ba946ecd 100644 (file)
@@ -273,14 +273,16 @@ PostgreSQL documentation
 
     
       
-       
-       
+       
+       
        
         
-         The database to connect to.  See the description of the actions for
-         what this means in detail.  This can be a libpq connection string;
-         see  for more information.  Defaults
-         to user name.
+         The database to connect to.  See the description
+         of the actions for what this means in detail.
+         The dbname can be a 
+         linkend="libpq-connstring">connection string.  If so,
+         connection string parameters will override any conflicting
+         command line options.  Defaults to the user name.
         
        
       
index d724e45f8b0d35295c18f930fed0895301488f4f..74e9e1feebfaecc5195c21c09b192ba03330e5db 100644 (file)
@@ -156,7 +156,10 @@ PostgreSQL documentation
        
         Connect to database 
         class="parameter">dbname and restore directly
-        into the database.
+        into the database.  The dbname can
+        be a connection string.
+        If so, connection string parameters will override any conflicting
+        command line options.
        
       
      
index 201946990f4333ad304c56e4f57003505fb22189..45381329cdab2ae89fad39eb6c9a16ead83a2cc3 100644 (file)
@@ -168,15 +168,10 @@ EOF
        Specifies the name of the database to connect to. This is
        equivalent to specifying 
        class="parameter">dbname as the first non-option
-       argument on the command line.
-      
-      
-       If this parameter contains an = sign or starts
-       with a valid URI prefix
-       (postgresql://
-       or postgres://), it is treated as a
-       conninfo string. See 
-       linkend="libpq-connstring"/> for more information.
+       argument on the command line.  The dbname
+       can be a connection string.
+       If so, connection string parameters will override any conflicting
+       command line options.
       
       
     
@@ -498,7 +493,7 @@ EOF
      
       
        Never issue a password prompt.  If the server requires password
-       authentication and a password is not available by other means
+       authentication and a password is not available from other sources
        such as a .pgpass file, the connection
        attempt will fail.  This option can be useful in batch jobs and
        scripts where no user is present to enter a password.
@@ -518,13 +513,15 @@ EOF
       
       
        Force psql to prompt for a
-       password before connecting to a database.
+       password before connecting to a database, even if the password will
+       not be used.
       
 
       
-       This option is never essential, since psql
-       will automatically prompt for a password if the server demands
-       password authentication.  However, psql
+       If the server requires password authentication and a password is not
+       available from other sources such as a .pgpass
+       file, psql will prompt for a
+       password in any case.  However, psql
        will waste a connection attempt finding out that the server wants a
        password.  In some cases it is worth typing  to avoid
        the extra connection attempt.
index 4f821c2095ef71d31b10ddac46bd7dc2a134e6f7..0f3f12bfbfc65fb31a4022c52b40a86693a87064 100644 (file)
@@ -139,7 +139,10 @@ PostgreSQL documentation
         ) is not used, the database name is read
         from the environment variable PGDATABASE.  If
         that is not set, the user name specified for the connection is
-        used.
+        used.  The dbname can be a 
+        linkend="libpq-connstring">connection string.  If so,
+        connection string parameters will override any conflicting command
+        line options.
        
       
      
index 80a1890a5155c322a792d882c333a1a6e5f0c361..e8e3166024a0a1d8baff22c4b6cd3771f28464a1 100644 (file)
@@ -97,7 +97,10 @@ PostgreSQL documentation
         ) is not used, the database name is read
         from the environment variable PGDATABASE.  If
         that is not set, the user name specified for the connection is
-        used.
+        used.  The dbname can be a 
+        linkend="libpq-connstring">connection string.  If so,
+        connection string parameters will override any conflicting command
+        line options.