Update psql startup banner to be shorter, suggest "help" for help.
authorBruce Momjian
Fri, 16 May 2008 17:17:00 +0000 (17:17 +0000)
committerBruce Momjian
Fri, 16 May 2008 17:17:00 +0000 (17:17 +0000)
Add a few "help" entries.

Move \g help entry into "General".

Update psql version mismatch warning text.

Joshua D. Drake

doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/start.sgml
src/bin/psql/help.c
src/bin/psql/mainloop.c
src/bin/psql/startup.c

index 75392accf7d662bcfa4e1ff7637edca97697a6e2..57664e3082e6368cef966d68bbe4b9ffe328051f 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -571,13 +571,10 @@ $ psql "service=myservice sslmode=require"
     the string =>. For example:
 
 $ psql testdb
-Welcome to psql &version;, the PostgreSQL interactive terminal.
+psql (&version;)
+Type "help" for help.
 
-Type:  \copyright for distribution terms
-       \h for help with SQL commands
-       \? for help with psql commands
-       \g or terminate with semicolon to execute query
-       \q to quit
+test=>
 
 testdb=>
 
index 1ae900852faefbe89e28b80c937aeb6053489a8f..fbc0e3f7b3ab2ffe7ca5d844b7679ed433254248 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
  
   Getting Started
@@ -329,13 +329,8 @@ createdb: database creation failed: ERROR:  permission denied to create database
     In psql, you will be greeted with the following
     message:
 
-Welcome to psql &version;, the PostgreSQL interactive terminal.
-Type:  \copyright for distribution terms
-       \h for help with SQL commands
-       \? for help with psql commands
-       \g or terminate with semicolon to execute query
-       \q to quit
+psql (&version;)
+Type "help" for help.
  
 mydb=>
 
index 5b4ebffcf43bacef7900f379a49d64448dc1aed2..b9fd2d55e525bdcc446660b83afb425d93043149 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2000-2008, PostgreSQL Global Development Group
  *
- * $PostgreSQL: pgsql/src/bin/psql/help.c,v 1.127 2008/05/14 15:30:22 momjian Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/help.c,v 1.128 2008/05/16 17:17:00 momjian Exp $
  */
 #include "postgres_fe.h"
 
@@ -170,13 +170,13 @@ slashUsage(unsigned short int pager)
     */
    fprintf(output, _("General\n"));
    fprintf(output, _("  \\copyright     show PostgreSQL usage and distribution terms\n"));
+   fprintf(output, _("  \\g [FILE] or ; execute query (and send results to file or |pipe)\n"));
    fprintf(output, _("  \\h [NAME]      help on syntax of SQL commands, * for all commands\n"));
    fprintf(output, _("  \\q             quit psql\n"));
    fprintf(output, "\n");
 
    fprintf(output, _("Query Buffer\n"));
    fprintf(output, _("  \\e [FILE]      edit the query buffer (or file) with external editor\n"));
-   fprintf(output, _("  \\g [FILE]      send query buffer to server (and results to file or |pipe)\n"));
    fprintf(output, _("  \\p             show the contents of the query buffer\n"));
    fprintf(output, _("  \\r             reset (clear) the query buffer\n"));
 #ifdef USE_READLINE
index 1eb0ea44a3f1dbca864cc8dbccd5ea1dbf9f657f..9545eeb99a447dd3ba321c945d0d9bab2d090ac8 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2000-2008, PostgreSQL Global Development Group
  *
- * $PostgreSQL: pgsql/src/bin/psql/mainloop.c,v 1.90 2008/04/05 03:40:15 tgl Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/mainloop.c,v 1.91 2008/05/16 17:17:00 momjian Exp $
  */
 #include "postgres_fe.h"
 #include "mainloop.h"
@@ -177,10 +177,13 @@ MainLoop(FILE *source)
            (line[4] == '\0' || line[4] == ';' || isspace((unsigned char) line[4])))
        {
            free(line);
-           puts(_("You are using psql, the command-line interface to PostgreSQL."));
-           puts(_("Enter SQL commands, or type \\? for a list of backslash options."));
-           puts(_("Use \\h for SQL command help."));
-           puts(_("Use \\q to quit."));
+           puts(_("\nYou are using psql, the command-line interface to PostgreSQL."));
+           puts(_("\t\\? for psql help"));
+           puts(_("\t\\h or \\help for SQL help\n"));
+           puts(_("\t\\g or \";\" to execute a query"));
+           puts(_("\t\\q to quit psql\n"));
+           puts(_("\t\\copyright to view the copyright\n"));
+
            fflush(stdout);
            continue;
        }
index 89c3ef71a50534fbd74d79b870a7742617725552..17fdeb7288aed7207e617317eea2b4d0cec429e7 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2000-2008, PostgreSQL Global Development Group
  *
- * $PostgreSQL: pgsql/src/bin/psql/startup.c,v 1.147 2008/05/08 17:04:26 momjian Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/startup.c,v 1.148 2008/05/16 17:17:00 momjian Exp $
  */
 #include "postgres_fe.h"
 
@@ -317,33 +317,26 @@ main(int argc, char *argv[])
                    server_version = server_ver_str;
                }
 
-               printf(_("Welcome to %s %s (server %s), the PostgreSQL interactive terminal.\n\n"),
-                      pset.progname, PG_VERSION, server_version);
+               printf(_("%s (%s, server %s)\n"), 
+               pset.progname, PG_VERSION, server_version);
            }
            else
-               printf(_("Welcome to %s %s, the PostgreSQL interactive terminal.\n\n"),
-                      pset.progname, PG_VERSION);
-
-           printf(_("Type:  \\copyright for distribution terms\n"
-                    "       \\h for help with SQL commands\n"
-                    "       \\? for help with psql commands\n"
-                 "       \\g or terminate with semicolon to execute query\n"
-                    "       \\q to quit\n\n"));
+               printf("%s (%s)\n", pset.progname, PG_VERSION);
 
            if (pset.sversion / 100 != client_ver / 100)
-               printf(_("WARNING:  You are connected to a server with major version %d.%d,\n"
-                        "but your %s client is major version %d.%d.  Some backslash commands,\n"
-                        "such as \\d, might not work properly.\n\n"),
-                      pset.sversion / 10000, (pset.sversion / 100) % 100,
-                      pset.progname,
-                      client_ver / 10000, (client_ver / 100) % 100);
+               printf(_("WARNING: %s version %d.%d, server version %d.%d.\n"
+                    "         Some psql features might not work.\n"),
+                   pset.progname, client_ver / 10000, (client_ver / 100) % 100,
+                   pset.sversion / 10000, (pset.sversion / 100) % 100);
 
-#ifdef USE_SSL
-           printSSLInfo();
-#endif
 #ifdef WIN32
            checkWin32Codepage();
 #endif
+#ifdef USE_SSL
+           printSSLInfo();
+#endif
+
+           printf(_("Type \"help\" for help.\n\n"));
        }
 
        if (!pset.notty)
@@ -707,7 +700,7 @@ printSSLInfo(void)
        return;                 /* no SSL */
 
    SSL_get_cipher_bits(ssl, &sslbits);
-   printf(_("SSL connection (cipher: %s, bits: %i)\n\n"),
+   printf(_("SSL connection (cipher: %s, bits: %i)\n"),
           SSL_get_cipher(ssl), sslbits);
 }
 #endif
@@ -729,9 +722,9 @@ checkWin32Codepage(void)
    concp = GetConsoleCP();
    if (wincp != concp)
    {
-       printf(_("Warning: Console code page (%u) differs from Windows code page (%u)\n"
+       printf(_("WARNING: Console code page (%u) differs from Windows code page (%u)\n"
                 "         8-bit characters might not work correctly. See psql reference\n"
-              "         page \"Notes for Windows users\" for details.\n\n"),
+                "         page \"Notes for Windows users\" for details.\n"),
               concp, wincp);
    }
 }