#include "postgres_fe.h"
#include <unistd.h>
#include <sys/ioctl.h>
#include "common.h"
#include "common/logging.h"
#include "common/username.h"
#include "help.h"
#include "input.h"
#include "settings.h"
#include "sql_help.h"

Include dependency graph for help.c:

Macros
#define	HELP0(str) appendPQExpBufferStr(&buf, _(str))

#define	HELPN(str, ...) appendPQExpBuffer(&buf, _(str), __VA_ARGS__)

#define	ON(var) ((var) ? _("on") : _("off"))

#define	VALUE_OR_NULL(a) ((a) ? (a) : "")

Functions
void	usage (unsigned short int pager)

void	slashUsage (unsigned short int pager)

Macro Definition Documentation

◆ HELP0

#define HELP0 ( str ) appendPQExpBufferStr(&buf, _(str))

Definition at line 40 of file help.c.

◆ HELPN

#define HELPN	(	str,
		...
	)	appendPQExpBuffer(&buf, _(str), __VA_ARGS__)

Definition at line 41 of file help.c.

◆ ON

#define ON ( var ) ((var) ? _("on") : _("off"))

Definition at line 42 of file help.c.

◆ VALUE_OR_NULL

#define VALUE_OR_NULL ( a ) ((a) ? (a) : "")

Function Documentation

◆ slashUsage()

void slashUsage ( unsigned short int pager )

Definition at line 176 of file help.c.

References _, buf, ClosePager(), _psqlSettings::db, printTableOpt::expanded, printTableOpt::format, HELP0, HELPN, initPQExpBuffer(), ON, output, PageOutput(), _psqlSettings::popt, PQdb(), PRINT_HTML, pset, termPQExpBuffer(), _psqlSettings::timing, printQueryOpt::topt, and printTableOpt::tuples_only.

Referenced by exec_command_slash_command_help(), and parse_psql_options().

◆ usage()

void usage ( unsigned short int pager )

Definition at line 51 of file help.c.

 {
     const char *env;
     const char *user;
     char       *errstr;
     PQExpBufferData buf;
     int         nlcount;
     FILE       *output;
  
     /* Find default user, in case we need it. */
     user = getenv("PGUSER");
     if (!user)
     {
         user = get_user_name(&errstr);
         if (!user)
             pg_fatal("%s", errstr);
     }
  
     /*
      * To avoid counting the output lines manually, build the output in "buf"
      * and then count them.
      */
     initPQExpBuffer(&buf);
  
     HELP0("psql is the PostgreSQL interactive terminal.\n\n");
     HELP0("Usage:\n");
     HELP0("  psql [OPTION]... [DBNAME [USERNAME]]\n\n");
  
     HELP0("General options:\n");
     /* Display default database */
     env = getenv("PGDATABASE");
     if (!env)
         env = user;
     HELP0("  -c, --command=COMMAND    run only single command (SQL or internal) and exit\n");
     HELPN("  -d, --dbname=DBNAME      database name to connect to (default: \"%s\")\n",
           env);
     HELP0("  -f, --file=FILENAME      execute commands from file, then exit\n");
     HELP0("  -l, --list               list available databases, then exit\n");
     HELP0("  -v, --set=, --variable=NAME=VALUE\n"
           "                           set psql variable NAME to VALUE\n"
           "                           (e.g., -v ON_ERROR_STOP=1)\n");
     HELP0("  -V, --version            output version information, then exit\n");
     HELP0("  -X, --no-psqlrc          do not read startup file (~/.psqlrc)\n");
     HELP0("  -1 (\"one\"), --single-transaction\n"
           "                           execute as a single transaction (if non-interactive)\n");
     HELP0("  -?, --help[=options]     show this help, then exit\n");
     HELP0("      --help=commands      list backslash commands, then exit\n");
     HELP0("      --help=variables     list special variables, then exit\n");
  
     HELP0("\nInput and output options:\n");
     HELP0("  -a, --echo-all           echo all input from script\n");
     HELP0("  -b, --echo-errors        echo failed commands\n");
     HELP0("  -e, --echo-queries       echo commands sent to server\n");
     HELP0("  -E, --echo-hidden        display queries that internal commands generate\n");
     HELP0("  -L, --log-file=FILENAME  send session log to file\n");
     HELP0("  -n, --no-readline        disable enhanced command line editing (readline)\n");
     HELP0("  -o, --output=FILENAME    send query results to file (or |pipe)\n");
     HELP0("  -q, --quiet              run quietly (no messages, only query output)\n");
     HELP0("  -s, --single-step        single-step mode (confirm each query)\n");
     HELP0("  -S, --single-line        single-line mode (end of line terminates SQL command)\n");
  
     HELP0("\nOutput format options:\n");
     HELP0("  -A, --no-align           unaligned table output mode\n");
     HELP0("      --csv                CSV (Comma-Separated Values) table output mode\n");
     HELPN("  -F, --field-separator=STRING\n"
           "                           field separator for unaligned output (default: \"%s\")\n",
           DEFAULT_FIELD_SEP);
     HELP0("  -H, --html               HTML table output mode\n");
     HELP0("  -P, --pset=VAR[=ARG]     set printing option VAR to ARG (see \\pset command)\n");
     HELP0("  -R, --record-separator=STRING\n"
           "                           record separator for unaligned output (default: newline)\n");
     HELP0("  -t, --tuples-only        print rows only\n");
     HELP0("  -T, --table-attr=TEXT    set HTML table tag attributes (e.g., width, border)\n");
     HELP0("  -x, --expanded           turn on expanded table output\n");
     HELP0("  -z, --field-separator-zero\n"
           "                           set field separator for unaligned output to zero byte\n");
     HELP0("  -0, --record-separator-zero\n"
           "                           set record separator for unaligned output to zero byte\n");
  
     HELP0("\nConnection options:\n");
     /* Display default host */
     env = getenv("PGHOST");
     HELPN("  -h, --host=HOSTNAME      database server host or socket directory (default: \"%s\")\n",
           env ? env : _("local socket"));
     /* Display default port */
     env = getenv("PGPORT");
     HELPN("  -p, --port=PORT          database server port (default: \"%s\")\n",
           env ? env : DEF_PGPORT_STR);
     /* Display default user */
     HELPN("  -U, --username=USERNAME  database user name (default: \"%s\")\n",
           user);
     HELP0("  -w, --no-password        never prompt for password\n");
     HELP0("  -W, --password           force password prompt (should happen automatically)\n");
  
     HELP0("\nFor more information, type \"\\?\" (for internal commands) or \"\\help\" (for SQL\n"
           "commands) from within psql, or consult the psql section in the PostgreSQL\n"
           "documentation.\n\n");
     HELPN("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
     HELPN("%s home page: <%s>\n", PACKAGE_NAME, PACKAGE_URL);
  
     /* Now we can count the lines. */
     nlcount = 0;
     for (const char *ptr = buf.data; *ptr; ptr++)
     {
         if (*ptr == '\n')
             nlcount++;
     }
  
     /* And dump the output, with appropriate pagination. */
     output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
  
     fputs(buf.data, output);
  
     ClosePager(output);
  
     termPQExpBuffer(&buf);
 }

References _, buf, ClosePager(), DEFAULT_FIELD_SEP, get_user_name(), HELP0, HELPN, initPQExpBuffer(), output, PageOutput(), pg_fatal, _psqlSettings::popt, pset, termPQExpBuffer(), printQueryOpt::topt, and user.

Macros

Functions