2000-01-19 00:30:24 +01:00
|
|
|
/*
|
|
|
|
* psql - the PostgreSQL interactive terminal
|
|
|
|
*
|
2017-01-03 19:48:53 +01:00
|
|
|
* Copyright (c) 2000-2017, PostgreSQL Global Development Group
|
2000-01-19 00:30:24 +01:00
|
|
|
*
|
2010-09-20 22:08:53 +02:00
|
|
|
* src/bin/psql/help.c
|
2000-01-19 00:30:24 +01:00
|
|
|
*/
|
2001-02-10 03:31:31 +01:00
|
|
|
#include "postgres_fe.h"
|
1999-11-04 22:56:02 +01:00
|
|
|
|
|
|
|
#ifndef WIN32
|
2005-01-08 23:51:15 +01:00
|
|
|
#include <unistd.h> /* for geteuid() */
|
1999-11-04 22:56:02 +01:00
|
|
|
#else
|
2000-02-08 00:10:11 +01:00
|
|
|
#include <win32.h>
|
1999-11-04 22:56:02 +01:00
|
|
|
#endif
|
|
|
|
|
2008-01-20 22:13:55 +01:00
|
|
|
#ifndef WIN32
|
|
|
|
#include <sys/ioctl.h> /* for ioctl() */
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef HAVE_TERMIOS_H
|
|
|
|
#include <termios.h>
|
|
|
|
#endif
|
|
|
|
|
1999-11-04 22:56:02 +01:00
|
|
|
#include "common.h"
|
2014-01-11 00:03:28 +01:00
|
|
|
#include "common/username.h"
|
2006-07-15 05:35:21 +02:00
|
|
|
#include "help.h"
|
|
|
|
#include "input.h"
|
|
|
|
#include "settings.h"
|
1999-11-04 22:56:02 +01:00
|
|
|
#include "sql_help.h"
|
|
|
|
|
2006-07-15 05:35:21 +02:00
|
|
|
|
2000-02-20 15:28:28 +01:00
|
|
|
/*
|
|
|
|
* PLEASE:
|
|
|
|
* If you change something in this file, also make the same changes
|
|
|
|
* in the DocBook documentation, file ref/psql-ref.sgml. If you don't
|
|
|
|
* know how to do it, please find someone who can help you.
|
|
|
|
*/
|
|
|
|
|
1999-11-04 22:56:02 +01:00
|
|
|
|
|
|
|
/*
|
|
|
|
* usage
|
|
|
|
*
|
2000-01-12 20:36:36 +01:00
|
|
|
* print out command line arguments
|
1999-11-04 22:56:02 +01:00
|
|
|
*/
|
2001-06-02 20:25:18 +02:00
|
|
|
#define ON(var) (var ? _("on") : _("off"))
|
1999-11-04 22:56:02 +01:00
|
|
|
|
1999-11-05 00:14:30 +01:00
|
|
|
void
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
usage(unsigned short int pager)
|
1999-11-04 22:56:02 +01:00
|
|
|
{
|
1999-11-05 00:14:30 +01:00
|
|
|
const char *env;
|
|
|
|
const char *user;
|
2013-12-18 18:16:16 +01:00
|
|
|
char *errstr;
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
FILE *output;
|
1999-11-04 22:56:02 +01:00
|
|
|
|
1999-11-05 00:14:30 +01:00
|
|
|
/* Find default user, in case we need it. */
|
2002-08-10 18:57:32 +02:00
|
|
|
user = getenv("PGUSER");
|
1999-11-05 00:14:30 +01:00
|
|
|
if (!user)
|
|
|
|
{
|
2013-12-18 18:16:16 +01:00
|
|
|
user = get_user_name(&errstr);
|
|
|
|
if (!user)
|
1999-11-05 00:14:30 +01:00
|
|
|
{
|
2013-12-18 18:16:16 +01:00
|
|
|
psql_error("%s\n", errstr);
|
1999-11-05 00:14:30 +01:00
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
|
|
|
}
|
1999-11-04 22:56:02 +01:00
|
|
|
|
2015-09-05 17:58:20 +02:00
|
|
|
/*
|
|
|
|
* Keep this line count in sync with the number of lines printed below!
|
|
|
|
* Use "psql --help=options | wc" to count correctly.
|
|
|
|
*/
|
2016-08-18 22:04:35 +02:00
|
|
|
output = PageOutput(61, pager ? &(pset.popt.topt) : NULL);
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _("psql is the PostgreSQL interactive terminal.\n\n"));
|
|
|
|
fprintf(output, _("Usage:\n"));
|
|
|
|
fprintf(output, _(" psql [OPTION]... [DBNAME [USERNAME]]\n\n"));
|
1999-11-05 00:14:30 +01:00
|
|
|
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("General options:\n"));
|
1999-11-05 00:14:30 +01:00
|
|
|
/* Display default database */
|
|
|
|
env = getenv("PGDATABASE");
|
|
|
|
if (!env)
|
|
|
|
env = user;
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -c, --command=COMMAND run only single command (SQL or internal) and exit\n"));
|
|
|
|
fprintf(output, _(" -d, --dbname=DBNAME database name to connect to (default: \"%s\")\n"), env);
|
|
|
|
fprintf(output, _(" -f, --file=FILENAME execute commands from file, then exit\n"));
|
|
|
|
fprintf(output, _(" -l, --list list available databases, then exit\n"));
|
|
|
|
fprintf(output, _(" -v, --set=, --variable=NAME=VALUE\n"
|
2016-06-10 00:02:36 +02:00
|
|
|
" set psql variable NAME to VALUE\n"
|
|
|
|
" (e.g., -v ON_ERROR_STOP=1)\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -V, --version output version information, then exit\n"));
|
|
|
|
fprintf(output, _(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n"));
|
|
|
|
fprintf(output, _(" -1 (\"one\"), --single-transaction\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" execute as a single transaction (if non-interactive)\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -?, --help[=options] show this help, then exit\n"));
|
2015-09-16 06:37:39 +02:00
|
|
|
fprintf(output, _(" --help=commands list backslash commands, then exit\n"));
|
|
|
|
fprintf(output, _(" --help=variables list special variables, then exit\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _("\nInput and output options:\n"));
|
|
|
|
fprintf(output, _(" -a, --echo-all echo all input from script\n"));
|
|
|
|
fprintf(output, _(" -b, --echo-errors echo failed commands\n"));
|
|
|
|
fprintf(output, _(" -e, --echo-queries echo commands sent to server\n"));
|
|
|
|
fprintf(output, _(" -E, --echo-hidden display queries that internal commands generate\n"));
|
|
|
|
fprintf(output, _(" -L, --log-file=FILENAME send session log to file\n"));
|
|
|
|
fprintf(output, _(" -n, --no-readline disable enhanced command line editing (readline)\n"));
|
|
|
|
fprintf(output, _(" -o, --output=FILENAME send query results to file (or |pipe)\n"));
|
|
|
|
fprintf(output, _(" -q, --quiet run quietly (no messages, only query output)\n"));
|
|
|
|
fprintf(output, _(" -s, --single-step single-step mode (confirm each query)\n"));
|
|
|
|
fprintf(output, _(" -S, --single-line single-line mode (end of line terminates SQL command)\n"));
|
|
|
|
|
|
|
|
fprintf(output, _("\nOutput format options:\n"));
|
|
|
|
fprintf(output, _(" -A, --no-align unaligned table output mode\n"));
|
|
|
|
fprintf(output, _(" -F, --field-separator=STRING\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" field separator for unaligned output (default: \"%s\")\n"),
|
|
|
|
DEFAULT_FIELD_SEP);
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -H, --html HTML table output mode\n"));
|
|
|
|
fprintf(output, _(" -P, --pset=VAR[=ARG] set printing option VAR to ARG (see \\pset command)\n"));
|
|
|
|
fprintf(output, _(" -R, --record-separator=STRING\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" record separator for unaligned output (default: newline)\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -t, --tuples-only print rows only\n"));
|
|
|
|
fprintf(output, _(" -T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)\n"));
|
|
|
|
fprintf(output, _(" -x, --expanded turn on expanded table output\n"));
|
|
|
|
fprintf(output, _(" -z, --field-separator-zero\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" set field separator for unaligned output to zero byte\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -0, --record-separator-zero\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" set record separator for unaligned output to zero byte\n"));
|
2009-02-27 10:58:09 +01:00
|
|
|
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("\nConnection options:\n"));
|
1999-11-05 00:14:30 +01:00
|
|
|
/* Display default host */
|
|
|
|
env = getenv("PGHOST");
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -h, --host=HOSTNAME database server host or socket directory (default: \"%s\")\n"),
|
2015-05-24 03:35:49 +02:00
|
|
|
env ? env : _("local socket"));
|
1999-11-05 00:14:30 +01:00
|
|
|
/* Display default port */
|
|
|
|
env = getenv("PGPORT");
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -p, --port=PORT database server port (default: \"%s\")\n"),
|
2015-05-24 03:35:49 +02:00
|
|
|
env ? env : DEF_PGPORT_STR);
|
1999-11-05 00:14:30 +01:00
|
|
|
/* Display default user */
|
|
|
|
env = getenv("PGUSER");
|
|
|
|
if (!env)
|
|
|
|
env = user;
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" -U, --username=USERNAME database user name (default: \"%s\")\n"), env);
|
|
|
|
fprintf(output, _(" -w, --no-password never prompt for password\n"));
|
|
|
|
fprintf(output, _(" -W, --password force password prompt (should happen automatically)\n"));
|
2009-02-27 10:58:09 +01:00
|
|
|
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("\nFor more information, type \"\\?\" (for internal commands) or \"\\help\" (for SQL\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
"commands) from within psql, or consult the psql section in the PostgreSQL\n"
|
|
|
|
"documentation.\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
|
|
|
|
|
|
|
|
ClosePager(output);
|
1999-11-04 22:56:02 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* slashUsage
|
|
|
|
*
|
|
|
|
* print out help for the backslash commands
|
|
|
|
*/
|
|
|
|
void
|
2002-11-08 20:12:21 +01:00
|
|
|
slashUsage(unsigned short int pager)
|
1999-11-04 22:56:02 +01:00
|
|
|
{
|
2002-10-23 21:23:57 +02:00
|
|
|
FILE *output;
|
2013-01-15 17:54:03 +01:00
|
|
|
char *currdb;
|
|
|
|
|
|
|
|
currdb = PQdb(pset.db);
|
2002-07-15 03:56:25 +02:00
|
|
|
|
2015-09-05 17:58:20 +02:00
|
|
|
/*
|
|
|
|
* Keep this line count in sync with the number of lines printed below!
|
|
|
|
* Use "psql --help=commands | wc" to count correctly. It's okay to count
|
|
|
|
* the USE_READLINE line even in builds without that.
|
|
|
|
*/
|
2016-08-18 22:04:35 +02:00
|
|
|
output = PageOutput(113, pager ? &(pset.popt.topt) : NULL);
|
2002-09-04 22:31:48 +02:00
|
|
|
|
2002-12-11 23:45:13 +01:00
|
|
|
fprintf(output, _("General\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\copyright show PostgreSQL usage and distribution terms\n"));
|
2016-04-03 18:29:55 +02:00
|
|
|
fprintf(output, _(" \\errverbose show most recent error message at maximum verbosity\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\g [FILE] or ; execute query (and send results to file or |pipe)\n"));
|
2017-03-07 15:31:52 +01:00
|
|
|
fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n"));
|
Add a \gexec command to psql for evaluation of computed queries.
\gexec executes the just-entered query, like \g, but instead of printing
the results it takes each field as a SQL command to send to the server.
Computing a series of queries to be executed is a fairly common thing,
but up to now you always had to resort to kluges like writing the queries
to a file and then inputting the file. Now it can be done with no
intermediate step.
The implementation is fairly straightforward except for its interaction
with FETCH_COUNT. ExecQueryUsingCursor isn't capable of being called
recursively, and even if it were, its need to create a transaction
block interferes unpleasantly with the desired behavior of \gexec after
a failure of a generated query (i.e., that it can continue). Therefore,
disable use of ExecQueryUsingCursor when doing the master \gexec query.
We can still apply it to individual generated queries, however, and there
might be some value in doing so.
While testing this feature's interaction with single-step mode, I (tgl) was
led to conclude that SendQuery needs to recognize SIGINT (cancel_pressed)
as a negative response to the single-step prompt. Perhaps that's a
back-patchable bug fix, but for now I just included it here.
Corey Huinker, reviewed by Jim Nasby, Daniel Vérité, and myself
2016-04-04 21:25:16 +02:00
|
|
|
fprintf(output, _(" \\gexec execute query, then execute each value in its result\n"));
|
2013-02-02 23:06:38 +01:00
|
|
|
fprintf(output, _(" \\gset [PREFIX] execute query and store results in psql variables\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\q quit psql\n"));
|
2016-04-09 01:23:18 +02:00
|
|
|
fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n"));
|
2013-04-05 01:56:33 +02:00
|
|
|
fprintf(output, _(" \\watch [SEC] execute query every SEC seconds\n"));
|
2003-07-23 10:47:41 +02:00
|
|
|
fprintf(output, "\n");
|
2002-12-11 23:45:13 +01:00
|
|
|
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("Help\n"));
|
|
|
|
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" \\? [commands] show help on backslash commands\n"));
|
|
|
|
fprintf(output, _(" \\? options show help on psql command-line options\n"));
|
|
|
|
fprintf(output, _(" \\? variables show help on special variables\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" \\h [NAME] help on syntax of SQL commands, * for all commands\n"));
|
|
|
|
fprintf(output, "\n");
|
|
|
|
|
2002-12-11 23:45:13 +01:00
|
|
|
fprintf(output, _("Query Buffer\n"));
|
2010-08-12 02:40:59 +02:00
|
|
|
fprintf(output, _(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n"));
|
|
|
|
fprintf(output, _(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n"));
|
2015-07-03 21:48:18 +02:00
|
|
|
fprintf(output, _(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\p show the contents of the query buffer\n"));
|
|
|
|
fprintf(output, _(" \\r reset (clear) the query buffer\n"));
|
2004-10-06 20:39:16 +02:00
|
|
|
#ifdef USE_READLINE
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\s [FILE] display history or save it to file\n"));
|
2004-10-06 20:39:16 +02:00
|
|
|
#endif
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\w FILE write query buffer to file\n"));
|
2003-07-23 10:47:41 +02:00
|
|
|
fprintf(output, "\n");
|
2002-12-11 23:45:13 +01:00
|
|
|
|
2002-12-13 23:17:57 +01:00
|
|
|
fprintf(output, _("Input/Output\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\copy ... perform SQL COPY with data stream to the client host\n"));
|
|
|
|
fprintf(output, _(" \\echo [STRING] write string to standard output\n"));
|
|
|
|
fprintf(output, _(" \\i FILE execute commands from file\n"));
|
2011-07-06 17:45:13 +02:00
|
|
|
fprintf(output, _(" \\ir FILE as \\i, but relative to location of current script\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\o [FILE] send all query results to file or |pipe\n"));
|
|
|
|
fprintf(output, _(" \\qecho [STRING] write string to query output stream (see \\o)\n"));
|
2003-07-23 10:47:41 +02:00
|
|
|
fprintf(output, "\n");
|
2002-12-12 00:03:45 +01:00
|
|
|
|
2002-12-11 23:45:13 +01:00
|
|
|
fprintf(output, _("Informational\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" (options: S = show system objects, + = additional detail)\n"));
|
|
|
|
fprintf(output, _(" \\d[S+] list tables, views, and sequences\n"));
|
|
|
|
fprintf(output, _(" \\d[S+] NAME describe table, view, sequence, or index\n"));
|
2010-05-26 21:29:22 +02:00
|
|
|
fprintf(output, _(" \\da[S] [PATTERN] list aggregates\n"));
|
2016-06-07 23:59:34 +02:00
|
|
|
fprintf(output, _(" \\dA[+] [PATTERN] list access methods\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\db[+] [PATTERN] list tablespaces\n"));
|
2011-08-08 18:26:13 +02:00
|
|
|
fprintf(output, _(" \\dc[S+] [PATTERN] list conversions\n"));
|
2011-08-04 18:22:26 +02:00
|
|
|
fprintf(output, _(" \\dC[+] [PATTERN] list casts\n"));
|
2011-08-11 17:16:29 +02:00
|
|
|
fprintf(output, _(" \\dd[S] [PATTERN] show object descriptions not displayed elsewhere\n"));
|
2009-10-05 21:24:49 +02:00
|
|
|
fprintf(output, _(" \\ddp [PATTERN] list default privileges\n"));
|
2011-08-08 18:26:13 +02:00
|
|
|
fprintf(output, _(" \\dD[S+] [PATTERN] list domains\n"));
|
2011-01-02 05:48:11 +01:00
|
|
|
fprintf(output, _(" \\det[+] [PATTERN] list foreign tables\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\des[+] [PATTERN] list foreign servers\n"));
|
|
|
|
fprintf(output, _(" \\deu[+] [PATTERN] list user mappings\n"));
|
|
|
|
fprintf(output, _(" \\dew[+] [PATTERN] list foreign-data wrappers\n"));
|
2009-04-22 16:58:48 +02:00
|
|
|
fprintf(output, _(" \\df[antw][S+] [PATRN] list [only agg/normal/trigger/window] functions\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\dF[+] [PATTERN] list text search configurations\n"));
|
|
|
|
fprintf(output, _(" \\dFd[+] [PATTERN] list text search dictionaries\n"));
|
|
|
|
fprintf(output, _(" \\dFp[+] [PATTERN] list text search parsers\n"));
|
|
|
|
fprintf(output, _(" \\dFt[+] [PATTERN] list text search templates\n"));
|
2016-04-08 22:56:27 +02:00
|
|
|
fprintf(output, _(" \\dg[S+] [PATTERN] list roles\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\di[S+] [PATTERN] list indexes\n"));
|
|
|
|
fprintf(output, _(" \\dl list large objects, same as \\lo_list\n"));
|
2011-01-20 06:00:30 +01:00
|
|
|
fprintf(output, _(" \\dL[S+] [PATTERN] list procedural languages\n"));
|
2013-03-04 01:23:31 +01:00
|
|
|
fprintf(output, _(" \\dm[S+] [PATTERN] list materialized views\n"));
|
2011-01-25 00:51:35 +01:00
|
|
|
fprintf(output, _(" \\dn[S+] [PATTERN] list schemas\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\do[S] [PATTERN] list operators\n"));
|
2011-02-12 14:54:13 +01:00
|
|
|
fprintf(output, _(" \\dO[S+] [PATTERN] list collations\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\dp [PATTERN] list table, view, and sequence access privileges\n"));
|
2009-10-08 18:34:01 +02:00
|
|
|
fprintf(output, _(" \\drds [PATRN1 [PATRN2]] list per-database role settings\n"));
|
2017-01-19 18:00:00 +01:00
|
|
|
fprintf(output, _(" \\dRp[+] [PATTERN] list replication publications\n"));
|
|
|
|
fprintf(output, _(" \\dRs[+] [PATTERN] list replication subscriptions\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\ds[S+] [PATTERN] list sequences\n"));
|
|
|
|
fprintf(output, _(" \\dt[S+] [PATTERN] list tables\n"));
|
|
|
|
fprintf(output, _(" \\dT[S+] [PATTERN] list data types\n"));
|
2016-04-08 22:56:27 +02:00
|
|
|
fprintf(output, _(" \\du[S+] [PATTERN] list roles\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\dv[S+] [PATTERN] list views\n"));
|
2011-01-02 05:48:11 +01:00
|
|
|
fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
|
2011-02-08 22:08:41 +01:00
|
|
|
fprintf(output, _(" \\dx[+] [PATTERN] list extensions\n"));
|
2012-07-18 16:16:16 +02:00
|
|
|
fprintf(output, _(" \\dy [PATTERN] list event triggers\n"));
|
2013-03-04 04:17:08 +01:00
|
|
|
fprintf(output, _(" \\l[+] [PATTERN] list databases\n"));
|
2015-07-03 21:48:18 +02:00
|
|
|
fprintf(output, _(" \\sf[+] FUNCNAME show a function's definition\n"));
|
|
|
|
fprintf(output, _(" \\sv[+] VIEWNAME show a view's definition\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\z [PATTERN] same as \\dp\n"));
|
2003-07-23 10:47:41 +02:00
|
|
|
fprintf(output, "\n");
|
2002-12-11 23:45:13 +01:00
|
|
|
|
|
|
|
fprintf(output, _("Formatting\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\a toggle between unaligned and aligned output mode\n"));
|
|
|
|
fprintf(output, _(" \\C [STRING] set table title, or unset if none\n"));
|
|
|
|
fprintf(output, _(" \\f [STRING] show or set field separator for unaligned query output\n"));
|
|
|
|
fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"),
|
2002-12-11 23:45:13 +01:00
|
|
|
ON(pset.popt.topt.format == PRINT_HTML));
|
2014-10-14 04:07:30 +02:00
|
|
|
fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n"
|
2012-02-09 19:15:48 +01:00
|
|
|
" (NAME := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|\n"
|
2014-09-12 18:04:37 +02:00
|
|
|
" numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager|\n"
|
|
|
|
" unicode_border_linestyle|unicode_column_linestyle|unicode_header_linestyle})\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
|
2002-12-13 23:17:57 +01:00
|
|
|
ON(pset.popt.topt.tuples_only));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));
|
2011-11-12 16:03:10 +01:00
|
|
|
fprintf(output, _(" \\x [on|off|auto] toggle expanded output (currently %s)\n"),
|
2012-06-10 21:20:04 +02:00
|
|
|
pset.popt.topt.expanded == 2 ? "auto" : ON(pset.popt.topt.expanded));
|
2003-07-23 10:47:41 +02:00
|
|
|
fprintf(output, "\n");
|
1999-11-05 00:14:30 +01:00
|
|
|
|
2008-05-14 17:30:22 +02:00
|
|
|
fprintf(output, _("Connection\n"));
|
2013-01-15 21:21:03 +01:00
|
|
|
if (currdb)
|
psql: fix \connect with URIs and conninfo strings
This is the second try at this, after fcef1617295 failed miserably and
had to be reverted: as it turns out, libpq cannot depend on libpgcommon
after all. Instead of shuffling code in the master branch, make that one
just like 9.4 and accept the duplication. (This was all my own mistake,
not the patch submitter's).
psql was already accepting conninfo strings as the first parameter in
\connect, but the way it worked wasn't sane; some of the other
parameters would get the previous connection's values, causing it to
connect to a completely unexpected server or, more likely, not finding
any server at all because of completely wrong combinations of
parameters.
Fix by explicitely checking for a conninfo-looking parameter in the
dbname position; if one is found, use its complete specification rather
than mix with the other arguments. Also, change tab-completion to not
try to complete conninfo/URI-looking "dbnames" and document that
conninfos are accepted as first argument.
There was a weak consensus to backpatch this, because while the behavior
of using the dbname as a conninfo is nowhere documented for \connect, it
is reasonable to expect that it works because it does work in many other
contexts. Therefore this is backpatched all the way back to 9.0.
Author: David Fetter, Andrew Dunstan. Some editorialization by me
(probably earning a Gierth's "Sloppy" badge in the process.)
Reviewers: Andrew Gierth, Erik Rijkers, Pavel Stěhule, Stephen Frost,
Robert Haas, Andrew Dunstan.
2015-04-02 17:30:57 +02:00
|
|
|
fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
|
2013-01-15 21:21:03 +01:00
|
|
|
" connect to new database (currently \"%s\")\n"),
|
|
|
|
currdb);
|
|
|
|
else
|
psql: fix \connect with URIs and conninfo strings
This is the second try at this, after fcef1617295 failed miserably and
had to be reverted: as it turns out, libpq cannot depend on libpgcommon
after all. Instead of shuffling code in the master branch, make that one
just like 9.4 and accept the duplication. (This was all my own mistake,
not the patch submitter's).
psql was already accepting conninfo strings as the first parameter in
\connect, but the way it worked wasn't sane; some of the other
parameters would get the previous connection's values, causing it to
connect to a completely unexpected server or, more likely, not finding
any server at all because of completely wrong combinations of
parameters.
Fix by explicitely checking for a conninfo-looking parameter in the
dbname position; if one is found, use its complete specification rather
than mix with the other arguments. Also, change tab-completion to not
try to complete conninfo/URI-looking "dbnames" and document that
conninfos are accepted as first argument.
There was a weak consensus to backpatch this, because while the behavior
of using the dbname as a conninfo is nowhere documented for \connect, it
is reasonable to expect that it works because it does work in many other
contexts. Therefore this is backpatched all the way back to 9.0.
Author: David Fetter, Andrew Dunstan. Some editorialization by me
(probably earning a Gierth's "Sloppy" badge in the process.)
Reviewers: Andrew Gierth, Erik Rijkers, Pavel Stěhule, Stephen Frost,
Robert Haas, Andrew Dunstan.
2015-04-02 17:30:57 +02:00
|
|
|
fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
|
2013-02-02 23:06:38 +01:00
|
|
|
" connect to new database (currently no connection)\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\encoding [ENCODING] show or set client encoding\n"));
|
|
|
|
fprintf(output, _(" \\password [USERNAME] securely change the password for a user\n"));
|
2010-07-20 05:54:19 +02:00
|
|
|
fprintf(output, _(" \\conninfo display information about current connection\n"));
|
2008-05-14 17:30:22 +02:00
|
|
|
fprintf(output, "\n");
|
|
|
|
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _("Operating System\n"));
|
|
|
|
fprintf(output, _(" \\cd [DIR] change the current working directory\n"));
|
2011-12-04 17:43:38 +01:00
|
|
|
fprintf(output, _(" \\setenv NAME [VALUE] set or unset environment variable\n"));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\timing [on|off] toggle timing of commands (currently %s)\n"),
|
2008-05-14 17:30:22 +02:00
|
|
|
ON(pset.timing));
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _(" \\! [COMMAND] execute command in shell or start interactive shell\n"));
|
2008-05-14 17:30:22 +02:00
|
|
|
fprintf(output, "\n");
|
|
|
|
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _("Variables\n"));
|
|
|
|
fprintf(output, _(" \\prompt [TEXT] NAME prompt user to set internal variable\n"));
|
|
|
|
fprintf(output, _(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n"));
|
|
|
|
fprintf(output, _(" \\unset NAME unset (delete) internal variable\n"));
|
2008-05-14 17:30:22 +02:00
|
|
|
fprintf(output, "\n");
|
|
|
|
|
2009-03-25 14:14:17 +01:00
|
|
|
fprintf(output, _("Large Objects\n"));
|
2003-12-01 23:34:48 +01:00
|
|
|
fprintf(output, _(" \\lo_export LOBOID FILE\n"
|
2004-11-09 15:39:44 +01:00
|
|
|
" \\lo_import FILE [COMMENT]\n"
|
2003-07-23 10:47:41 +02:00
|
|
|
" \\lo_list\n"
|
2009-03-25 14:14:17 +01:00
|
|
|
" \\lo_unlink LOBOID large object operations\n"));
|
2002-12-12 00:07:06 +01:00
|
|
|
|
2010-08-13 22:56:18 +02:00
|
|
|
ClosePager(output);
|
1999-11-04 22:56:02 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
/*
|
|
|
|
* helpVariables
|
|
|
|
*
|
|
|
|
* show list of available variables (options) from command line
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
helpVariables(unsigned short int pager)
|
|
|
|
{
|
|
|
|
FILE *output;
|
|
|
|
|
2015-09-05 17:58:20 +02:00
|
|
|
/*
|
|
|
|
* Keep this line count in sync with the number of lines printed below!
|
|
|
|
* Use "psql --help=variables | wc" to count correctly; but notice that
|
|
|
|
* Windows builds currently print one more line than non-Windows builds.
|
|
|
|
* Using the larger number is fine.
|
|
|
|
*/
|
2016-08-18 22:04:35 +02:00
|
|
|
output = PageOutput(88, pager ? &(pset.popt.topt) : NULL);
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _("List of specially treated variables\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _("psql variables:\n"));
|
|
|
|
fprintf(output, _("Usage:\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _(" AUTOCOMMIT if set, successful SQL commands are automatically committed\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" COMP_KEYWORD_CASE determines the case used to complete SQL key words\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" [lower, upper, preserve-lower, preserve-upper]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" DBNAME the currently connected database name\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" ECHO controls what input is written to standard output\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" [all, errors, none, queries]\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" ECHO_HIDDEN if set, display internal queries executed by backslash commands;\n"
|
|
|
|
" if set to \"noexec\", just show without execution\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" ENCODING current client character set encoding\n"));
|
|
|
|
fprintf(output, _(" FETCH_COUNT the number of result rows to fetch and display at a time\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" (default: 0=unlimited)\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" HISTCONTROL controls command history [ignorespace, ignoredups, ignoreboth]\n"));
|
|
|
|
fprintf(output, _(" HISTFILE file name used to store the command history\n"));
|
Clean up psql's behavior for a few more control variables.
Modify FETCH_COUNT to always have a defined value, like other control
variables, mainly so it will always appear in "\set" output.
Add hooks to force HISTSIZE to be defined and require it to have an
integer value. (I don't see any point in allowing it to be set to
non-integral values.)
Add hooks to force IGNOREEOF to be defined and require it to have an
integer value. Unlike the other cases, here we're trying to be
bug-compatible with a rather bogus externally-defined behavior, so I think
we need to continue to allow "\set IGNOREEOF whatever". Fix it so that
the substitution hook silently replace non-numeric values with "10",
so that the stored value always reflects what we're really doing.
Add a dummy assign hook for HISTFILE, just so it's always in
variables.c's list. We can't require it to be defined always, because
that would break the interaction with the PSQL_HISTORY environment
variable, so there isn't any change in visible behavior here.
Remove tab-complete.c's private list of known variable names, since that's
really a maintenance nuisance. Given the preceding changes, there are no
control variables it won't show anyway. This does mean that if for some
reason you've unset one of the status variables (DBNAME, HOST, etc), that
variable would not appear in tab completion for \set. But I think that's
fine, for at least two reasons: we shouldn't be encouraging people to use
those variables as regular variables, and if someone does do so anyway,
why shouldn't it act just like a regular variable?
Remove ugly and no-longer-used-anywhere GetVariableNum(). In general,
future additions of integer-valued control variables should follow the
paradigm of adding an assign hook using ParseVariableNum(), so there's
no reason to expect we'd need this again later.
Discussion: https://postgr.es/m/17516.1485973973@sss.pgh.pa.us
2017-02-03 02:16:17 +01:00
|
|
|
fprintf(output, _(" HISTSIZE max number of commands to store in the command history\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" HOST the currently connected database server host\n"));
|
Clean up psql's behavior for a few more control variables.
Modify FETCH_COUNT to always have a defined value, like other control
variables, mainly so it will always appear in "\set" output.
Add hooks to force HISTSIZE to be defined and require it to have an
integer value. (I don't see any point in allowing it to be set to
non-integral values.)
Add hooks to force IGNOREEOF to be defined and require it to have an
integer value. Unlike the other cases, here we're trying to be
bug-compatible with a rather bogus externally-defined behavior, so I think
we need to continue to allow "\set IGNOREEOF whatever". Fix it so that
the substitution hook silently replace non-numeric values with "10",
so that the stored value always reflects what we're really doing.
Add a dummy assign hook for HISTFILE, just so it's always in
variables.c's list. We can't require it to be defined always, because
that would break the interaction with the PSQL_HISTORY environment
variable, so there isn't any change in visible behavior here.
Remove tab-complete.c's private list of known variable names, since that's
really a maintenance nuisance. Given the preceding changes, there are no
control variables it won't show anyway. This does mean that if for some
reason you've unset one of the status variables (DBNAME, HOST, etc), that
variable would not appear in tab completion for \set. But I think that's
fine, for at least two reasons: we shouldn't be encouraging people to use
those variables as regular variables, and if someone does do so anyway,
why shouldn't it act just like a regular variable?
Remove ugly and no-longer-used-anywhere GetVariableNum(). In general,
future additions of integer-valued control variables should follow the
paradigm of adding an assign hook using ParseVariableNum(), so there's
no reason to expect we'd need this again later.
Discussion: https://postgr.es/m/17516.1485973973@sss.pgh.pa.us
2017-02-03 02:16:17 +01:00
|
|
|
fprintf(output, _(" IGNOREEOF number of EOFs needed to terminate an interactive session\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" LASTOID value of the last affected OID\n"));
|
|
|
|
fprintf(output, _(" ON_ERROR_ROLLBACK if set, an error doesn't stop a transaction (uses implicit savepoints)\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" ON_ERROR_STOP stop batch execution after error\n"));
|
|
|
|
fprintf(output, _(" PORT server port of the current connection\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" PROMPT1 specifies the standard psql prompt\n"));
|
|
|
|
fprintf(output, _(" PROMPT2 specifies the prompt used when a statement continues from a previous line\n"));
|
|
|
|
fprintf(output, _(" PROMPT3 specifies the prompt used during COPY ... FROM STDIN\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" QUIET run quietly (same as -q option)\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" SHOW_CONTEXT controls display of message context fields [never, errors, always]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" SINGLELINE end of line terminates SQL command mode (same as -S option)\n"));
|
|
|
|
fprintf(output, _(" SINGLESTEP single-step mode (same as -s option)\n"));
|
|
|
|
fprintf(output, _(" USER the currently connected database user\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" VERBOSITY controls verbosity of error reports [default, verbose, terse]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _("\nDisplay settings:\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _("Usage:\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _(" border border style (number)\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" columns target width for the wrapped format\n"));
|
|
|
|
fprintf(output, _(" expanded (or x) expanded output [on, off, auto]\n"));
|
|
|
|
fprintf(output, _(" fieldsep field separator for unaligned output (default \"%s\")\n"), DEFAULT_FIELD_SEP);
|
|
|
|
fprintf(output, _(" fieldsep_zero set field separator for unaligned output to zero byte\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" footer enable or disable display of the table footer [on, off]\n"));
|
2016-07-13 00:10:16 +02:00
|
|
|
fprintf(output, _(" format set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" linestyle set the border line drawing style [ascii, old-ascii, unicode]\n"));
|
|
|
|
fprintf(output, _(" null set the string to be printed in place of a null value\n"));
|
|
|
|
fprintf(output, _(" numericlocale enable or disable display of a locale-specific character to separate\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" groups of digits [on, off]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" pager control when an external pager is used [yes, no, always]\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" recordsep record (line) separator for unaligned output\n"));
|
|
|
|
fprintf(output, _(" recordsep_zero set record separator for unaligned output to zero byte\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" tableattr (or T) specify attributes for table tag in html format or proportional\n"
|
2015-12-20 17:50:04 +01:00
|
|
|
" column widths for left-aligned data types in latex-longtable format\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" title set the table title for any subsequently printed tables\n"));
|
|
|
|
fprintf(output, _(" tuples_only if set, only actual table data is shown\n"));
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" unicode_border_linestyle\n"
|
|
|
|
" unicode_column_linestyle\n"
|
|
|
|
" unicode_header_linestyle\n"
|
|
|
|
" set the style of Unicode line drawing [single, double]\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
|
|
|
|
fprintf(output, _("\nEnvironment variables:\n"));
|
|
|
|
fprintf(output, _("Usage:\n"));
|
|
|
|
|
|
|
|
#ifndef WIN32
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
#else
|
2015-12-20 17:50:04 +01:00
|
|
|
fprintf(output, _(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
fprintf(output, _(" COLUMNS number of columns for wrapped format\n"));
|
|
|
|
fprintf(output, _(" PAGER name of external pager program\n"));
|
|
|
|
fprintf(output, _(" PGAPPNAME same as the application_name connection parameter\n"));
|
|
|
|
fprintf(output, _(" PGDATABASE same as the dbname connection parameter\n"));
|
|
|
|
fprintf(output, _(" PGHOST same as the host connection parameter\n"));
|
|
|
|
fprintf(output, _(" PGPORT same as the port connection parameter\n"));
|
|
|
|
fprintf(output, _(" PGUSER same as the user connection parameter\n"));
|
|
|
|
fprintf(output, _(" PGPASSWORD connection password (not recommended)\n"));
|
|
|
|
fprintf(output, _(" PGPASSFILE password file name\n"));
|
|
|
|
fprintf(output, _(" PSQL_EDITOR, EDITOR, VISUAL\n"
|
2015-07-03 21:48:18 +02:00
|
|
|
" editor used by the \\e, \\ef, and \\ev commands\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" PSQL_EDITOR_LINENUMBER_ARG\n"
|
2015-05-24 03:35:49 +02:00
|
|
|
" how to specify a line number when invoking the editor\n"));
|
Add new psql help topics, accessible to both --help and \?.
Add --help=<topic> for the commandline, and \? <topic> as a backslash
command, to show more help than the invocations without parameters
do. "commands", "variables" and "options" currently exist as help
topics describing, respectively, backslash commands, psql variables,
and commandline switches. Without parameters the help commands show
their previous topic.
Some further wordsmithing or extending of the added help content might
be needed; but there seems little benefit delaying the overall feature
further.
Author: Pavel Stehule, editorialized by many
Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit
Menon-Sen and Erik Rijkers.
Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com,
CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com
2014-09-09 22:19:14 +02:00
|
|
|
fprintf(output, _(" PSQL_HISTORY alternative location for the command history file\n"));
|
|
|
|
fprintf(output, _(" PSQLRC alternative location for the user's .psqlrc file\n"));
|
|
|
|
fprintf(output, _(" SHELL shell used by the \\! command\n"));
|
|
|
|
fprintf(output, _(" TMPDIR directory for temporary files\n"));
|
|
|
|
|
|
|
|
ClosePager(output);
|
|
|
|
}
|
|
|
|
|
1999-11-04 22:56:02 +01:00
|
|
|
|
|
|
|
/*
|
|
|
|
* helpSQL -- help with SQL commands
|
|
|
|
*
|
2010-05-08 18:39:53 +02:00
|
|
|
* Note: we assume caller removed any trailing spaces in "topic".
|
1999-11-04 22:56:02 +01:00
|
|
|
*/
|
|
|
|
void
|
2003-03-18 23:15:44 +01:00
|
|
|
helpSQL(const char *topic, unsigned short int pager)
|
1999-11-04 22:56:02 +01:00
|
|
|
{
|
2000-02-08 00:10:11 +01:00
|
|
|
#define VALUE_OR_NULL(a) ((a) ? (a) : "")
|
|
|
|
|
1999-11-05 00:14:30 +01:00
|
|
|
if (!topic || strlen(topic) == 0)
|
1999-11-04 22:56:02 +01:00
|
|
|
{
|
2008-01-20 22:13:55 +01:00
|
|
|
/* Print all the available command names */
|
|
|
|
int screen_width;
|
|
|
|
int ncolumns;
|
|
|
|
int nrows;
|
2003-08-04 02:43:34 +02:00
|
|
|
FILE *output;
|
2008-01-20 22:13:55 +01:00
|
|
|
int i;
|
|
|
|
int j;
|
2002-10-23 21:23:57 +02:00
|
|
|
|
2008-01-20 22:13:55 +01:00
|
|
|
#ifdef TIOCGWINSZ
|
|
|
|
struct winsize screen_size;
|
|
|
|
|
|
|
|
if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)
|
|
|
|
screen_width = 80; /* ioctl failed, assume 80 */
|
|
|
|
else
|
|
|
|
screen_width = screen_size.ws_col;
|
|
|
|
#else
|
|
|
|
screen_width = 80; /* default assumption */
|
|
|
|
#endif
|
|
|
|
|
|
|
|
ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);
|
|
|
|
ncolumns = Max(ncolumns, 1);
|
|
|
|
nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;
|
|
|
|
|
2015-03-28 16:07:41 +01:00
|
|
|
output = PageOutput(nrows + 1, pager ? &(pset.popt.topt) : NULL);
|
1999-11-05 00:14:30 +01:00
|
|
|
|
2002-10-23 21:23:57 +02:00
|
|
|
fputs(_("Available help:\n"), output);
|
1999-11-05 00:14:30 +01:00
|
|
|
|
2008-01-20 22:13:55 +01:00
|
|
|
for (i = 0; i < nrows; i++)
|
1999-11-05 00:14:30 +01:00
|
|
|
{
|
2008-01-20 22:13:55 +01:00
|
|
|
fprintf(output, " ");
|
2009-06-11 16:49:15 +02:00
|
|
|
for (j = 0; j < ncolumns - 1; j++)
|
2008-01-20 22:13:55 +01:00
|
|
|
fprintf(output, "%-*s",
|
|
|
|
QL_MAX_CMD_LEN + 1,
|
|
|
|
VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
|
|
|
|
if (i + j * nrows < QL_HELP_COUNT)
|
|
|
|
fprintf(output, "%s",
|
|
|
|
VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
|
2002-10-23 21:23:57 +02:00
|
|
|
fputc('\n', output);
|
|
|
|
}
|
2008-01-20 22:13:55 +01:00
|
|
|
|
2010-08-13 22:56:18 +02:00
|
|
|
ClosePager(output);
|
1999-11-04 22:56:02 +01:00
|
|
|
}
|
1999-11-05 00:14:30 +01:00
|
|
|
else
|
1999-11-04 22:56:02 +01:00
|
|
|
{
|
2005-10-15 04:49:52 +02:00
|
|
|
int i,
|
|
|
|
j,
|
|
|
|
x = 0;
|
1999-11-05 00:14:30 +01:00
|
|
|
bool help_found = false;
|
2010-08-13 22:56:18 +02:00
|
|
|
FILE *output = NULL;
|
2005-10-15 04:49:52 +02:00
|
|
|
size_t len,
|
|
|
|
wordlen;
|
2003-09-11 18:22:42 +02:00
|
|
|
int nl_count = 0;
|
2004-06-18 08:14:31 +02:00
|
|
|
|
2010-05-08 18:39:53 +02:00
|
|
|
/*
|
|
|
|
* We first try exact match, then first + second words, then first
|
|
|
|
* word only.
|
|
|
|
*/
|
2000-05-12 18:13:44 +02:00
|
|
|
len = strlen(topic);
|
2003-09-11 18:22:42 +02:00
|
|
|
|
2010-05-08 18:39:53 +02:00
|
|
|
for (x = 1; x <= 3; x++)
|
1999-11-05 00:14:30 +01:00
|
|
|
{
|
2005-10-15 04:49:52 +02:00
|
|
|
if (x > 1) /* Nothing on first pass - try the opening
|
2010-05-08 18:39:53 +02:00
|
|
|
* word(s) */
|
2005-10-15 04:49:52 +02:00
|
|
|
{
|
|
|
|
wordlen = j = 1;
|
|
|
|
while (topic[j] != ' ' && j++ < len)
|
|
|
|
wordlen++;
|
|
|
|
if (x == 2)
|
2005-07-06 05:14:48 +02:00
|
|
|
{
|
2005-10-15 04:49:52 +02:00
|
|
|
j++;
|
|
|
|
while (topic[j] != ' ' && j++ <= len)
|
|
|
|
wordlen++;
|
2005-07-06 05:14:48 +02:00
|
|
|
}
|
2005-10-15 04:49:52 +02:00
|
|
|
if (wordlen >= len) /* Don't try again if the same word */
|
2005-07-06 05:14:48 +02:00
|
|
|
{
|
2010-08-13 22:56:18 +02:00
|
|
|
if (!output)
|
2015-03-28 16:07:41 +01:00
|
|
|
output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
|
2005-10-15 04:49:52 +02:00
|
|
|
break;
|
2005-07-06 05:14:48 +02:00
|
|
|
}
|
2005-10-15 04:49:52 +02:00
|
|
|
len = wordlen;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Count newlines for pager */
|
|
|
|
for (i = 0; QL_HELP[i].cmd; i++)
|
|
|
|
{
|
|
|
|
if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
|
|
|
|
strcmp(topic, "*") == 0)
|
2005-07-06 05:14:48 +02:00
|
|
|
{
|
2009-09-18 07:00:42 +02:00
|
|
|
nl_count += 5 + QL_HELP[i].nl_count;
|
|
|
|
|
2005-10-15 04:49:52 +02:00
|
|
|
/* If we have an exact match, exit. Fixes \h SELECT */
|
|
|
|
if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
|
|
|
|
break;
|
2005-07-06 05:14:48 +02:00
|
|
|
}
|
2005-10-15 04:49:52 +02:00
|
|
|
}
|
|
|
|
|
2010-08-13 22:56:18 +02:00
|
|
|
if (!output)
|
2015-03-28 16:07:41 +01:00
|
|
|
output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
|
2005-10-15 04:49:52 +02:00
|
|
|
|
|
|
|
for (i = 0; QL_HELP[i].cmd; i++)
|
|
|
|
{
|
|
|
|
if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
|
|
|
|
strcmp(topic, "*") == 0)
|
|
|
|
{
|
2009-09-18 07:00:42 +02:00
|
|
|
PQExpBufferData buffer;
|
|
|
|
|
|
|
|
initPQExpBuffer(&buffer);
|
|
|
|
QL_HELP[i].syntaxfunc(&buffer);
|
2005-10-15 04:49:52 +02:00
|
|
|
help_found = true;
|
|
|
|
fprintf(output, _("Command: %s\n"
|
|
|
|
"Description: %s\n"
|
|
|
|
"Syntax:\n%s\n\n"),
|
|
|
|
QL_HELP[i].cmd,
|
|
|
|
_(QL_HELP[i].help),
|
2009-09-18 07:00:42 +02:00
|
|
|
buffer.data);
|
2005-10-15 04:49:52 +02:00
|
|
|
/* If we have an exact match, exit. Fixes \h SELECT */
|
|
|
|
if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
|
2005-07-06 05:14:48 +02:00
|
|
|
break;
|
2005-10-15 04:49:52 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
if (help_found) /* Don't keep trying if we got a match */
|
|
|
|
break;
|
1999-11-05 00:14:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!help_found)
|
2010-05-08 18:39:53 +02:00
|
|
|
fprintf(output, _("No help available for \"%s\".\nTry \\h with no arguments to see available help.\n"), topic);
|
2003-09-11 18:22:42 +02:00
|
|
|
|
2010-08-13 22:56:18 +02:00
|
|
|
ClosePager(output);
|
1999-11-04 22:56:02 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void
|
|
|
|
print_copyright(void)
|
|
|
|
{
|
1999-11-05 00:14:30 +01:00
|
|
|
puts(
|
2011-01-27 19:20:08 +01:00
|
|
|
"PostgreSQL Database Management System\n"
|
|
|
|
"(formerly known as Postgres, then as Postgres95)\n\n"
|
2017-01-03 19:48:53 +01:00
|
|
|
"Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group\n\n"
|
2011-01-27 19:20:08 +01:00
|
|
|
"Portions Copyright (c) 1994, The Regents of the University of California\n\n"
|
2005-10-15 04:49:52 +02:00
|
|
|
"Permission to use, copy, modify, and distribute this software and its\n"
|
2000-04-12 19:17:23 +02:00
|
|
|
"documentation for any purpose, without fee, and without a written agreement\n"
|
2011-01-27 19:20:08 +01:00
|
|
|
"is hereby granted, provided that the above copyright notice and this\n"
|
|
|
|
"paragraph and the following two paragraphs appear in all copies.\n\n"
|
2000-04-12 19:17:23 +02:00
|
|
|
"IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"
|
2011-01-27 19:20:08 +01:00
|
|
|
"DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"
|
|
|
|
"LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"
|
|
|
|
"DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"
|
|
|
|
"POSSIBILITY OF SUCH DAMAGE.\n\n"
|
|
|
|
"THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"
|
|
|
|
"INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"
|
|
|
|
"AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"
|
|
|
|
"ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"
|
|
|
|
"PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n"
|
2001-10-25 07:50:21 +02:00
|
|
|
);
|
1999-11-04 22:56:02 +01:00
|
|
|
}
|