Line data Source code
1 : /*
2 : * psql - the PostgreSQL interactive terminal
3 : *
4 : * Copyright (c) 2000-2025, PostgreSQL Global Development Group
5 : *
6 : * src/bin/psql/help.c
7 : */
8 : #include "postgres_fe.h"
9 :
10 : #ifndef WIN32
11 : #include <unistd.h> /* for geteuid() */
12 : #else
13 : #include <win32.h>
14 : #endif
15 :
16 : #ifndef WIN32
17 : #include <sys/ioctl.h> /* for ioctl() */
18 : #endif
19 :
20 : #ifdef HAVE_TERMIOS_H
21 : #include <termios.h>
22 : #endif
23 :
24 : #include "help.h"
25 : #include "input.h"
26 : #include "settings.h"
27 : #include "sql_help.h"
28 :
29 : /*
30 : * PLEASE:
31 : * If you change something in this file, also make the same changes
32 : * in the DocBook documentation, file ref/psql-ref.sgml. If you don't
33 : * know how to do it, please find someone who can help you.
34 : */
35 :
36 : /* Some helper macros to make the code less verbose */
37 : #define HELP0(str) appendPQExpBufferStr(&buf, _(str))
38 : #define HELPN(str,...) appendPQExpBuffer(&buf, _(str), __VA_ARGS__)
39 : #define ON(var) ((var) ? _("on") : _("off"))
40 :
41 :
42 : /*
43 : * usage
44 : *
45 : * print out command line arguments
46 : */
47 : void
48 2 : usage(unsigned short int pager)
49 : {
50 : PQExpBufferData buf;
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 : */
58 2 : initPQExpBuffer(&buf);
59 :
60 2 : HELP0("psql is the PostgreSQL interactive terminal.\n\n");
61 2 : HELP0("Usage:\n");
62 2 : HELP0(" psql [OPTION]... [DBNAME [USERNAME]]\n\n");
63 :
64 2 : HELP0("General options:\n");
65 2 : HELP0(" -c, --command=COMMAND run only single command (SQL or internal) and exit\n");
66 2 : HELP0(" -d, --dbname=DBNAME database name to connect to\n");
67 2 : HELP0(" -f, --file=FILENAME execute commands from file, then exit\n");
68 2 : HELP0(" -l, --list list available databases, then exit\n");
69 2 : 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 2 : HELP0(" -V, --version output version information, then exit\n");
73 2 : HELP0(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n");
74 2 : HELP0(" -1 (\"one\"), --single-transaction\n"
75 : " execute as a single transaction (if non-interactive)\n");
76 2 : HELP0(" -?, --help[=options] show this help, then exit\n");
77 2 : HELP0(" --help=commands list backslash commands, then exit\n");
78 2 : HELP0(" --help=variables list special variables, then exit\n");
79 :
80 2 : HELP0("\nInput and output options:\n");
81 2 : HELP0(" -a, --echo-all echo all input from script\n");
82 2 : HELP0(" -b, --echo-errors echo failed commands\n");
83 2 : HELP0(" -e, --echo-queries echo commands sent to server\n");
84 2 : HELP0(" -E, --echo-hidden display queries that internal commands generate\n");
85 2 : HELP0(" -L, --log-file=FILENAME send session log to file\n");
86 2 : HELP0(" -n, --no-readline disable enhanced command line editing (readline)\n");
87 2 : HELP0(" -o, --output=FILENAME send query results to file (or |pipe)\n");
88 2 : HELP0(" -q, --quiet run quietly (no messages, only query output)\n");
89 2 : HELP0(" -s, --single-step single-step mode (confirm each query)\n");
90 2 : HELP0(" -S, --single-line single-line mode (end of line terminates SQL command)\n");
91 :
92 2 : HELP0("\nOutput format options:\n");
93 2 : HELP0(" -A, --no-align unaligned table output mode\n");
94 2 : HELP0(" --csv CSV (Comma-Separated Values) table output mode\n");
95 2 : HELPN(" -F, --field-separator=STRING\n"
96 : " field separator for unaligned output (default: \"%s\")\n",
97 : DEFAULT_FIELD_SEP);
98 2 : HELP0(" -H, --html HTML table output mode\n");
99 2 : HELP0(" -P, --pset=VAR[=ARG] set printing option VAR to ARG (see \\pset command)\n");
100 2 : HELP0(" -R, --record-separator=STRING\n"
101 : " record separator for unaligned output (default: newline)\n");
102 2 : HELP0(" -t, --tuples-only print rows only\n");
103 2 : HELP0(" -T, --table-attr=TEXT set HTML table tag attributes (e.g., width, border)\n");
104 2 : HELP0(" -x, --expanded turn on expanded table output\n");
105 2 : HELP0(" -z, --field-separator-zero\n"
106 : " set field separator for unaligned output to zero byte\n");
107 2 : HELP0(" -0, --record-separator-zero\n"
108 : " set record separator for unaligned output to zero byte\n");
109 :
110 2 : HELP0("\nConnection options:\n");
111 2 : HELP0(" -h, --host=HOSTNAME database server host or socket directory\n");
112 2 : HELP0(" -p, --port=PORT database server port\n");
113 2 : HELP0(" -U, --username=USERNAME database user name\n");
114 2 : HELP0(" -w, --no-password never prompt for password\n");
115 2 : HELP0(" -W, --password force password prompt (should happen automatically)\n");
116 :
117 2 : 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 2 : HELPN("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
121 2 : HELPN("%s home page: <%s>\n", PACKAGE_NAME, PACKAGE_URL);
122 :
123 : /* Now we can count the lines. */
124 2 : nlcount = 0;
125 6208 : for (const char *ptr = buf.data; *ptr; ptr++)
126 : {
127 6206 : if (*ptr == '\n')
128 126 : nlcount++;
129 : }
130 :
131 : /* And dump the output, with appropriate pagination. */
132 2 : output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
133 :
134 2 : fputs(buf.data, output);
135 :
136 2 : ClosePager(output);
137 :
138 2 : termPQExpBuffer(&buf);
139 2 : }
140 :
141 :
142 : /*
143 : * slashUsage
144 : *
145 : * print out help for the backslash commands
146 : */
147 : void
148 2 : slashUsage(unsigned short int pager)
149 : {
150 : PQExpBufferData buf;
151 : int nlcount;
152 : FILE *output;
153 : char *currdb;
154 :
155 2 : 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 : */
161 2 : initPQExpBuffer(&buf);
162 :
163 2 : HELP0("General\n");
164 2 : HELP0(" \\bind [PARAM]... set query parameters\n");
165 2 : HELP0(" \\bind_named STMT_NAME [PARAM]...\n"
166 : " set query parameters for an existing prepared statement\n");
167 2 : HELP0(" \\close STMT_NAME close an existing prepared statement\n");
168 2 : HELP0(" \\copyright show PostgreSQL usage and distribution terms\n");
169 2 : HELP0(" \\crosstabview [COLUMNS] execute query and display result in crosstab\n");
170 2 : HELP0(" \\endpipeline exit pipeline mode\n");
171 2 : HELP0(" \\errverbose show most recent error message at maximum verbosity\n");
172 2 : HELP0(" \\flush push unsent data to the server\n");
173 2 : HELP0(" \\flushrequest send a flushrequest command\n");
174 2 : HELP0(" \\g [(OPTIONS)] [FILE] execute query (and send result to file or |pipe);\n"
175 : " \\g with no arguments is equivalent to a semicolon\n");
176 2 : HELP0(" \\gdesc describe result of query, without executing it\n");
177 2 : HELP0(" \\getresults [NUM_RES] read NUM_RES pending results. All pending results are\n"
178 : " read if no argument is provided\n");
179 2 : HELP0(" \\gexec execute query, then execute each value in its result\n");
180 2 : HELP0(" \\gset [PREFIX] execute query and store result in psql variables\n");
181 2 : HELP0(" \\gx [(OPTIONS)] [FILE] as \\g, but forces expanded output mode\n");
182 2 : HELP0(" \\parse STMT_NAME create a prepared statement\n");
183 2 : HELP0(" \\q quit psql\n");
184 2 : HELP0(" \\sendpipeline send an extended query to an ongoing pipeline\n");
185 2 : HELP0(" \\startpipeline enter pipeline mode\n");
186 2 : HELP0(" \\syncpipeline add a synchronisation point to an ongoing pipeline\n");
187 2 : HELP0(" \\watch [[i=]SEC] [c=N] [m=MIN]\n"
188 : " execute query every SEC seconds, up to N times,\n"
189 : " stop if less than MIN rows are returned\n");
190 2 : HELP0("\n");
191 :
192 2 : HELP0("Help\n");
193 :
194 2 : HELP0(" \\? [commands] show help on backslash commands\n");
195 2 : HELP0(" \\? options show help on psql command-line options\n");
196 2 : HELP0(" \\? variables show help on special variables\n");
197 2 : HELP0(" \\h [NAME] help on syntax of SQL commands, * for all commands\n");
198 2 : HELP0("\n");
199 :
200 2 : HELP0("Query Buffer\n");
201 2 : HELP0(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n");
202 2 : HELP0(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n");
203 2 : HELP0(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n");
204 2 : HELP0(" \\p show the contents of the query buffer\n");
205 2 : HELP0(" \\r reset (clear) the query buffer\n");
206 : #ifdef USE_READLINE
207 2 : HELP0(" \\s [FILE] display history or save it to file\n");
208 : #endif
209 2 : HELP0(" \\w FILE write query buffer to file\n");
210 2 : HELP0("\n");
211 :
212 2 : HELP0("Input/Output\n");
213 2 : HELP0(" \\copy ... perform SQL COPY with data stream to the client host\n");
214 2 : HELP0(" \\echo [-n] [STRING] write string to standard output (-n for no newline)\n");
215 2 : HELP0(" \\i FILE execute commands from file\n");
216 2 : HELP0(" \\ir FILE as \\i, but relative to location of current script\n");
217 2 : HELP0(" \\o [FILE] send all query results to file or |pipe\n");
218 2 : HELP0(" \\qecho [-n] [STRING] write string to \\o output stream (-n for no newline)\n");
219 2 : HELP0(" \\warn [-n] [STRING] write string to standard error (-n for no newline)\n");
220 2 : HELP0("\n");
221 :
222 2 : HELP0("Conditional\n");
223 2 : HELP0(" \\if EXPR begin conditional block\n");
224 2 : HELP0(" \\elif EXPR alternative within current conditional block\n");
225 2 : HELP0(" \\else final alternative within current conditional block\n");
226 2 : HELP0(" \\endif end conditional block\n");
227 2 : HELP0("\n");
228 :
229 2 : HELP0("Informational\n");
230 2 : HELP0(" (options: S = show system objects, x = expanded mode, + = additional detail)\n");
231 2 : HELP0(" \\d[Sx+] list tables, views, and sequences\n");
232 2 : HELP0(" \\d[S+] NAME describe table, view, sequence, or index\n");
233 2 : HELP0(" \\da[Sx] [PATTERN] list aggregates\n");
234 2 : HELP0(" \\dA[x+] [PATTERN] list access methods\n");
235 2 : HELP0(" \\dAc[x+] [AMPTRN [TYPEPTRN]] list operator classes\n");
236 2 : HELP0(" \\dAf[x+] [AMPTRN [TYPEPTRN]] list operator families\n");
237 2 : HELP0(" \\dAo[x+] [AMPTRN [OPFPTRN]] list operators of operator families\n");
238 2 : HELP0(" \\dAp[x+] [AMPTRN [OPFPTRN]] list support functions of operator families\n");
239 2 : HELP0(" \\db[x+] [PATTERN] list tablespaces\n");
240 2 : HELP0(" \\dc[Sx+] [PATTERN] list conversions\n");
241 2 : HELP0(" \\dconfig[x+] [PATTERN] list configuration parameters\n");
242 2 : HELP0(" \\dC[x+] [PATTERN] list casts\n");
243 2 : HELP0(" \\dd[Sx] [PATTERN] show object descriptions not displayed elsewhere\n");
244 2 : HELP0(" \\dD[Sx+] [PATTERN] list domains\n");
245 2 : HELP0(" \\ddp[x] [PATTERN] list default privileges\n");
246 2 : HELP0(" \\dE[Sx+] [PATTERN] list foreign tables\n");
247 2 : HELP0(" \\des[x+] [PATTERN] list foreign servers\n");
248 2 : HELP0(" \\det[x+] [PATTERN] list foreign tables\n");
249 2 : HELP0(" \\deu[x+] [PATTERN] list user mappings\n");
250 2 : HELP0(" \\dew[x+] [PATTERN] list foreign-data wrappers\n");
251 2 : HELP0(" \\df[anptw][Sx+] [FUNCPTRN [TYPEPTRN ...]]\n"
252 : " list [only agg/normal/procedure/trigger/window] functions\n");
253 2 : HELP0(" \\dF[x+] [PATTERN] list text search configurations\n");
254 2 : HELP0(" \\dFd[x+] [PATTERN] list text search dictionaries\n");
255 2 : HELP0(" \\dFp[x+] [PATTERN] list text search parsers\n");
256 2 : HELP0(" \\dFt[x+] [PATTERN] list text search templates\n");
257 2 : HELP0(" \\dg[Sx+] [PATTERN] list roles\n");
258 2 : HELP0(" \\di[Sx+] [PATTERN] list indexes\n");
259 2 : HELP0(" \\dl[x+] list large objects, same as \\lo_list\n");
260 2 : HELP0(" \\dL[Sx+] [PATTERN] list procedural languages\n");
261 2 : HELP0(" \\dm[Sx+] [PATTERN] list materialized views\n");
262 2 : HELP0(" \\dn[Sx+] [PATTERN] list schemas\n");
263 2 : HELP0(" \\do[Sx+] [OPPTRN [TYPEPTRN [TYPEPTRN]]]\n"
264 : " list operators\n");
265 2 : HELP0(" \\dO[Sx+] [PATTERN] list collations\n");
266 2 : HELP0(" \\dp[Sx] [PATTERN] list table, view, and sequence access privileges\n");
267 2 : HELP0(" \\dP[itnx+] [PATTERN] list [only index/table] partitioned relations [n=nested]\n");
268 2 : HELP0(" \\drds[x] [ROLEPTRN [DBPTRN]] list per-database role settings\n");
269 2 : HELP0(" \\drg[Sx] [PATTERN] list role grants\n");
270 2 : HELP0(" \\dRp[x+] [PATTERN] list replication publications\n");
271 2 : HELP0(" \\dRs[x+] [PATTERN] list replication subscriptions\n");
272 2 : HELP0(" \\ds[Sx+] [PATTERN] list sequences\n");
273 2 : HELP0(" \\dt[Sx+] [PATTERN] list tables\n");
274 2 : HELP0(" \\dT[Sx+] [PATTERN] list data types\n");
275 2 : HELP0(" \\du[Sx+] [PATTERN] list roles\n");
276 2 : HELP0(" \\dv[Sx+] [PATTERN] list views\n");
277 2 : HELP0(" \\dx[x+] [PATTERN] list extensions\n");
278 2 : HELP0(" \\dX[x] [PATTERN] list extended statistics\n");
279 2 : HELP0(" \\dy[x+] [PATTERN] list event triggers\n");
280 2 : HELP0(" \\l[x+] [PATTERN] list databases\n");
281 2 : HELP0(" \\sf[+] FUNCNAME show a function's definition\n");
282 2 : HELP0(" \\sv[+] VIEWNAME show a view's definition\n");
283 2 : HELP0(" \\z[Sx] [PATTERN] same as \\dp\n");
284 2 : HELP0("\n");
285 :
286 2 : HELP0("Large Objects\n");
287 2 : HELP0(" \\lo_export LOBOID FILE write large object to file\n");
288 2 : HELP0(" \\lo_import FILE [COMMENT]\n"
289 : " read large object from file\n");
290 2 : HELP0(" \\lo_list[x+] list large objects\n");
291 2 : HELP0(" \\lo_unlink LOBOID delete a large object\n");
292 2 : HELP0("\n");
293 :
294 2 : HELP0("Formatting\n");
295 2 : HELP0(" \\a toggle between unaligned and aligned output mode\n");
296 2 : HELP0(" \\C [STRING] set table title, or unset if none\n");
297 2 : HELP0(" \\f [STRING] show or set field separator for unaligned query output\n");
298 2 : HELPN(" \\H toggle HTML output mode (currently %s)\n",
299 : ON(pset.popt.topt.format == PRINT_HTML));
300 2 : HELP0(" \\pset [NAME [VALUE]] set table output option\n"
301 : " (border|columns|csv_fieldsep|expanded|fieldsep|\n"
302 : " fieldsep_zero|footer|format|linestyle|null|\n"
303 : " numericlocale|pager|pager_min_lines|recordsep|\n"
304 : " recordsep_zero|tableattr|title|tuples_only|\n"
305 : " unicode_border_linestyle|unicode_column_linestyle|\n"
306 : " unicode_header_linestyle|xheader_width)\n");
307 2 : HELPN(" \\t [on|off] show only rows (currently %s)\n",
308 : ON(pset.popt.topt.tuples_only));
309 2 : HELP0(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n");
310 2 : HELPN(" \\x [on|off|auto] toggle expanded output (currently %s)\n",
311 : pset.popt.topt.expanded == 2 ? _("auto") : ON(pset.popt.topt.expanded));
312 2 : HELP0("\n");
313 :
314 2 : HELP0("Connection\n");
315 2 : if (currdb)
316 0 : HELPN(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
317 : " connect to new database (currently \"%s\")\n",
318 : currdb);
319 : else
320 2 : HELP0(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
321 : " connect to new database (currently no connection)\n");
322 2 : HELP0(" \\conninfo display information about current connection\n");
323 2 : HELP0(" \\encoding [ENCODING] show or set client encoding\n");
324 2 : HELP0(" \\password [USERNAME] securely change the password for a user\n");
325 2 : HELP0("\n");
326 :
327 2 : HELP0("Operating System\n");
328 2 : HELP0(" \\cd [DIR] change the current working directory\n");
329 2 : HELP0(" \\getenv PSQLVAR ENVVAR fetch environment variable\n");
330 2 : HELP0(" \\setenv NAME [VALUE] set or unset environment variable\n");
331 2 : HELPN(" \\timing [on|off] toggle timing of commands (currently %s)\n",
332 : ON(pset.timing));
333 2 : HELP0(" \\! [COMMAND] execute command in shell or start interactive shell\n");
334 2 : HELP0("\n");
335 :
336 2 : HELP0("Variables\n");
337 2 : HELP0(" \\prompt [TEXT] NAME prompt user to set internal variable\n");
338 2 : HELP0(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n");
339 2 : HELP0(" \\unset NAME unset (delete) internal variable\n");
340 :
341 : /* Now we can count the lines. */
342 2 : nlcount = 0;
343 15870 : for (const char *ptr = buf.data; *ptr; ptr++)
344 : {
345 15868 : if (*ptr == '\n')
346 310 : nlcount++;
347 : }
348 :
349 : /* And dump the output, with appropriate pagination. */
350 2 : output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
351 :
352 2 : fputs(buf.data, output);
353 :
354 2 : ClosePager(output);
355 :
356 2 : termPQExpBuffer(&buf);
357 2 : }
358 :
359 :
360 : /*
361 : * helpVariables
362 : *
363 : * show list of available variables (options) from command line
364 : */
365 : void
366 2 : helpVariables(unsigned short int pager)
367 : {
368 : PQExpBufferData buf;
369 : int nlcount;
370 : FILE *output;
371 :
372 : /*
373 : * To avoid counting the output lines manually, build the output in "buf"
374 : * and then count them.
375 : */
376 2 : initPQExpBuffer(&buf);
377 :
378 2 : HELP0("List of specially treated variables\n\n");
379 :
380 2 : HELP0("psql variables:\n");
381 2 : HELP0("Usage:\n");
382 2 : HELP0(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n");
383 :
384 2 : HELP0(" AUTOCOMMIT\n"
385 : " if set, successful SQL commands are automatically committed\n");
386 2 : HELP0(" COMP_KEYWORD_CASE\n"
387 : " determines the case used to complete SQL key words\n"
388 : " [lower, upper, preserve-lower, preserve-upper]\n");
389 2 : HELP0(" DBNAME\n"
390 : " the currently connected database name\n");
391 2 : HELP0(" ECHO\n"
392 : " controls what input is written to standard output\n"
393 : " [all, errors, none, queries]\n");
394 2 : HELP0(" ECHO_HIDDEN\n"
395 : " if set, display internal queries executed by backslash commands;\n"
396 : " if set to \"noexec\", just show them without execution\n");
397 2 : HELP0(" ENCODING\n"
398 : " current client character set encoding\n");
399 2 : HELP0(" ERROR\n"
400 : " \"true\" if last query failed, else \"false\"\n");
401 2 : HELP0(" FETCH_COUNT\n"
402 : " the number of result rows to fetch and display at a time (0 = unlimited)\n");
403 2 : HELP0(" HIDE_TABLEAM\n"
404 : " if set, table access methods are not displayed\n");
405 2 : HELP0(" HIDE_TOAST_COMPRESSION\n"
406 : " if set, compression methods are not displayed\n");
407 2 : HELP0(" HISTCONTROL\n"
408 : " controls command history [ignorespace, ignoredups, ignoreboth]\n");
409 2 : HELP0(" HISTFILE\n"
410 : " file name used to store the command history\n");
411 2 : HELP0(" HISTSIZE\n"
412 : " maximum number of commands to store in the command history\n");
413 2 : HELP0(" HOST\n"
414 : " the currently connected database server host\n");
415 2 : HELP0(" IGNOREEOF\n"
416 : " number of EOFs needed to terminate an interactive session\n");
417 2 : HELP0(" LASTOID\n"
418 : " value of the last affected OID\n");
419 2 : HELP0(" LAST_ERROR_MESSAGE\n"
420 : " LAST_ERROR_SQLSTATE\n"
421 : " message and SQLSTATE of last error, or empty string and \"00000\" if none\n");
422 2 : HELP0(" ON_ERROR_ROLLBACK\n"
423 : " if set, an error doesn't stop a transaction (uses implicit savepoints)\n");
424 2 : HELP0(" ON_ERROR_STOP\n"
425 : " stop batch execution after error\n");
426 2 : HELP0(" PORT\n"
427 : " server port of the current connection\n");
428 2 : HELP0(" PROMPT1\n"
429 : " specifies the standard psql prompt\n");
430 2 : HELP0(" PROMPT2\n"
431 : " specifies the prompt used when a statement continues from a previous line\n");
432 2 : HELP0(" PROMPT3\n"
433 : " specifies the prompt used during COPY ... FROM STDIN\n");
434 2 : HELP0(" QUIET\n"
435 : " run quietly (same as -q option)\n");
436 2 : HELP0(" ROW_COUNT\n"
437 : " number of rows returned or affected by last query, or 0\n");
438 2 : HELP0(" SERVER_VERSION_NAME\n"
439 : " SERVER_VERSION_NUM\n"
440 : " server's version (in short string or numeric format)\n");
441 2 : HELP0(" SHELL_ERROR\n"
442 : " \"true\" if the last shell command failed, \"false\" if it succeeded\n");
443 2 : HELP0(" SHELL_EXIT_CODE\n"
444 : " exit status of the last shell command\n");
445 2 : HELP0(" SHOW_ALL_RESULTS\n"
446 : " show all results of a combined query (\\;) instead of only the last\n");
447 2 : HELP0(" SHOW_CONTEXT\n"
448 : " controls display of message context fields [never, errors, always]\n");
449 2 : HELP0(" SINGLELINE\n"
450 : " if set, end of line terminates SQL commands (same as -S option)\n");
451 2 : HELP0(" SINGLESTEP\n"
452 : " single-step mode (same as -s option)\n");
453 2 : HELP0(" SQLSTATE\n"
454 : " SQLSTATE of last query, or \"00000\" if no error\n");
455 2 : HELP0(" USER\n"
456 : " the currently connected database user\n");
457 2 : HELP0(" VERBOSITY\n"
458 : " controls verbosity of error reports [default, verbose, terse, sqlstate]\n");
459 2 : HELP0(" VERSION\n"
460 : " VERSION_NAME\n"
461 : " VERSION_NUM\n"
462 : " psql's version (in verbose string, short string, or numeric format)\n");
463 2 : HELP0(" WATCH_INTERVAL\n"
464 : " number of seconds \\watch by default waits between executing the query buffer\n");
465 :
466 2 : HELP0("\nDisplay settings:\n");
467 2 : HELP0("Usage:\n");
468 2 : HELP0(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n");
469 :
470 2 : HELP0(" border\n"
471 : " border style (number)\n");
472 2 : HELP0(" columns\n"
473 : " target width for the wrapped format\n");
474 2 : HELP0(" expanded (or x)\n"
475 : " expanded output [on, off, auto]\n");
476 2 : HELPN(" fieldsep\n"
477 : " field separator for unaligned output (default \"%s\")\n",
478 : DEFAULT_FIELD_SEP);
479 2 : HELP0(" fieldsep_zero\n"
480 : " set field separator for unaligned output to a zero byte\n");
481 2 : HELP0(" footer\n"
482 : " enable or disable display of the table footer [on, off]\n");
483 2 : HELP0(" format\n"
484 : " set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n");
485 2 : HELP0(" linestyle\n"
486 : " set the border line drawing style [ascii, old-ascii, unicode]\n");
487 2 : HELP0(" null\n"
488 : " set the string to be printed in place of a null value\n");
489 2 : HELP0(" numericlocale\n"
490 : " enable display of a locale-specific character to separate groups of digits\n");
491 2 : HELP0(" pager\n"
492 : " control when an external pager is used [yes, no, always]\n");
493 2 : HELP0(" recordsep\n"
494 : " record (line) separator for unaligned output\n");
495 2 : HELP0(" recordsep_zero\n"
496 : " set record separator for unaligned output to a zero byte\n");
497 2 : HELP0(" tableattr (or T)\n"
498 : " specify attributes for table tag in html format, or proportional\n"
499 : " column widths for left-aligned data types in latex-longtable format\n");
500 2 : HELP0(" title\n"
501 : " set the table title for subsequently printed tables\n");
502 2 : HELP0(" tuples_only\n"
503 : " if set, only actual table data is shown\n");
504 2 : HELP0(" unicode_border_linestyle\n"
505 : " unicode_column_linestyle\n"
506 : " unicode_header_linestyle\n"
507 : " set the style of Unicode line drawing [single, double]\n");
508 2 : HELP0(" xheader_width\n"
509 : " set the maximum width of the header for expanded output\n"
510 : " [full, column, page, integer value]\n");
511 :
512 2 : HELP0("\nEnvironment variables:\n");
513 2 : HELP0("Usage:\n");
514 :
515 : #ifndef WIN32
516 2 : HELP0(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
517 : #else
518 : HELP0(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");
519 : #endif
520 :
521 2 : HELP0(" COLUMNS\n"
522 : " number of columns for wrapped format\n");
523 2 : HELP0(" PGAPPNAME\n"
524 : " same as the application_name connection parameter\n");
525 2 : HELP0(" PGDATABASE\n"
526 : " same as the dbname connection parameter\n");
527 2 : HELP0(" PGHOST\n"
528 : " same as the host connection parameter\n");
529 2 : HELP0(" PGPASSFILE\n"
530 : " password file name\n");
531 2 : HELP0(" PGPASSWORD\n"
532 : " connection password (not recommended)\n");
533 2 : HELP0(" PGPORT\n"
534 : " same as the port connection parameter\n");
535 2 : HELP0(" PGUSER\n"
536 : " same as the user connection parameter\n");
537 2 : HELP0(" PSQL_EDITOR, EDITOR, VISUAL\n"
538 : " editor used by the \\e, \\ef, and \\ev commands\n");
539 2 : HELP0(" PSQL_EDITOR_LINENUMBER_ARG\n"
540 : " how to specify a line number when invoking the editor\n");
541 2 : HELP0(" PSQL_HISTORY\n"
542 : " alternative location for the command history file\n");
543 2 : HELP0(" PSQL_PAGER, PAGER\n"
544 : " name of external pager program\n");
545 : #ifndef WIN32
546 2 : HELP0(" PSQL_WATCH_PAGER\n"
547 : " name of external pager program used for \\watch\n");
548 : #endif
549 2 : HELP0(" PSQLRC\n"
550 : " alternative location for the user's .psqlrc file\n");
551 2 : HELP0(" SHELL\n"
552 : " shell used by the \\! command\n");
553 2 : HELP0(" TMPDIR\n"
554 : " directory for temporary files\n");
555 :
556 : /* Now we can count the lines. */
557 2 : nlcount = 0;
558 10936 : for (const char *ptr = buf.data; *ptr; ptr++)
559 : {
560 10934 : if (*ptr == '\n')
561 344 : nlcount++;
562 : }
563 :
564 : /* And dump the output, with appropriate pagination. */
565 2 : output = PageOutput(nlcount, pager ? &(pset.popt.topt) : NULL);
566 :
567 2 : fputs(buf.data, output);
568 :
569 2 : ClosePager(output);
570 :
571 2 : termPQExpBuffer(&buf);
572 2 : }
573 :
574 :
575 : /*
576 : * helpSQL -- help with SQL commands
577 : *
578 : * Note: we assume caller removed any trailing spaces in "topic".
579 : */
580 : void
581 4 : helpSQL(const char *topic, unsigned short int pager)
582 : {
583 : #define VALUE_OR_NULL(a) ((a) ? (a) : "")
584 :
585 4 : if (!topic || strlen(topic) == 0)
586 2 : {
587 : /* Print all the available command names */
588 : int screen_width;
589 : int ncolumns;
590 : int nrows;
591 : FILE *output;
592 : int i;
593 : int j;
594 :
595 : /* Find screen width to determine how many columns will fit */
596 : #ifdef TIOCGWINSZ
597 : struct winsize screen_size;
598 :
599 2 : if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)
600 2 : screen_width = 80; /* ioctl failed, assume 80 */
601 : else
602 0 : screen_width = screen_size.ws_col;
603 : #else
604 : screen_width = 80; /* default assumption */
605 : #endif
606 :
607 2 : ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);
608 2 : ncolumns = Max(ncolumns, 1);
609 2 : nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;
610 :
611 2 : output = PageOutput(nrows + 1, pager ? &(pset.popt.topt) : NULL);
612 :
613 2 : fputs(_("Available help:\n"), output);
614 :
615 188 : for (i = 0; i < nrows; i++)
616 : {
617 186 : fprintf(output, " ");
618 372 : for (j = 0; j < ncolumns - 1; j++)
619 186 : fprintf(output, "%-*s",
620 : QL_MAX_CMD_LEN + 1,
621 186 : VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
622 186 : if (i + j * nrows < QL_HELP_COUNT)
623 184 : fprintf(output, "%s",
624 184 : VALUE_OR_NULL(QL_HELP[i + j * nrows].cmd));
625 186 : fputc('\n', output);
626 : }
627 :
628 2 : ClosePager(output);
629 : }
630 : else
631 : {
632 : int i,
633 : pass;
634 2 : FILE *output = NULL;
635 : size_t len,
636 : wordlen,
637 : j;
638 : int nl_count;
639 :
640 : /*
641 : * len is the amount of the input to compare to the help topic names.
642 : * We first try exact match, then first + second words, then first
643 : * word only.
644 : */
645 2 : len = strlen(topic);
646 :
647 2 : for (pass = 1; pass <= 3; pass++)
648 : {
649 2 : if (pass > 1) /* Nothing on first pass - try the opening
650 : * word(s) */
651 : {
652 0 : wordlen = j = 1;
653 0 : while (j < len && topic[j++] != ' ')
654 0 : wordlen++;
655 0 : if (pass == 2 && j < len)
656 : {
657 0 : wordlen++;
658 0 : while (j < len && topic[j++] != ' ')
659 0 : wordlen++;
660 : }
661 0 : if (wordlen >= len)
662 : {
663 : /* Failed to shorten input, so try next pass if any */
664 0 : continue;
665 : }
666 0 : len = wordlen;
667 : }
668 :
669 : /*
670 : * Count newlines for pager. This logic must agree with what the
671 : * following loop will do!
672 : */
673 2 : nl_count = 0;
674 340 : for (i = 0; QL_HELP[i].cmd; i++)
675 : {
676 340 : if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
677 338 : strcmp(topic, "*") == 0)
678 : {
679 : /* magic constant here must match format below! */
680 2 : nl_count += 7 + QL_HELP[i].nl_count;
681 :
682 : /* If we have an exact match, exit. Fixes \h SELECT */
683 2 : if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
684 2 : break;
685 : }
686 : }
687 : /* If no matches, don't open the output yet */
688 2 : if (nl_count == 0)
689 0 : continue;
690 :
691 2 : if (!output)
692 2 : output = PageOutput(nl_count, pager ? &(pset.popt.topt) : NULL);
693 :
694 340 : for (i = 0; QL_HELP[i].cmd; i++)
695 : {
696 340 : if (pg_strncasecmp(topic, QL_HELP[i].cmd, len) == 0 ||
697 338 : strcmp(topic, "*") == 0)
698 : {
699 : PQExpBufferData buffer;
700 : char *url;
701 :
702 2 : initPQExpBuffer(&buffer);
703 2 : QL_HELP[i].syntaxfunc(&buffer);
704 2 : url = psprintf("https://www.postgresql.org/docs/%s/%s.html",
705 : strstr(PG_VERSION, "devel") ? "devel" : PG_MAJORVERSION,
706 : QL_HELP[i].docbook_id);
707 : /* # of newlines in format must match constant above! */
708 2 : fprintf(output, _("Command: %s\n"
709 : "Description: %s\n"
710 : "Syntax:\n%s\n\n"
711 : "URL: %s\n\n"),
712 : QL_HELP[i].cmd,
713 : _(QL_HELP[i].help),
714 : buffer.data,
715 : url);
716 2 : free(url);
717 2 : termPQExpBuffer(&buffer);
718 :
719 : /* If we have an exact match, exit. Fixes \h SELECT */
720 2 : if (pg_strcasecmp(topic, QL_HELP[i].cmd) == 0)
721 2 : break;
722 : }
723 : }
724 2 : break;
725 : }
726 :
727 : /* If we never found anything, report that */
728 2 : if (!output)
729 : {
730 0 : output = PageOutput(2, pager ? &(pset.popt.topt) : NULL);
731 0 : fprintf(output, _("No help available for \"%s\".\n"
732 : "Try \\h with no arguments to see available help.\n"),
733 : topic);
734 : }
735 :
736 2 : ClosePager(output);
737 : }
738 4 : }
739 :
740 :
741 :
742 : void
743 2 : print_copyright(void)
744 : {
745 2 : puts("PostgreSQL Database Management System\n"
746 : "(formerly known as Postgres, then as Postgres95)\n\n"
747 : "Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group\n\n"
748 : "Portions Copyright (c) 1994, The Regents of the University of California\n\n"
749 : "Permission to use, copy, modify, and distribute this software and its\n"
750 : "documentation for any purpose, without fee, and without a written agreement\n"
751 : "is hereby granted, provided that the above copyright notice and this\n"
752 : "paragraph and the following two paragraphs appear in all copies.\n\n"
753 : "IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"
754 : "DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"
755 : "LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"
756 : "DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"
757 : "POSSIBILITY OF SUCH DAMAGE.\n\n"
758 : "THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"
759 : "INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"
760 : "AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"
761 : "ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"
762 : "PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n");
763 2 : }
|
