PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Functions
help.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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)
 

Function Documentation

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

Definition at line 441 of file help.c.

References _, buffer, ClosePager(), PQExpBufferData::data, help(), i, initPQExpBuffer(), Max, NULL, output(), PageOutput(), pg_strcasecmp(), pg_strncasecmp(), _psqlSettings::popt, pset, printQueryOpt::topt, and VALUE_OR_NULL.

Referenced by exec_command_help().

442 {
443 #define VALUE_OR_NULL(a) ((a) ? (a) : "")
444 
445  if (!topic || strlen(topic) == 0)
446  {
447  /* Print all the available command names */
448  int screen_width;
449  int ncolumns;
450  int nrows;
451  FILE *output;
452  int i;
453  int j;
454 
455 #ifdef TIOCGWINSZ
456  struct winsize screen_size;
457 
458  if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)
459  screen_width = 80; /* ioctl failed, assume 80 */
460  else
461  screen_width = screen_size.ws_col;
462 #else
463  screen_width = 80; /* default assumption */
464 #endif
465 
466  ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);
467  ncolumns = Max(ncolumns, 1);
468  nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;
469 
470  output = PageOutput(nrows + 1, pager ? &(pset.popt.topt) : NULL);
471 
472  fputs(_("Available help:\n"), output);
473 
474  for (i = 0; i < nrows; i++)
475  {
476  fprintf(output, " ");
477  for (j = 0; j < ncolumns - 1; j++)
478  fprintf(output, "%-*s",
479  QL_MAX_CMD_LEN + 1,
480  VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
481  if (i + j * nrows < QL_HELP_COUNT)
482  fprintf(output, "%s",
483  VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
484  fputc('\n', output);
485  }
486 
487  ClosePager(output);
488  }
489  else
490  {
491  int i,
492  j,
493  x = 0;
494  bool help_found = false;
495  FILE *output = NULL;
496  size_t len,
497  wordlen;
498  int nl_count = 0;
499 
500  /*
501  * We first try exact match, then first + second words, then first
502  * word only.
503  */
504  len = strlen(topic);
505 
506  for (x = 1; x <= 3; x++)
507  {
508  if (x > 1) /* Nothing on first pass - try the opening
509  * word(s) */
510  {
511  wordlen = j = 1;
512  while (topic[j] != ' ' && j++ < len)
513  wordlen++;
514  if (x == 2)
515  {
516  j++;
517  while (topic[j] != ' ' && j++ <= len)
518  wordlen++;
519  }
520  if (wordlen >= len) /* Don't try again if the same word */
521  {
522  if (!output)
523  output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
524  break;
525  }
526  len = wordlen;
527  }
528 
529  /* Count newlines for pager */
530  for (i = 0; QL_HELP[i].cmd; i++)
531  {
532  if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
533  strcmp(topic, "*") == 0)
534  {
535  nl_count += 5 + QL_HELP[i].nl_count;
536 
537  /* If we have an exact match, exit. Fixes \h SELECT */
538  if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
539  break;
540  }
541  }
542 
543  if (!output)
544  output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
545 
546  for (i = 0; QL_HELP[i].cmd; i++)
547  {
548  if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
549  strcmp(topic, "*") == 0)
550  {
551  PQExpBufferData buffer;
552 
553  initPQExpBuffer(&buffer);
554  QL_HELP[i].syntaxfunc(&buffer);
555  help_found = true;
556  fprintf(output, _("Command: %s\n"
557  "Description: %s\n"
558  "Syntax:\n%s\n\n"),
559  QL_HELP[i].cmd,
560  _(QL_HELP[i].help),
561  buffer.data);
562  /* If we have an exact match, exit. Fixes \h SELECT */
563  if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
564  break;
565  }
566  }
567  if (help_found) /* Don't keep trying if we got a match */
568  break;
569  }
570 
571  if (!help_found)
572  fprintf(output, _("No help available for \"%s\".\nTry \\h with no arguments to see available help.\n"), topic);
573 
574  ClosePager(output);
575  }
576 }
pset
PsqlSettings pset
Definition: startup.c:33
output
static void output(uint64 loop_count)
Definition: pg_test_timing.c:171
ClosePager
void ClosePager(FILE *pagerpipe)
Definition: print.c:2900
printQueryOpt::topt
printTableOpt topt
Definition: print.h:165
pg_strcasecmp
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
help
static void help(const char *progname)
Definition: oid2name.c:172
pg_strncasecmp
int pg_strncasecmp(const char *s1, const char *s2, size_t n)
Definition: pgstrcasecmp.c:69
PageOutput
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:2851
Max
#define Max(x, y)
Definition: c.h:801
NULL
#define NULL
Definition: c.h:229
buffer
WalTimeSample buffer[LAG_TRACKER_BUFFER_SIZE]
Definition: walsender.c:214
_psqlSettings::popt
printQueryOpt popt
Definition: settings.h:91
i
int i
Definition: preproc-comment.c:23
VALUE_OR_NULL
#define VALUE_OR_NULL(a)
_
#define _(x)
Definition: elog.c:84
initPQExpBuffer
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:89
void helpVariables ( unsigned short int  pager)

Definition at line 329 of file help.c.

References _, ClosePager(), DEFAULT_FIELD_SEP, NULL, output(), PageOutput(), _psqlSettings::popt, pset, and printQueryOpt::topt.

Referenced by exec_command_slash_command_help(), and parse_psql_options().

330 {
331  FILE *output;
332 
333  /*
334  * Keep this line count in sync with the number of lines printed below!
335  * Use "psql --help=variables | wc" to count correctly; but notice that
336  * Windows builds currently print one more line than non-Windows builds.
337  * Using the larger number is fine.
338  */
339  output = PageOutput(88, pager ? &(pset.popt.topt) : NULL);
340 
341  fprintf(output, _("List of specially treated variables\n\n"));
342 
343  fprintf(output, _("psql variables:\n"));
344  fprintf(output, _("Usage:\n"));
345  fprintf(output, _(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n"));
346 
347  fprintf(output, _(" AUTOCOMMIT if set, successful SQL commands are automatically committed\n"));
348  fprintf(output, _(" COMP_KEYWORD_CASE determines the case used to complete SQL key words\n"
349  " [lower, upper, preserve-lower, preserve-upper]\n"));
350  fprintf(output, _(" DBNAME the currently connected database name\n"));
351  fprintf(output, _(" ECHO controls what input is written to standard output\n"
352  " [all, errors, none, queries]\n"));
353  fprintf(output, _(" ECHO_HIDDEN if set, display internal queries executed by backslash commands;\n"
354  " if set to \"noexec\", just show without execution\n"));
355  fprintf(output, _(" ENCODING current client character set encoding\n"));
356  fprintf(output, _(" FETCH_COUNT the number of result rows to fetch and display at a time\n"
357  " (default: 0=unlimited)\n"));
358  fprintf(output, _(" HISTCONTROL controls command history [ignorespace, ignoredups, ignoreboth]\n"));
359  fprintf(output, _(" HISTFILE file name used to store the command history\n"));
360  fprintf(output, _(" HISTSIZE max number of commands to store in the command history\n"));
361  fprintf(output, _(" HOST the currently connected database server host\n"));
362  fprintf(output, _(" IGNOREEOF number of EOFs needed to terminate an interactive session\n"));
363  fprintf(output, _(" LASTOID value of the last affected OID\n"));
364  fprintf(output, _(" ON_ERROR_ROLLBACK if set, an error doesn't stop a transaction (uses implicit savepoints)\n"));
365  fprintf(output, _(" ON_ERROR_STOP stop batch execution after error\n"));
366  fprintf(output, _(" PORT server port of the current connection\n"));
367  fprintf(output, _(" PROMPT1 specifies the standard psql prompt\n"));
368  fprintf(output, _(" PROMPT2 specifies the prompt used when a statement continues from a previous line\n"));
369  fprintf(output, _(" PROMPT3 specifies the prompt used during COPY ... FROM STDIN\n"));
370  fprintf(output, _(" QUIET run quietly (same as -q option)\n"));
371  fprintf(output, _(" SHOW_CONTEXT controls display of message context fields [never, errors, always]\n"));
372  fprintf(output, _(" SINGLELINE end of line terminates SQL command mode (same as -S option)\n"));
373  fprintf(output, _(" SINGLESTEP single-step mode (same as -s option)\n"));
374  fprintf(output, _(" USER the currently connected database user\n"));
375  fprintf(output, _(" VERBOSITY controls verbosity of error reports [default, verbose, terse]\n"));
376 
377  fprintf(output, _("\nDisplay settings:\n"));
378  fprintf(output, _("Usage:\n"));
379  fprintf(output, _(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n"));
380 
381  fprintf(output, _(" border border style (number)\n"));
382  fprintf(output, _(" columns target width for the wrapped format\n"));
383  fprintf(output, _(" expanded (or x) expanded output [on, off, auto]\n"));
384  fprintf(output, _(" fieldsep field separator for unaligned output (default \"%s\")\n"), DEFAULT_FIELD_SEP);
385  fprintf(output, _(" fieldsep_zero set field separator for unaligned output to zero byte\n"));
386  fprintf(output, _(" footer enable or disable display of the table footer [on, off]\n"));
387  fprintf(output, _(" format set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n"));
388  fprintf(output, _(" linestyle set the border line drawing style [ascii, old-ascii, unicode]\n"));
389  fprintf(output, _(" null set the string to be printed in place of a null value\n"));
390  fprintf(output, _(" numericlocale enable or disable display of a locale-specific character to separate\n"
391  " groups of digits [on, off]\n"));
392  fprintf(output, _(" pager control when an external pager is used [yes, no, always]\n"));
393  fprintf(output, _(" recordsep record (line) separator for unaligned output\n"));
394  fprintf(output, _(" recordsep_zero set record separator for unaligned output to zero byte\n"));
395  fprintf(output, _(" tableattr (or T) specify attributes for table tag in html format or proportional\n"
396  " column widths for left-aligned data types in latex-longtable format\n"));
397  fprintf(output, _(" title set the table title for any subsequently printed tables\n"));
398  fprintf(output, _(" tuples_only if set, only actual table data is shown\n"));
399  fprintf(output, _(" unicode_border_linestyle\n"
400  " unicode_column_linestyle\n"
401  " unicode_header_linestyle\n"
402  " set the style of Unicode line drawing [single, double]\n"));
403 
404  fprintf(output, _("\nEnvironment variables:\n"));
405  fprintf(output, _("Usage:\n"));
406 
407 #ifndef WIN32
408  fprintf(output, _(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n"));
409 #else
410  fprintf(output, _(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n"));
411 #endif
412 
413  fprintf(output, _(" COLUMNS number of columns for wrapped format\n"));
414  fprintf(output, _(" PAGER name of external pager program\n"));
415  fprintf(output, _(" PGAPPNAME same as the application_name connection parameter\n"));
416  fprintf(output, _(" PGDATABASE same as the dbname connection parameter\n"));
417  fprintf(output, _(" PGHOST same as the host connection parameter\n"));
418  fprintf(output, _(" PGPASSWORD connection password (not recommended)\n"));
419  fprintf(output, _(" PGPASSFILE password file name\n"));
420  fprintf(output, _(" PGPORT same as the port connection parameter\n"));
421  fprintf(output, _(" PGUSER same as the user connection parameter\n"));
422  fprintf(output, _(" PSQL_EDITOR, EDITOR, VISUAL\n"
423  " editor used by the \\e, \\ef, and \\ev commands\n"));
424  fprintf(output, _(" PSQL_EDITOR_LINENUMBER_ARG\n"
425  " how to specify a line number when invoking the editor\n"));
426  fprintf(output, _(" PSQL_HISTORY alternative location for the command history file\n"));
427  fprintf(output, _(" PSQLRC alternative location for the user's .psqlrc file\n"));
428  fprintf(output, _(" SHELL shell used by the \\! command\n"));
429  fprintf(output, _(" TMPDIR directory for temporary files\n"));
430 
431  ClosePager(output);
432 }
pset
PsqlSettings pset
Definition: startup.c:33
output
static void output(uint64 loop_count)
Definition: pg_test_timing.c:171
ClosePager
void ClosePager(FILE *pagerpipe)
Definition: print.c:2900
printQueryOpt::topt
printTableOpt topt
Definition: print.h:165
PageOutput
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:2851
NULL
#define NULL
Definition: c.h:229
_psqlSettings::popt
printQueryOpt popt
Definition: settings.h:91
DEFAULT_FIELD_SEP
#define DEFAULT_FIELD_SEP
Definition: settings.h:15
_
#define _(x)
Definition: elog.c:84
void print_copyright ( void  )

Definition at line 581 of file help.c.

Referenced by exec_command_copyright().

582 {
583  puts(
584  "PostgreSQL Database Management System\n"
585  "(formerly known as Postgres, then as Postgres95)\n\n"
586  "Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group\n\n"
587  "Portions Copyright (c) 1994, The Regents of the University of California\n\n"
588  "Permission to use, copy, modify, and distribute this software and its\n"
589  "documentation for any purpose, without fee, and without a written agreement\n"
590  "is hereby granted, provided that the above copyright notice and this\n"
591  "paragraph and the following two paragraphs appear in all copies.\n\n"
592  "IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"
593  "DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"
594  "LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"
595  "DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"
596  "POSSIBILITY OF SUCH DAMAGE.\n\n"
597  "THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"
598  "INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"
599  "AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"
600  "ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"
601  "PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n"
602  );
603 }
void slashUsage ( unsigned short int  pager)

Definition at line 158 of file help.c.

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

Referenced by exec_command_slash_command_help(), and parse_psql_options().

159 {
160  FILE *output;
161  char *currdb;
162 
163  currdb = PQdb(pset.db);
164 
165  /*
166  * Keep this line count in sync with the number of lines printed below!
167  * Use "psql --help=commands | wc" to count correctly. It's okay to count
168  * the USE_READLINE line even in builds without that.
169  */
170  output = PageOutput(122, pager ? &(pset.popt.topt) : NULL);
171 
172  fprintf(output, _("General\n"));
173  fprintf(output, _(" \\copyright show PostgreSQL usage and distribution terms\n"));
174  fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n"));
175  fprintf(output, _(" \\errverbose show most recent error message at maximum verbosity\n"));
176  fprintf(output, _(" \\g [FILE] or ; execute query (and send results to file or |pipe)\n"));
177  fprintf(output, _(" \\gexec execute query, then execute each value in its result\n"));
178  fprintf(output, _(" \\gset [PREFIX] execute query and store results in psql variables\n"));
179  fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n"));
180  fprintf(output, _(" \\q quit psql\n"));
181  fprintf(output, _(" \\watch [SEC] execute query every SEC seconds\n"));
182  fprintf(output, "\n");
183 
184  fprintf(output, _("Help\n"));
185 
186  fprintf(output, _(" \\? [commands] show help on backslash commands\n"));
187  fprintf(output, _(" \\? options show help on psql command-line options\n"));
188  fprintf(output, _(" \\? variables show help on special variables\n"));
189  fprintf(output, _(" \\h [NAME] help on syntax of SQL commands, * for all commands\n"));
190  fprintf(output, "\n");
191 
192  fprintf(output, _("Query Buffer\n"));
193  fprintf(output, _(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n"));
194  fprintf(output, _(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n"));
195  fprintf(output, _(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n"));
196  fprintf(output, _(" \\p show the contents of the query buffer\n"));
197  fprintf(output, _(" \\r reset (clear) the query buffer\n"));
198 #ifdef USE_READLINE
199  fprintf(output, _(" \\s [FILE] display history or save it to file\n"));
200 #endif
201  fprintf(output, _(" \\w FILE write query buffer to file\n"));
202  fprintf(output, "\n");
203 
204  fprintf(output, _("Input/Output\n"));
205  fprintf(output, _(" \\copy ... perform SQL COPY with data stream to the client host\n"));
206  fprintf(output, _(" \\echo [STRING] write string to standard output\n"));
207  fprintf(output, _(" \\i FILE execute commands from file\n"));
208  fprintf(output, _(" \\ir FILE as \\i, but relative to location of current script\n"));
209  fprintf(output, _(" \\o [FILE] send all query results to file or |pipe\n"));
210  fprintf(output, _(" \\qecho [STRING] write string to query output stream (see \\o)\n"));
211  fprintf(output, "\n");
212 
213  fprintf(output, _("Conditional\n"));
214  fprintf(output, _(" \\if EXPR begin conditional block\n"));
215  fprintf(output, _(" \\elif EXPR alternative within current conditional block\n"));
216  fprintf(output, _(" \\else final alternative within current conditional block\n"));
217  fprintf(output, _(" \\endif end conditional block\n"));
218  fprintf(output, "\n");
219 
220  fprintf(output, _("Informational\n"));
221  fprintf(output, _(" (options: S = show system objects, + = additional detail)\n"));
222  fprintf(output, _(" \\d[S+] list tables, views, and sequences\n"));
223  fprintf(output, _(" \\d[S+] NAME describe table, view, sequence, or index\n"));
224  fprintf(output, _(" \\da[S] [PATTERN] list aggregates\n"));
225  fprintf(output, _(" \\dA[+] [PATTERN] list access methods\n"));
226  fprintf(output, _(" \\db[+] [PATTERN] list tablespaces\n"));
227  fprintf(output, _(" \\dc[S+] [PATTERN] list conversions\n"));
228  fprintf(output, _(" \\dC[+] [PATTERN] list casts\n"));
229  fprintf(output, _(" \\dd[S] [PATTERN] show object descriptions not displayed elsewhere\n"));
230  fprintf(output, _(" \\dD[S+] [PATTERN] list domains\n"));
231  fprintf(output, _(" \\ddp [PATTERN] list default privileges\n"));
232  fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
233  fprintf(output, _(" \\det[+] [PATTERN] list foreign tables\n"));
234  fprintf(output, _(" \\des[+] [PATTERN] list foreign servers\n"));
235  fprintf(output, _(" \\deu[+] [PATTERN] list user mappings\n"));
236  fprintf(output, _(" \\dew[+] [PATTERN] list foreign-data wrappers\n"));
237  fprintf(output, _(" \\df[antw][S+] [PATRN] list [only agg/normal/trigger/window] functions\n"));
238  fprintf(output, _(" \\dF[+] [PATTERN] list text search configurations\n"));
239  fprintf(output, _(" \\dFd[+] [PATTERN] list text search dictionaries\n"));
240  fprintf(output, _(" \\dFp[+] [PATTERN] list text search parsers\n"));
241  fprintf(output, _(" \\dFt[+] [PATTERN] list text search templates\n"));
242  fprintf(output, _(" \\dg[S+] [PATTERN] list roles\n"));
243  fprintf(output, _(" \\di[S+] [PATTERN] list indexes\n"));
244  fprintf(output, _(" \\dl list large objects, same as \\lo_list\n"));
245  fprintf(output, _(" \\dL[S+] [PATTERN] list procedural languages\n"));
246  fprintf(output, _(" \\dm[S+] [PATTERN] list materialized views\n"));
247  fprintf(output, _(" \\dn[S+] [PATTERN] list schemas\n"));
248  fprintf(output, _(" \\do[S] [PATTERN] list operators\n"));
249  fprintf(output, _(" \\dO[S+] [PATTERN] list collations\n"));
250  fprintf(output, _(" \\dp [PATTERN] list table, view, and sequence access privileges\n"));
251  fprintf(output, _(" \\drds [PATRN1 [PATRN2]] list per-database role settings\n"));
252  fprintf(output, _(" \\dRp[+] [PATTERN] list replication publications\n"));
253  fprintf(output, _(" \\dRs[+] [PATTERN] list replication subscriptions\n"));
254  fprintf(output, _(" \\ds[S+] [PATTERN] list sequences\n"));
255  fprintf(output, _(" \\dt[S+] [PATTERN] list tables\n"));
256  fprintf(output, _(" \\dT[S+] [PATTERN] list data types\n"));
257  fprintf(output, _(" \\du[S+] [PATTERN] list roles\n"));
258  fprintf(output, _(" \\dv[S+] [PATTERN] list views\n"));
259  fprintf(output, _(" \\dx[+] [PATTERN] list extensions\n"));
260  fprintf(output, _(" \\dy [PATTERN] list event triggers\n"));
261  fprintf(output, _(" \\l[+] [PATTERN] list databases\n"));
262  fprintf(output, _(" \\sf[+] FUNCNAME show a function's definition\n"));
263  fprintf(output, _(" \\sv[+] VIEWNAME show a view's definition\n"));
264  fprintf(output, _(" \\z [PATTERN] same as \\dp\n"));
265  fprintf(output, "\n");
266 
267  fprintf(output, _("Formatting\n"));
268  fprintf(output, _(" \\a toggle between unaligned and aligned output mode\n"));
269  fprintf(output, _(" \\C [STRING] set table title, or unset if none\n"));
270  fprintf(output, _(" \\f [STRING] show or set field separator for unaligned query output\n"));
271  fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"),
272  ON(pset.popt.topt.format == PRINT_HTML));
273  fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n"
274  " (NAME := {border|columns|expanded|fieldsep|fieldsep_zero|\n"
275  " footer|format|linestyle|null|numericlocale|pager|\n"
276  " pager_min_lines|recordsep|recordsep_zero|tableattr|title|\n"
277  " tuples_only|unicode_border_linestyle|\n"
278  " unicode_column_linestyle|unicode_header_linestyle})\n"));
279  fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
280  ON(pset.popt.topt.tuples_only));
281  fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));
282  fprintf(output, _(" \\x [on|off|auto] toggle expanded output (currently %s)\n"),
283  pset.popt.topt.expanded == 2 ? "auto" : ON(pset.popt.topt.expanded));
284  fprintf(output, "\n");
285 
286  fprintf(output, _("Connection\n"));
287  if (currdb)
288  fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
289  " connect to new database (currently \"%s\")\n"),
290  currdb);
291  else
292  fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
293  " connect to new database (currently no connection)\n"));
294  fprintf(output, _(" \\conninfo display information about current connection\n"));
295  fprintf(output, _(" \\encoding [ENCODING] show or set client encoding\n"));
296  fprintf(output, _(" \\password [USERNAME] securely change the password for a user\n"));
297  fprintf(output, "\n");
298 
299  fprintf(output, _("Operating System\n"));
300  fprintf(output, _(" \\cd [DIR] change the current working directory\n"));
301  fprintf(output, _(" \\setenv NAME [VALUE] set or unset environment variable\n"));
302  fprintf(output, _(" \\timing [on|off] toggle timing of commands (currently %s)\n"),
303  ON(pset.timing));
304  fprintf(output, _(" \\! [COMMAND] execute command in shell or start interactive shell\n"));
305  fprintf(output, "\n");
306 
307  fprintf(output, _("Variables\n"));
308  fprintf(output, _(" \\prompt [TEXT] NAME prompt user to set internal variable\n"));
309  fprintf(output, _(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n"));
310  fprintf(output, _(" \\unset NAME unset (delete) internal variable\n"));
311  fprintf(output, "\n");
312 
313  fprintf(output, _("Large Objects\n"));
314  fprintf(output, _(" \\lo_export LOBOID FILE\n"
315  " \\lo_import FILE [COMMENT]\n"
316  " \\lo_list\n"
317  " \\lo_unlink LOBOID large object operations\n"));
318 
319  ClosePager(output);
320 }
_psqlSettings::db
PGconn * db
Definition: settings.h:82
pset
PsqlSettings pset
Definition: startup.c:33
output
static void output(uint64 loop_count)
Definition: pg_test_timing.c:171
ClosePager
void ClosePager(FILE *pagerpipe)
Definition: print.c:2900
printTableOpt::format
enum printFormat format
Definition: print.h:98
printQueryOpt::topt
printTableOpt topt
Definition: print.h:165
ON
#define ON(var)
Definition: help.c:45
PRINT_HTML
Definition: print.h:32
printTableOpt::expanded
unsigned short int expanded
Definition: print.h:99
PageOutput
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:2851
printTableOpt::tuples_only
bool tuples_only
Definition: print.h:107
PQdb
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:5965
NULL
#define NULL
Definition: c.h:229
_psqlSettings::popt
printQueryOpt popt
Definition: settings.h:91
_
#define _(x)
Definition: elog.c:84
_psqlSettings::timing
bool timing
Definition: settings.h:112
void usage ( unsigned short int  pager)

Definition at line 48 of file help.c.

References _, ClosePager(), DEFAULT_FIELD_SEP, EXIT_FAILURE, get_user_name(), NULL, output(), PageOutput(), _psqlSettings::popt, pset, psql_error(), printQueryOpt::topt, and user.

49 {
50  const char *env;
51  const char *user;
52  char *errstr;
53  FILE *output;
54 
55  /* Find default user, in case we need it. */
56  user = getenv("PGUSER");
57  if (!user)
58  {
59  user = get_user_name(&errstr);
60  if (!user)
61  {
62  psql_error("%s\n", errstr);
63  exit(EXIT_FAILURE);
64  }
65  }
66 
67  /*
68  * Keep this line count in sync with the number of lines printed below!
69  * Use "psql --help=options | wc" to count correctly.
70  */
71  output = PageOutput(61, pager ? &(pset.popt.topt) : NULL);
72 
73  fprintf(output, _("psql is the PostgreSQL interactive terminal.\n\n"));
74  fprintf(output, _("Usage:\n"));
75  fprintf(output, _(" psql [OPTION]... [DBNAME [USERNAME]]\n\n"));
76 
77  fprintf(output, _("General options:\n"));
78  /* Display default database */
79  env = getenv("PGDATABASE");
80  if (!env)
81  env = user;
82  fprintf(output, _(" -c, --command=COMMAND run only single command (SQL or internal) and exit\n"));
83  fprintf(output, _(" -d, --dbname=DBNAME database name to connect to (default: \"%s\")\n"), env);
84  fprintf(output, _(" -f, --file=FILENAME execute commands from file, then exit\n"));
85  fprintf(output, _(" -l, --list list available databases, then exit\n"));
86  fprintf(output, _(" -v, --set=, --variable=NAME=VALUE\n"
87  " set psql variable NAME to VALUE\n"
88  " (e.g., -v ON_ERROR_STOP=1)\n"));
89  fprintf(output, _(" -V, --version output version information, then exit\n"));
90  fprintf(output, _(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n"));
91  fprintf(output, _(" -1 (\"one\"), --single-transaction\n"
92  " execute as a single transaction (if non-interactive)\n"));
93  fprintf(output, _(" -?, --help[=options] show this help, then exit\n"));
94  fprintf(output, _(" --help=commands list backslash commands, then exit\n"));
95  fprintf(output, _(" --help=variables list special variables, then exit\n"));
96 
97  fprintf(output, _("\nInput and output options:\n"));
98  fprintf(output, _(" -a, --echo-all echo all input from script\n"));
99  fprintf(output, _(" -b, --echo-errors echo failed commands\n"));
100  fprintf(output, _(" -e, --echo-queries echo commands sent to server\n"));
101  fprintf(output, _(" -E, --echo-hidden display queries that internal commands generate\n"));
102  fprintf(output, _(" -L, --log-file=FILENAME send session log to file\n"));
103  fprintf(output, _(" -n, --no-readline disable enhanced command line editing (readline)\n"));
104  fprintf(output, _(" -o, --output=FILENAME send query results to file (or |pipe)\n"));
105  fprintf(output, _(" -q, --quiet run quietly (no messages, only query output)\n"));
106  fprintf(output, _(" -s, --single-step single-step mode (confirm each query)\n"));
107  fprintf(output, _(" -S, --single-line single-line mode (end of line terminates SQL command)\n"));
108 
109  fprintf(output, _("\nOutput format options:\n"));
110  fprintf(output, _(" -A, --no-align unaligned table output mode\n"));
111  fprintf(output, _(" -F, --field-separator=STRING\n"
112  " field separator for unaligned output (default: \"%s\")\n"),
113  DEFAULT_FIELD_SEP);
114  fprintf(output, _(" -H, --html HTML table output mode\n"));
115  fprintf(output, _(" -P, --pset=VAR[=ARG] set printing option VAR to ARG (see \\pset command)\n"));
116  fprintf(output, _(" -R, --record-separator=STRING\n"
117  " record separator for unaligned output (default: newline)\n"));
118  fprintf(output, _(" -t, --tuples-only print rows only\n"));
119  fprintf(output, _(" -T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)\n"));
120  fprintf(output, _(" -x, --expanded turn on expanded table output\n"));
121  fprintf(output, _(" -z, --field-separator-zero\n"
122  " set field separator for unaligned output to zero byte\n"));
123  fprintf(output, _(" -0, --record-separator-zero\n"
124  " set record separator for unaligned output to zero byte\n"));
125 
126  fprintf(output, _("\nConnection options:\n"));
127  /* Display default host */
128  env = getenv("PGHOST");
129  fprintf(output, _(" -h, --host=HOSTNAME database server host or socket directory (default: \"%s\")\n"),
130  env ? env : _("local socket"));
131  /* Display default port */
132  env = getenv("PGPORT");
133  fprintf(output, _(" -p, --port=PORT database server port (default: \"%s\")\n"),
134  env ? env : DEF_PGPORT_STR);
135  /* Display default user */
136  env = getenv("PGUSER");
137  if (!env)
138  env = user;
139  fprintf(output, _(" -U, --username=USERNAME database user name (default: \"%s\")\n"), env);
140  fprintf(output, _(" -w, --no-password never prompt for password\n"));
141  fprintf(output, _(" -W, --password force password prompt (should happen automatically)\n"));
142 
143  fprintf(output, _("\nFor more information, type \"\\?\" (for internal commands) or \"\\help\" (for SQL\n"
144  "commands) from within psql, or consult the psql section in the PostgreSQL\n"
145  "documentation.\n\n"));
146  fprintf(output, _("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
147 
148  ClosePager(output);
149 }
pset
PsqlSettings pset
Definition: startup.c:33
output
static void output(uint64 loop_count)
Definition: pg_test_timing.c:171
ClosePager
void ClosePager(FILE *pagerpipe)
Definition: print.c:2900
printQueryOpt::topt
printTableOpt topt
Definition: print.h:165
get_user_name
const char * get_user_name(char **errstr)
Definition: username.c:31
PageOutput
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:2851
psql_error
void psql_error(const char *fmt,...)
Definition: common.c:220
NULL
#define NULL
Definition: c.h:229
_psqlSettings::popt
printQueryOpt popt
Definition: settings.h:91
user
static char * user
Definition: pg_regress.c:92
EXIT_FAILURE
#define EXIT_FAILURE
Definition: settings.h:151
DEFAULT_FIELD_SEP
#define DEFAULT_FIELD_SEP
Definition: settings.h:15
_
#define _(x)
Definition: elog.c:84