PostgreSQL Source Code git master
Macros | Functions
help.c File Reference
#include "postgres_fe.h"
#include <unistd.h>
#include <sys/ioctl.h>
#include "help.h"
#include "input.h"
#include "settings.h"
#include "sql_help.h"
Include dependency graph for help.c:

Go to the source code of this file.

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)
 
void  helpVariables (unsigned short int pager)
 
void  helpSQL (const char *topic, unsigned short int pager)
 
void  print_copyright (void)
 

Macro Definition Documentation

◆ HELP0

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

Definition at line 37 of file help.c.

◆ HELPN

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

Definition at line 38 of file help.c.

◆ ON

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

Definition at line 39 of file help.c.

◆ VALUE_OR_NULL

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

Function Documentation

◆ helpSQL()

void helpSQL ( const char *  topic,
unsigned short int  pager 
)

Definition at line 590 of file help.c.

591{
592#define VALUE_OR_NULL(a) ((a) ? (a) : "")
593
594 if (!topic || strlen(topic) == 0)
595 {
596 /* Print all the available command names */
597 int screen_width;
598 int ncolumns;
599 int nrows;
600 FILE *output;
601 int i;
602 int j;
603
604 /* Find screen width to determine how many columns will fit */
605#ifdef TIOCGWINSZ
606 struct winsize screen_size;
607
608 if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)
609 screen_width = 80; /* ioctl failed, assume 80 */
610 else
611 screen_width = screen_size.ws_col;
612#else
613 screen_width = 80; /* default assumption */
614#endif
615
616 ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);
617 ncolumns = Max(ncolumns, 1);
618 nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;
619
620 output = PageOutput(nrows + 1, pager ? &(pset.popt.topt) : NULL);
621
622 fputs(_("Available help:\n"), output);
623
624 for (i = 0; i < nrows; i++)
625 {
626 fprintf(output, " ");
627 for (j = 0; j < ncolumns - 1; j++)
628 fprintf(output, "%-*s",
629 QL_MAX_CMD_LEN + 1,
630 VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
631 if (i + j * nrows < QL_HELP_COUNT)
632 fprintf(output, "%s",
633 VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
634 fputc('\n', output);
635 }
636
638 }
639 else
640 {
641 int i,
642 pass;
643 FILE *output = NULL;
644 size_t len,
645 wordlen,
646 j;
647 int nl_count;
648
649 /*
650 * len is the amount of the input to compare to the help topic names.
651 * We first try exact match, then first + second words, then first
652 * word only.
653 */
654 len = strlen(topic);
655
656 for (pass = 1; pass <= 3; pass++)
657 {
658 if (pass > 1) /* Nothing on first pass - try the opening
659 * word(s) */
660 {
661 wordlen = j = 1;
662 while (j < len && topic[j++] != ' ')
663 wordlen++;
664 if (pass == 2 && j < len)
665 {
666 wordlen++;
667 while (j < len && topic[j++] != ' ')
668 wordlen++;
669 }
670 if (wordlen >= len)
671 {
672 /* Failed to shorten input, so try next pass if any */
673 continue;
674 }
675 len = wordlen;
676 }
677
678 /*
679 * Count newlines for pager. This logic must agree with what the
680 * following loop will do!
681 */
682 nl_count = 0;
683 for (i = 0; QL_HELP[i].cmd; i++)
684 {
685 if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
686 strcmp(topic, "*") == 0)
687 {
688 /* magic constant here must match format below! */
689 nl_count += 7 + QL_HELP[i].nl_count;
690
691 /* If we have an exact match, exit. Fixes \h SELECT */
692 if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
693 break;
694 }
695 }
696 /* If no matches, don't open the output yet */
697 if (nl_count == 0)
698 continue;
699
700 if (!output)
701 output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
702
703 for (i = 0; QL_HELP[i].cmd; i++)
704 {
705 if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
706 strcmp(topic, "*") == 0)
707 {
708 PQExpBufferData buffer;
709 char *url;
710
711 initPQExpBuffer(&buffer);
712 QL_HELP[i].syntaxfunc(&buffer);
713 url = psprintf("https://www.postgresql.org/docs/%s/%s.html",
714 strstr(PG_VERSION, "devel") ? "devel" : PG_MAJORVERSION,
715 QL_HELP[i].docbook_id);
716 /* # of newlines in format must match constant above! */
717 fprintf(output, _("Command: %s\n"
718 "Description: %s\n"
719 "Syntax:\n%s\n\n"
720 "URL: %s\n\n"),
721 QL_HELP[i].cmd,
722 _(QL_HELP[i].help),
723 buffer.data,
724 url);
725 free(url);
726 termPQExpBuffer(&buffer);
727
728 /* If we have an exact match, exit. Fixes \h SELECT */
729 if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
730 break;
731 }
732 }
733 break;
734 }
735
736 /* If we never found anything, report that */
737 if (!output)
738 {
739 output = PageOutput(2, pager ? &(pset.popt.topt) : NULL);
740 fprintf(output, _("No help available for \"%s\".\n"
741 "Try \\h with no arguments to see available help.\n"),
742 topic);
743 }
744
746 }
747}
#define Max(x, y)
Definition: c.h:997
#define fprintf(file, fmt, msg)
Definition: cubescan.l:21
_
#define _(x)
Definition: elog.c:91
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:3089
void ClosePager(FILE *pagerpipe)
Definition: print.c:3141
#define free(a)
Definition: header.h:65
#define VALUE_OR_NULL(a)
FILE * output
j
int j
Definition: isn.c:78
i
int i
Definition: isn.c:77
help
stdout
const void size_t len
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
int pg_strncasecmp(const char *s1, const char *s2, size_t n)
Definition: pgstrcasecmp.c:69
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:129
char * psprintf(const char *fmt,...)
Definition: psprintf.c:43
PsqlSettings pset
Definition: startup.c:32
char * data
Definition: pqexpbuffer.h:46
printQueryOpt popt
Definition: settings.h:112
printTableOpt topt
Definition: print.h:185

References _, ClosePager(), PQExpBufferData::data, fprintf, free, generate_unaccent_rules::help, i, initPQExpBuffer(), j, len, Max, output, PageOutput(), pg_strcasecmp(), pg_strncasecmp(), _psqlSettings::popt, pset, psprintf(), generate_unaccent_rules::stdout, termPQExpBuffer(), printQueryOpt::topt, and VALUE_OR_NULL.

Referenced by exec_command_help().

◆ helpVariables()

void helpVariables ( unsigned short int  pager )

Definition at line 374 of file help.c.

375{
377 int nlcount;
378 FILE *output;
379
380 /*
381 * To avoid counting the output lines manually, build the output in "buf"
382 * and then count them.
383 */
385
386 HELP0("List of specially treated variables\n\n");
387
388 HELP0("psql variables:\n");
389 HELP0("Usage:\n");
390 HELP0(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n");
391
392 HELP0(" AUTOCOMMIT\n"
393 " if set, successful SQL commands are automatically committed\n");
394 HELP0(" COMP_KEYWORD_CASE\n"
395 " determines the case used to complete SQL key words\n"
396 " [lower, upper, preserve-lower, preserve-upper]\n");
397 HELP0(" DBNAME\n"
398 " the currently connected database name\n");
399 HELP0(" ECHO\n"
400 " controls what input is written to standard output\n"
401 " [all, errors, none, queries]\n");
402 HELP0(" ECHO_HIDDEN\n"
403 " if set, display internal queries executed by backslash commands;\n"
404 " if set to \"noexec\", just show them without execution\n");
405 HELP0(" ENCODING\n"
406 " current client character set encoding\n");
407 HELP0(" ERROR\n"
408 " \"true\" if last query failed, else \"false\"\n");
409 HELP0(" FETCH_COUNT\n"
410 " the number of result rows to fetch and display at a time (0 = unlimited)\n");
411 HELP0(" HIDE_TABLEAM\n"
412 " if set, table access methods are not displayed\n");
413 HELP0(" HIDE_TOAST_COMPRESSION\n"
414 " if set, compression methods are not displayed\n");
415 HELP0(" HISTCONTROL\n"
416 " controls command history [ignorespace, ignoredups, ignoreboth]\n");
417 HELP0(" HISTFILE\n"
418 " file name used to store the command history\n");
419 HELP0(" HISTSIZE\n"
420 " maximum number of commands to store in the command history\n");
421 HELP0(" HOST\n"
422 " the currently connected database server host\n");
423 HELP0(" IGNOREEOF\n"
424 " number of EOFs needed to terminate an interactive session\n");
425 HELP0(" LASTOID\n"
426 " value of the last affected OID\n");
427 HELP0(" LAST_ERROR_MESSAGE\n"
428 " LAST_ERROR_SQLSTATE\n"
429 " message and SQLSTATE of last error, or empty string and \"00000\" if none\n");
430 HELP0(" ON_ERROR_ROLLBACK\n"
431 " if set, an error doesn't stop a transaction (uses implicit savepoints)\n");
432 HELP0(" ON_ERROR_STOP\n"
433 " stop batch execution after error\n");
434 HELP0(" PORT\n"
435 " server port of the current connection\n");
436 HELP0(" PROMPT1\n"
437 " specifies the standard psql prompt\n");
438 HELP0(" PROMPT2\n"
439 " specifies the prompt used when a statement continues from a previous line\n");
440 HELP0(" PROMPT3\n"
441 " specifies the prompt used during COPY ... FROM STDIN\n");
442 HELP0(" QUIET\n"
443 " run quietly (same as -q option)\n");
444 HELP0(" ROW_COUNT\n"
445 " number of rows returned or affected by last query, or 0\n");
446 HELP0(" SERVER_VERSION_NAME\n"
447 " SERVER_VERSION_NUM\n"
448 " server's version (in short string or numeric format)\n");
449 HELP0(" SHELL_ERROR\n"
450 " \"true\" if the last shell command failed, \"false\" if it succeeded\n");
451 HELP0(" SHELL_EXIT_CODE\n"
452 " exit status of the last shell command\n");
453 HELP0(" SHOW_ALL_RESULTS\n"
454 " show all results of a combined query (\\;) instead of only the last\n");
455 HELP0(" SHOW_CONTEXT\n"
456 " controls display of message context fields [never, errors, always]\n");
457 HELP0(" SINGLELINE\n"
458 " if set, end of line terminates SQL commands (same as -S option)\n");
459 HELP0(" SINGLESTEP\n"
460 " single-step mode (same as -s option)\n");
461 HELP0(" SQLSTATE\n"
462 " SQLSTATE of last query, or \"00000\" if no error\n");
463 HELP0(" USER\n"
464 " the currently connected database user\n");
465 HELP0(" VERBOSITY\n"
466 " controls verbosity of error reports [default, verbose, terse, sqlstate]\n");
467 HELP0(" VERSION\n"
468 " VERSION_NAME\n"
469 " VERSION_NUM\n"
470 " psql's version (in verbose string, short string, or numeric format)\n");
471 HELPN(" WATCH_INTERVAL\n"
472 " number of seconds \\watch waits between executions (default %s)\n",
474
475 HELP0("\nDisplay settings:\n");
476 HELP0("Usage:\n");
477 HELP0(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n");
478
479 HELP0(" border\n"
480 " border style (number)\n");
481 HELP0(" columns\n"
482 " target width for the wrapped format\n");
483 HELP0(" expanded (or x)\n"
484 " expanded output [on, off, auto]\n");
485 HELPN(" fieldsep\n"
486 " field separator for unaligned output (default \"%s\")\n",
488 HELP0(" fieldsep_zero\n"
489 " set field separator for unaligned output to a zero byte\n");
490 HELP0(" footer\n"
491 " enable or disable display of the table footer [on, off]\n");
492 HELP0(" format\n"
493 " set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n");
494 HELP0(" linestyle\n"
495 " set the border line drawing style [ascii, old-ascii, unicode]\n");
496 HELP0(" null\n"
497 " set the string to be printed in place of a null value\n");
498 HELP0(" numericlocale\n"
499 " enable display of a locale-specific character to separate groups of digits\n");
500 HELP0(" pager\n"
501 " control when an external pager is used [yes, no, always]\n");
502 HELP0(" recordsep\n"
503 " record (line) separator for unaligned output\n");
504 HELP0(" recordsep_zero\n"
505 " set record separator for unaligned output to a zero byte\n");
506 HELP0(" tableattr (or T)\n"
507 " specify attributes for table tag in html format, or proportional\n"
508 " column widths for left-aligned data types in latex-longtable format\n");
509 HELP0(" title\n"
510 " set the table title for subsequently printed tables\n");
511 HELP0(" tuples_only\n"
512 " if set, only actual table data is shown\n");
513 HELP0(" unicode_border_linestyle\n"
514 " unicode_column_linestyle\n"
515 " unicode_header_linestyle\n"
516 " set the style of Unicode line drawing [single, double]\n");
517 HELP0(" xheader_width\n"
518 " set the maximum width of the header for expanded output\n"
519 " [full, column, page, integer value]\n");
520
521 HELP0("\nEnvironment variables:\n");
522 HELP0("Usage:\n");
523
524#ifndef WIN32
525 HELP0(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
526#else
527 HELP0(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
528#endif
529
530 HELP0(" COLUMNS\n"
531 " number of columns for wrapped format\n");
532 HELP0(" PGAPPNAME\n"
533 " same as the application_name connection parameter\n");
534 HELP0(" PGDATABASE\n"
535 " same as the dbname connection parameter\n");
536 HELP0(" PGHOST\n"
537 " same as the host connection parameter\n");
538 HELP0(" PGPASSFILE\n"
539 " password file name\n");
540 HELP0(" PGPASSWORD\n"
541 " connection password (not recommended)\n");
542 HELP0(" PGPORT\n"
543 " same as the port connection parameter\n");
544 HELP0(" PGUSER\n"
545 " same as the user connection parameter\n");
546 HELP0(" PSQL_EDITOR, EDITOR, VISUAL\n"
547 " editor used by the \\e, \\ef, and \\ev commands\n");
548 HELP0(" PSQL_EDITOR_LINENUMBER_ARG\n"
549 " how to specify a line number when invoking the editor\n");
550 HELP0(" PSQL_HISTORY\n"
551 " alternative location for the command history file\n");
552 HELP0(" PSQL_PAGER, PAGER\n"
553 " name of external pager program\n");
554#ifndef WIN32
555 HELP0(" PSQL_WATCH_PAGER\n"
556 " name of external pager program used for \\watch\n");
557#endif
558 HELP0(" PSQLRC\n"
559 " alternative location for the user's .psqlrc file\n");
560 HELP0(" SHELL\n"
561 " shell used by the \\! command\n");
562 HELP0(" TMPDIR\n"
563 " directory for temporary files\n");
564
565 /* Now we can count the lines. */
566 nlcount = 0;
567 for (const char *ptr = buf.data; *ptr; ptr++)
568 {
569 if (*ptr == '\n')
570 nlcount++;
571 }
572
573 /* And dump the output, with appropriate pagination. */
574 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
575
576 fputs(buf.data, output);
577
579
581}
#define HELPN(str,...)
Definition: help.c:38
#define HELP0(str)
Definition: help.c:37
static char * buf
Definition: pg_test_fsync.c:72
#define DEFAULT_FIELD_SEP
Definition: settings.h:15
#define DEFAULT_WATCH_INTERVAL
Definition: settings.h:30

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

Referenced by exec_command_slash_command_help(), and parse_psql_options().

◆ print_copyright()

void print_copyright ( void  )

Definition at line 752 of file help.c.

753{
754 puts("PostgreSQL Database Management System\n"
755 "(also known as Postgres, formerly known as Postgres95)\n\n"
756 "Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group\n\n"
757 "Portions Copyright (c) 1994, The Regents of the University of California\n\n"
758 "Permission to use, copy, modify, and distribute this software and its\n"
759 "documentation for any purpose, without fee, and without a written agreement\n"
760 "is hereby granted, provided that the above copyright notice and this\n"
761 "paragraph and the following two paragraphs appear in all copies.\n\n"
762 "IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"
763 "DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"
764 "LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"
765 "DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"
766 "POSSIBILITY OF SUCH DAMAGE.\n\n"
767 "THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"
768 "INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"
769 "AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"
770 "ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"
771 "PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n");
772}

Referenced by exec_command_copyright().

◆ slashUsage()

void slashUsage ( unsigned short int  pager )

Definition at line 148 of file help.c.

149{
151 int nlcount;
152 FILE *output;
153 char *currdb;
154
155 currdb = PQdb(pset.db);
156
157 /*
158 * To avoid counting the output lines manually, build the output in "buf"
159 * and then count them.
160 */
162
163 HELP0("General\n");
164 HELP0(" \\copyright show PostgreSQL usage and distribution terms\n");
165 HELP0(" \\crosstabview [COLUMNS] execute query and display result in crosstab\n");
166 HELP0(" \\errverbose show most recent error message at maximum verbosity\n");
167 HELP0(" \\g [(OPTIONS)] [FILE] execute query (and send result to file or |pipe);\n"
168 " \\g with no arguments is equivalent to a semicolon\n");
169 HELP0(" \\gdesc describe result of query, without executing it\n");
170 HELP0(" \\gexec execute query, then execute each value in its result\n");
171 HELP0(" \\gset [PREFIX] execute query and store result in psql variables\n");
172 HELP0(" \\gx [(OPTIONS)] [FILE] as \\g, but forces expanded output mode\n");
173 HELP0(" \\q quit psql\n");
174 HELP0(" \\restrict RESTRICT_KEY\n"
175 " enter restricted mode with provided key\n");
176 HELP0(" \\unrestrict RESTRICT_KEY\n"
177 " exit restricted mode if key matches\n");
178 HELP0(" \\watch [[i=]SEC] [c=N] [m=MIN]\n"
179 " execute query every SEC seconds, up to N times,\n"
180 " stop if less than MIN rows are returned\n");
181 HELP0("\n");
182
183 HELP0("Help\n");
184
185 HELP0(" \\? [commands] show help on backslash commands\n");
186 HELP0(" \\? options show help on psql command-line options\n");
187 HELP0(" \\? variables show help on special variables\n");
188 HELP0(" \\h [NAME] help on syntax of SQL commands, * for all commands\n");
189 HELP0("\n");
190
191 HELP0("Query Buffer\n");
192 HELP0(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n");
193 HELP0(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n");
194 HELP0(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n");
195 HELP0(" \\p show the contents of the query buffer\n");
196 HELP0(" \\r reset (clear) the query buffer\n");
197#ifdef USE_READLINE
198 HELP0(" \\s [FILE] display history or save it to file\n");
199#endif
200 HELP0(" \\w FILE write query buffer to file\n");
201 HELP0("\n");
202
203 HELP0("Input/Output\n");
204 HELP0(" \\copy ... perform SQL COPY with data stream to the client host\n");
205 HELP0(" \\echo [-n] [STRING] write string to standard output (-n for no newline)\n");
206 HELP0(" \\i FILE execute commands from file\n");
207 HELP0(" \\ir FILE as \\i, but relative to location of current script\n");
208 HELP0(" \\o [FILE] send all query results to file or |pipe\n");
209 HELP0(" \\qecho [-n] [STRING] write string to \\o output stream (-n for no newline)\n");
210 HELP0(" \\warn [-n] [STRING] write string to standard error (-n for no newline)\n");
211 HELP0("\n");
212
213 HELP0("Conditional\n");
214 HELP0(" \\if EXPR begin conditional block\n");
215 HELP0(" \\elif EXPR alternative within current conditional block\n");
216 HELP0(" \\else final alternative within current conditional block\n");
217 HELP0(" \\endif end conditional block\n");
218 HELP0("\n");
219
220 HELP0("Informational\n");
221 HELP0(" (options: S = show system objects, x = expanded mode, + = additional detail)\n");
222 HELP0(" \\d[Sx+] list tables, views, and sequences\n");
223 HELP0(" \\d[S+] NAME describe table, view, sequence, or index\n");
224 HELP0(" \\da[Sx] [PATTERN] list aggregates\n");
225 HELP0(" \\dA[x+] [PATTERN] list access methods\n");
226 HELP0(" \\dAc[x+] [AMPTRN [TYPEPTRN]] list operator classes\n");
227 HELP0(" \\dAf[x+] [AMPTRN [TYPEPTRN]] list operator families\n");
228 HELP0(" \\dAo[x+] [AMPTRN [OPFPTRN]] list operators of operator families\n");
229 HELP0(" \\dAp[x+] [AMPTRN [OPFPTRN]] list support functions of operator families\n");
230 HELP0(" \\db[x+] [PATTERN] list tablespaces\n");
231 HELP0(" \\dc[Sx+] [PATTERN] list conversions\n");
232 HELP0(" \\dconfig[x+] [PATTERN] list configuration parameters\n");
233 HELP0(" \\dC[x+] [PATTERN] list casts\n");
234 HELP0(" \\dd[Sx] [PATTERN] show object descriptions not displayed elsewhere\n");
235 HELP0(" \\dD[Sx+] [PATTERN] list domains\n");
236 HELP0(" \\ddp[x] [PATTERN] list default privileges\n");
237 HELP0(" \\dE[Sx+] [PATTERN] list foreign tables\n");
238 HELP0(" \\des[x+] [PATTERN] list foreign servers\n");
239 HELP0(" \\det[x+] [PATTERN] list foreign tables\n");
240 HELP0(" \\deu[x+] [PATTERN] list user mappings\n");
241 HELP0(" \\dew[x+] [PATTERN] list foreign-data wrappers\n");
242 HELP0(" \\df[anptw][Sx+] [FUNCPTRN [TYPEPTRN ...]]\n"
243 " list [only agg/normal/procedure/trigger/window] functions\n");
244 HELP0(" \\dF[x+] [PATTERN] list text search configurations\n");
245 HELP0(" \\dFd[x+] [PATTERN] list text search dictionaries\n");
246 HELP0(" \\dFp[x+] [PATTERN] list text search parsers\n");
247 HELP0(" \\dFt[x+] [PATTERN] list text search templates\n");
248 HELP0(" \\dg[Sx+] [PATTERN] list roles\n");
249 HELP0(" \\di[Sx+] [PATTERN] list indexes\n");
250 HELP0(" \\dl[x+] list large objects, same as \\lo_list\n");
251 HELP0(" \\dL[Sx+] [PATTERN] list procedural languages\n");
252 HELP0(" \\dm[Sx+] [PATTERN] list materialized views\n");
253 HELP0(" \\dn[Sx+] [PATTERN] list schemas\n");
254 HELP0(" \\do[Sx+] [OPPTRN [TYPEPTRN [TYPEPTRN]]]\n"
255 " list operators\n");
256 HELP0(" \\dO[Sx+] [PATTERN] list collations\n");
257 HELP0(" \\dp[Sx] [PATTERN] list table, view, and sequence access privileges\n");
258 HELP0(" \\dP[itnx+] [PATTERN] list [only index/table] partitioned relations [n=nested]\n");
259 HELP0(" \\drds[x] [ROLEPTRN [DBPTRN]]\n"
260 " list per-database role settings\n");
261 HELP0(" \\drg[Sx] [PATTERN] list role grants\n");
262 HELP0(" \\dRp[x+] [PATTERN] list replication publications\n");
263 HELP0(" \\dRs[x+] [PATTERN] list replication subscriptions\n");
264 HELP0(" \\ds[Sx+] [PATTERN] list sequences\n");
265 HELP0(" \\dt[Sx+] [PATTERN] list tables\n");
266 HELP0(" \\dT[Sx+] [PATTERN] list data types\n");
267 HELP0(" \\du[Sx+] [PATTERN] list roles\n");
268 HELP0(" \\dv[Sx+] [PATTERN] list views\n");
269 HELP0(" \\dx[x+] [PATTERN] list extensions\n");
270 HELP0(" \\dX[x] [PATTERN] list extended statistics\n");
271 HELP0(" \\dy[x+] [PATTERN] list event triggers\n");
272 HELP0(" \\l[x+] [PATTERN] list databases\n");
273 HELP0(" \\sf[+] FUNCNAME show a function's definition\n");
274 HELP0(" \\sv[+] VIEWNAME show a view's definition\n");
275 HELP0(" \\z[Sx] [PATTERN] same as \\dp\n");
276 HELP0("\n");
277
278 HELP0("Large Objects\n");
279 HELP0(" \\lo_export LOBOID FILE write large object to file\n");
280 HELP0(" \\lo_import FILE [COMMENT]\n"
281 " read large object from file\n");
282 HELP0(" \\lo_list[x+] list large objects\n");
283 HELP0(" \\lo_unlink LOBOID delete a large object\n");
284 HELP0("\n");
285
286 HELP0("Formatting\n");
287 HELP0(" \\a toggle between unaligned and aligned output mode\n");
288 HELP0(" \\C [STRING] set table title, or unset if none\n");
289 HELP0(" \\f [STRING] show or set field separator for unaligned query output\n");
290 HELPN(" \\H toggle HTML output mode (currently %s)\n",
292 HELP0(" \\pset [NAME [VALUE]] set table output option\n"
293 " (border|columns|csv_fieldsep|expanded|fieldsep|\n"
294 " fieldsep_zero|footer|format|linestyle|null|\n"
295 " numericlocale|pager|pager_min_lines|recordsep|\n"
296 " recordsep_zero|tableattr|title|tuples_only|\n"
297 " unicode_border_linestyle|unicode_column_linestyle|\n"
298 " unicode_header_linestyle|xheader_width)\n");
299 HELPN(" \\t [on|off] show only rows (currently %s)\n",
301 HELP0(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n");
302 HELPN(" \\x [on|off|auto] toggle expanded output (currently %s)\n",
303 pset.popt.topt.expanded == 2 ? _("auto") : ON(pset.popt.topt.expanded));
304 HELP0("\n");
305
306 HELP0("Connection\n");
307 if (currdb)
308 HELPN(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
309 " connect to new database (currently \"%s\")\n",
310 currdb);
311 else
312 HELP0(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
313 " connect to new database (currently no connection)\n");
314 HELP0(" \\conninfo display information about current connection\n");
315 HELP0(" \\encoding [ENCODING] show or set client encoding\n");
316 HELP0(" \\password [USERNAME] securely change the password for a user\n");
317 HELP0("\n");
318
319 HELP0("Operating System\n");
320 HELP0(" \\cd [DIR] change the current working directory\n");
321 HELP0(" \\getenv PSQLVAR ENVVAR fetch environment variable\n");
322 HELP0(" \\setenv NAME [VALUE] set or unset environment variable\n");
323 HELPN(" \\timing [on|off] toggle timing of commands (currently %s)\n",
324 ON(pset.timing));
325 HELP0(" \\! [COMMAND] execute command in shell or start interactive shell\n");
326 HELP0("\n");
327
328 HELP0("Variables\n");
329 HELP0(" \\prompt [TEXT] NAME prompt user to set internal variable\n");
330 HELP0(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n");
331 HELP0(" \\unset NAME unset (delete) internal variable\n");
332 HELP0("\n");
333
334 HELP0("Extended Query Protocol\n");
335 HELP0(" \\bind [PARAM]... set query parameters\n");
336 HELP0(" \\bind_named STMT_NAME [PARAM]...\n"
337 " set query parameters for an existing prepared statement\n");
338 HELP0(" \\close_prepared STMT_NAME\n"
339 " close an existing prepared statement\n");
340 HELP0(" \\endpipeline exit pipeline mode\n");
341 HELP0(" \\flush flush output data to the server\n");
342 HELP0(" \\flushrequest send request to the server to flush its output buffer\n");
343 HELP0(" \\getresults [NUM_RES] read NUM_RES pending results, or all if no argument\n");
344 HELP0(" \\parse STMT_NAME create a prepared statement\n");
345 HELP0(" \\sendpipeline send an extended query to an ongoing pipeline\n");
346 HELP0(" \\startpipeline enter pipeline mode\n");
347 HELP0(" \\syncpipeline add a synchronisation point to an ongoing pipeline\n");
348
349 /* Now we can count the lines. */
350 nlcount = 0;
351 for (const char *ptr = buf.data; *ptr; ptr++)
352 {
353 if (*ptr == '\n')
354 nlcount++;
355 }
356
357 /* And dump the output, with appropriate pagination. */
358 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
359
360 fputs(buf.data, output);
361
363
365}
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:7513
@ PRINT_HTML
Definition: print.h:34
#define ON(var)
Definition: help.c:39
bool timing
Definition: settings.h:147
PGconn * db
Definition: settings.h:103
unsigned short int expanded
Definition: print.h:114
bool tuples_only
Definition: print.h:126
enum printFormat format
Definition: print.h:113

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 48 of file help.c.

49{
51 int nlcount;
52 FILE *output;
53
54 /*
55 * To avoid counting the output lines manually, build the output in "buf"
56 * and then count them.
57 */
59
60 HELP0("psql is the PostgreSQL interactive terminal.\n\n");
61 HELP0("Usage:\n");
62 HELP0(" psql [OPTION]... [DBNAME [USERNAME]]\n\n");
63
64 HELP0("General options:\n");
65 HELP0(" -c, --command=COMMAND run only single command (SQL or internal) and exit\n");
66 HELP0(" -d, --dbname=DBNAME database name to connect to\n");
67 HELP0(" -f, --file=FILENAME execute commands from file, then exit\n");
68 HELP0(" -l, --list list available databases, then exit\n");
69 HELP0(" -v, --set=, --variable=NAME=VALUE\n"
70 " set psql variable NAME to VALUE\n"
71 " (e.g., -v ON_ERROR_STOP=1)\n");
72 HELP0(" -V, --version output version information, then exit\n");
73 HELP0(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n");
74 HELP0(" -1 (\"one\"), --single-transaction\n"
75 " execute as a single transaction (if non-interactive)\n");
76 HELP0(" -?, --help[=options] show this help, then exit\n");
77 HELP0(" --help=commands list backslash commands, then exit\n");
78 HELP0(" --help=variables list special variables, then exit\n");
79
80 HELP0("\nInput and output options:\n");
81 HELP0(" -a, --echo-all echo all input from script\n");
82 HELP0(" -b, --echo-errors echo failed commands\n");
83 HELP0(" -e, --echo-queries echo commands sent to server\n");
84 HELP0(" -E, --echo-hidden display queries that internal commands generate\n");
85 HELP0(" -L, --log-file=FILENAME send session log to file\n");
86 HELP0(" -n, --no-readline disable enhanced command line editing (readline)\n");
87 HELP0(" -o, --output=FILENAME send query results to file (or |pipe)\n");
88 HELP0(" -q, --quiet run quietly (no messages, only query output)\n");
89 HELP0(" -s, --single-step single-step mode (confirm each query)\n");
90 HELP0(" -S, --single-line single-line mode (end of line terminates SQL command)\n");
91
92 HELP0("\nOutput format options:\n");
93 HELP0(" -A, --no-align unaligned table output mode\n");
94 HELP0(" --csv CSV (Comma-Separated Values) table output mode\n");
95 HELPN(" -F, --field-separator=STRING\n"
96 " field separator for unaligned output (default: \"%s\")\n",
98 HELP0(" -H, --html HTML table output mode\n");
99 HELP0(" -P, --pset=VAR[=ARG] set printing option VAR to ARG (see \\pset command)\n");
100 HELP0(" -R, --record-separator=STRING\n"
101 " record separator for unaligned output (default: newline)\n");
102 HELP0(" -t, --tuples-only print rows only\n");
103 HELP0(" -T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)\n");
104 HELP0(" -x, --expanded turn on expanded table output\n");
105 HELP0(" -z, --field-separator-zero\n"
106 " set field separator for unaligned output to zero byte\n");
107 HELP0(" -0, --record-separator-zero\n"
108 " set record separator for unaligned output to zero byte\n");
109
110 HELP0("\nConnection options:\n");
111 HELP0(" -h, --host=HOSTNAME database server host or socket directory\n");
112 HELP0(" -p, --port=PORT database server port\n");
113 HELP0(" -U, --username=USERNAME database user name\n");
114 HELP0(" -w, --no-password never prompt for password\n");
115 HELP0(" -W, --password force password prompt (should happen automatically)\n");
116
117 HELP0("\nFor more information, type \"\\?\" (for internal commands) or \"\\help\" (for SQL\n"
118 "commands) from within psql, or consult the psql section in the PostgreSQL\n"
119 "documentation.\n\n");
120 HELPN("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
121 HELPN("%s home page: <%s>\n", PACKAGE_NAME, PACKAGE_URL);
122
123 /* Now we can count the lines. */
124 nlcount = 0;
125 for (const char *ptr = buf.data; *ptr; ptr++)
126 {
127 if (*ptr == '\n')
128 nlcount++;
129 }
130
131 /* And dump the output, with appropriate pagination. */
132 output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
133
134 fputs(buf.data, output);
135
137
139}

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

AltStyle によって変換されたページ (->オリジナル) /