help.c Source File (original) (raw)

10#ifndef WIN32

11#include <unistd.h>

12#else

13#include <win32.h>

14#endif

16#ifndef WIN32

17#include <sys/ioctl.h>

18#endif

20#ifdef HAVE_TERMIOS_H

21#include <termios.h>

22#endif

27#include "sql_help.h"

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

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

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

47void

48 usage(unsigned short int pager)

49{

51 int nlcount;

60 HELP0("psql is the PostgreSQL interactive terminal.\n\n");

61 HELP0("Usage:\n");

62 HELP0(" psql [OPTION]... [DBNAME [USERNAME]]\n\n");

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");

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");

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

124 nlcount = 0;

125 for (const char *ptr = buf.data; *ptr; ptr++)

126 {

127 if (*ptr == '\n')

128 nlcount++;

129 }

130

131

133

135

137

139}

140

141

142

143

144

145

146

147void

149{

151 int nlcount;

153 char *currdb;

154

156

157

158

159

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(" \\watch [[i=]SEC] [c=N] [m=MIN]\n"

175 " execute query every SEC seconds, up to N times,\n"

176 " stop if less than MIN rows are returned\n");

178

180

181 HELP0(" \\? [commands] show help on backslash commands\n");

182 HELP0(" \\? options show help on psql command-line options\n");

183 HELP0(" \\? variables show help on special variables\n");

184 HELP0(" \\h [NAME] help on syntax of SQL commands, * for all commands\n");

186

187 HELP0("Query Buffer\n");

188 HELP0(" \\e [FILE] [LINE] edit the query buffer (or file) with external editor\n");

189 HELP0(" \\ef [FUNCNAME [LINE]] edit function definition with external editor\n");

190 HELP0(" \\ev [VIEWNAME [LINE]] edit view definition with external editor\n");

191 HELP0(" \\p show the contents of the query buffer\n");

192 HELP0(" \\r reset (clear) the query buffer\n");

193#ifdef USE_READLINE

194 HELP0(" \\s [FILE] display history or save it to file\n");

195#endif

196 HELP0(" \\w FILE write query buffer to file\n");

198

199 HELP0("Input/Output\n");

200 HELP0(" \\copy ... perform SQL COPY with data stream to the client host\n");

201 HELP0(" \\echo [-n] [STRING] write string to standard output (-n for no newline)\n");

202 HELP0(" \\i FILE execute commands from file\n");

203 HELP0(" \\ir FILE as \\i, but relative to location of current script\n");

204 HELP0(" \\o [FILE] send all query results to file or |pipe\n");

205 HELP0(" \\qecho [-n] [STRING] write string to \\o output stream (-n for no newline)\n");

206 HELP0(" \\warn [-n] [STRING] write string to standard error (-n for no newline)\n");

208

209 HELP0("Conditional\n");

210 HELP0(" \\if EXPR begin conditional block\n");

211 HELP0(" \\elif EXPR alternative within current conditional block\n");

212 HELP0(" \\else final alternative within current conditional block\n");

213 HELP0(" \\endif end conditional block\n");

215

216 HELP0("Informational\n");

217 HELP0(" (options: S = show system objects, x = expanded mode, + = additional detail)\n");

218 HELP0(" \\d[Sx+] list tables, views, and sequences\n");

219 HELP0(" \\d[S+] NAME describe table, view, sequence, or index\n");

220 HELP0(" \\da[Sx] [PATTERN] list aggregates\n");

221 HELP0(" \\dA[x+] [PATTERN] list access methods\n");

222 HELP0(" \\dAc[x+] [AMPTRN [TYPEPTRN]] list operator classes\n");

223 HELP0(" \\dAf[x+] [AMPTRN [TYPEPTRN]] list operator families\n");

224 HELP0(" \\dAo[x+] [AMPTRN [OPFPTRN]] list operators of operator families\n");

225 HELP0(" \\dAp[x+] [AMPTRN [OPFPTRN]] list support functions of operator families\n");

226 HELP0(" \\db[x+] [PATTERN] list tablespaces\n");

227 HELP0(" \\dc[Sx+] [PATTERN] list conversions\n");

228 HELP0(" \\dconfig[x+] [PATTERN] list configuration parameters\n");

229 HELP0(" \\dC[x+] [PATTERN] list casts\n");

230 HELP0(" \\dd[Sx] [PATTERN] show object descriptions not displayed elsewhere\n");

231 HELP0(" \\dD[Sx+] [PATTERN] list domains\n");

232 HELP0(" \\ddp[x] [PATTERN] list default privileges\n");

233 HELP0(" \\dE[Sx+] [PATTERN] list foreign tables\n");

234 HELP0(" \\des[x+] [PATTERN] list foreign servers\n");

235 HELP0(" \\det[x+] [PATTERN] list foreign tables\n");

236 HELP0(" \\deu[x+] [PATTERN] list user mappings\n");

237 HELP0(" \\dew[x+] [PATTERN] list foreign-data wrappers\n");

238 HELP0(" \\df[anptw][Sx+] [FUNCPTRN [TYPEPTRN ...]]\n"

239 " list [only agg/normal/procedure/trigger/window] functions\n");

240 HELP0(" \\dF[x+] [PATTERN] list text search configurations\n");

241 HELP0(" \\dFd[x+] [PATTERN] list text search dictionaries\n");

242 HELP0(" \\dFp[x+] [PATTERN] list text search parsers\n");

243 HELP0(" \\dFt[x+] [PATTERN] list text search templates\n");

244 HELP0(" \\dg[Sx+] [PATTERN] list roles\n");

245 HELP0(" \\di[Sx+] [PATTERN] list indexes\n");

246 HELP0(" \\dl[x+] list large objects, same as \\lo_list\n");

247 HELP0(" \\dL[Sx+] [PATTERN] list procedural languages\n");

248 HELP0(" \\dm[Sx+] [PATTERN] list materialized views\n");

249 HELP0(" \\dn[Sx+] [PATTERN] list schemas\n");

250 HELP0(" \\do[Sx+] [OPPTRN [TYPEPTRN [TYPEPTRN]]]\n"

251 " list operators\n");

252 HELP0(" \\dO[Sx+] [PATTERN] list collations\n");

253 HELP0(" \\dp[Sx] [PATTERN] list table, view, and sequence access privileges\n");

254 HELP0(" \\dP[itnx+] [PATTERN] list [only index/table] partitioned relations [n=nested]\n");

255 HELP0(" \\drds[x] [ROLEPTRN [DBPTRN]] list per-database role settings\n");

256 HELP0(" \\drg[Sx] [PATTERN] list role grants\n");

257 HELP0(" \\dRp[x+] [PATTERN] list replication publications\n");

258 HELP0(" \\dRs[x+] [PATTERN] list replication subscriptions\n");

259 HELP0(" \\ds[Sx+] [PATTERN] list sequences\n");

260 HELP0(" \\dt[Sx+] [PATTERN] list tables\n");

261 HELP0(" \\dT[Sx+] [PATTERN] list data types\n");

262 HELP0(" \\du[Sx+] [PATTERN] list roles\n");

263 HELP0(" \\dv[Sx+] [PATTERN] list views\n");

264 HELP0(" \\dx[x+] [PATTERN] list extensions\n");

265 HELP0(" \\dX[x] [PATTERN] list extended statistics\n");

266 HELP0(" \\dy[x+] [PATTERN] list event triggers\n");

267 HELP0(" \\l[x+] [PATTERN] list databases\n");

268 HELP0(" \\sf[+] FUNCNAME show a function's definition\n");

269 HELP0(" \\sv[+] VIEWNAME show a view's definition\n");

270 HELP0(" \\z[Sx] [PATTERN] same as \\dp\n");

272

273 HELP0("Large Objects\n");

274 HELP0(" \\lo_export LOBOID FILE write large object to file\n");

275 HELP0(" \\lo_import FILE [COMMENT]\n"

276 " read large object from file\n");

277 HELP0(" \\lo_list[x+] list large objects\n");

278 HELP0(" \\lo_unlink LOBOID delete a large object\n");

280

281 HELP0("Formatting\n");

282 HELP0(" \\a toggle between unaligned and aligned output mode\n");

283 HELP0(" \\C [STRING] set table title, or unset if none\n");

284 HELP0(" \\f [STRING] show or set field separator for unaligned query output\n");

285 HELPN(" \\H toggle HTML output mode (currently %s)\n",

287 HELP0(" \\pset [NAME [VALUE]] set table output option\n"

290 " numericlocale|pager|pager_min_lines|recordsep|\n"

291 " recordsep_zero|tableattr|title|tuples_only|\n"

292 " unicode_border_linestyle|unicode_column_linestyle|\n"

293 " unicode_header_linestyle|xheader_width)\n");

294 HELPN(" \\t [on|off] show only rows (currently %s)\n",

296 HELP0(" \\T [STRING] set HTML

tag attributes, or unset if none\n");

297 HELPN(" \\x [on|off|auto] toggle expanded output (currently %s)\n",

300

301 HELP0("Connection\n");

302 if (currdb)

303 HELPN(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"

304 " connect to new database (currently \"%s\")\n",

305 currdb);

306 else

307 HELP0(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"

308 " connect to new database (currently no connection)\n");

309 HELP0(" \\conninfo display information about current connection\n");

310 HELP0(" \\encoding [ENCODING] show or set client encoding\n");

311 HELP0(" \\password [USERNAME] securely change the password for a user\n");

313

314 HELP0("Operating System\n");

315 HELP0(" \\cd [DIR] change the current working directory\n");

316 HELP0(" \\getenv PSQLVAR ENVVAR fetch environment variable\n");

317 HELP0(" \\setenv NAME [VALUE] set or unset environment variable\n");

318 HELPN(" \\timing [on|off] toggle timing of commands (currently %s)\n",

320 HELP0(" \\! [COMMAND] execute command in shell or start interactive shell\n");

322

323 HELP0("Variables\n");

324 HELP0(" \\prompt [TEXT] NAME prompt user to set internal variable\n");

325 HELP0(" \\set [NAME [VALUE]] set internal variable, or list all if no parameters\n");

326 HELP0(" \\unset NAME unset (delete) internal variable\n");

328

329 HELP0("Extended Query Protocol\n");

330 HELP0(" \\bind [PARAM]... set query parameters\n");

331 HELP0(" \\bind_named STMT_NAME [PARAM]...\n"

332 " set query parameters for an existing prepared statement\n");

333 HELP0(" \\close STMT_NAME close an existing prepared statement\n");

334 HELP0(" \\endpipeline exit pipeline mode\n");

335 HELP0(" \\flush flush output data to the server\n");

336 HELP0(" \\flushrequest send request to the server to flush its output buffer\n");

337 HELP0(" \\getresults [NUM_RES] read NUM_RES pending results. All pending results are\n"

338 " read if no argument is provided\n");

339 HELP0(" \\parse STMT_NAME create a prepared statement\n");

340 HELP0(" \\sendpipeline send an extended query to an ongoing pipeline\n");

341 HELP0(" \\startpipeline enter pipeline mode\n");

342 HELP0(" \\syncpipeline add a synchronisation point to an ongoing pipeline\n");

343

344

345 nlcount = 0;

346 for (const char *ptr = buf.data; *ptr; ptr++)

347 {

348 if (*ptr == '\n')

349 nlcount++;

350 }

351

352

354

356

358

360}

361

362

363

364

365

366

367

368void

370{

372 int nlcount;

374

375

376

377

378

380

381 HELP0("List of specially treated variables\n\n");

382

383 HELP0("psql variables:\n");

384 HELP0("Usage:\n");

385 HELP0(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n");

386

387 HELP0(" AUTOCOMMIT\n"

388 " if set, successful SQL commands are automatically committed\n");

389 HELP0(" COMP_KEYWORD_CASE\n"

390 " determines the case used to complete SQL key words\n"

391 " [lower, upper, preserve-lower, preserve-upper]\n");

392 HELP0(" DBNAME\n"

393 " the currently connected database name\n");

395 " controls what input is written to standard output\n"

396 " [all, errors, none, queries]\n");

397 HELP0(" ECHO_HIDDEN\n"

398 " if set, display internal queries executed by backslash commands;\n"

399 " if set to \"noexec\", just show them without execution\n");

400 HELP0(" ENCODING\n"

401 " current client character set encoding\n");

403 " \"true\" if last query failed, else \"false\"\n");

404 HELP0(" FETCH_COUNT\n"

405 " the number of result rows to fetch and display at a time (0 = unlimited)\n");

406 HELP0(" HIDE_TABLEAM\n"

407 " if set, table access methods are not displayed\n");

408 HELP0(" HIDE_TOAST_COMPRESSION\n"

409 " if set, compression methods are not displayed\n");

410 HELP0(" HISTCONTROL\n"

411 " controls command history [ignorespace, ignoredups, ignoreboth]\n");

412 HELP0(" HISTFILE\n"

413 " file name used to store the command history\n");

414 HELP0(" HISTSIZE\n"

415 " maximum number of commands to store in the command history\n");

417 " the currently connected database server host\n");

418 HELP0(" IGNOREEOF\n"

419 " number of EOFs needed to terminate an interactive session\n");

420 HELP0(" LASTOID\n"

421 " value of the last affected OID\n");

422 HELP0(" LAST_ERROR_MESSAGE\n"

423 " LAST_ERROR_SQLSTATE\n"

424 " message and SQLSTATE of last error, or empty string and \"00000\" if none\n");

425 HELP0(" ON_ERROR_ROLLBACK\n"

426 " if set, an error doesn't stop a transaction (uses implicit savepoints)\n");

427 HELP0(" ON_ERROR_STOP\n"

428 " stop batch execution after error\n");

430 " server port of the current connection\n");

431 HELP0(" PROMPT1\n"

432 " specifies the standard psql prompt\n");

433 HELP0(" PROMPT2\n"

434 " specifies the prompt used when a statement continues from a previous line\n");

435 HELP0(" PROMPT3\n"

436 " specifies the prompt used during COPY ... FROM STDIN\n");

438 " run quietly (same as -q option)\n");

439 HELP0(" ROW_COUNT\n"

440 " number of rows returned or affected by last query, or 0\n");

441 HELP0(" SERVER_VERSION_NAME\n"

442 " SERVER_VERSION_NUM\n"

443 " server's version (in short string or numeric format)\n");

444 HELP0(" SHELL_ERROR\n"

445 " \"true\" if the last shell command failed, \"false\" if it succeeded\n");

446 HELP0(" SHELL_EXIT_CODE\n"

447 " exit status of the last shell command\n");

448 HELP0(" SHOW_ALL_RESULTS\n"

449 " show all results of a combined query (\\;) instead of only the last\n");

450 HELP0(" SHOW_CONTEXT\n"

451 " controls display of message context fields [never, errors, always]\n");

452 HELP0(" SINGLELINE\n"

453 " if set, end of line terminates SQL commands (same as -S option)\n");

454 HELP0(" SINGLESTEP\n"

455 " single-step mode (same as -s option)\n");

456 HELP0(" SQLSTATE\n"

457 " SQLSTATE of last query, or \"00000\" if no error\n");

459 " the currently connected database user\n");

460 HELP0(" VERBOSITY\n"

461 " controls verbosity of error reports [default, verbose, terse, sqlstate]\n");

462 HELP0(" VERSION\n"

463 " VERSION_NAME\n"

464 " VERSION_NUM\n"

465 " psql's version (in verbose string, short string, or numeric format)\n");

466 HELP0(" WATCH_INTERVAL\n"

467 " if set to a number, overrides the default two second \\watch interval\n");

468

469 HELP0("\nDisplay settings:\n");

470 HELP0("Usage:\n");

471 HELP0(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n");

472

473 HELP0(" border\n"

474 " border style (number)\n");

475 HELP0(" columns\n"

476 " target width for the wrapped format\n");

477 HELP0(" expanded (or x)\n"

478 " expanded output [on, off, auto]\n");

479 HELPN(" fieldsep\n"

480 " field separator for unaligned output (default \"%s\")\n",

482 HELP0(" fieldsep_zero\n"

483 " set field separator for unaligned output to a zero byte\n");

484 HELP0(" footer\n"

485 " enable or disable display of the table footer [on, off]\n");

486 HELP0(" format\n"

487 " set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n");

488 HELP0(" linestyle\n"

489 " set the border line drawing style [ascii, old-ascii, unicode]\n");

491 " set the string to be printed in place of a null value\n");

492 HELP0(" numericlocale\n"

493 " enable display of a locale-specific character to separate groups of digits\n");

495 " control when an external pager is used [yes, no, always]\n");

496 HELP0(" recordsep\n"

497 " record (line) separator for unaligned output\n");

498 HELP0(" recordsep_zero\n"

499 " set record separator for unaligned output to a zero byte\n");

500 HELP0(" tableattr (or T)\n"

501 " specify attributes for table tag in html format, or proportional\n"

502 " column widths for left-aligned data types in latex-longtable format\n");

504 " set the table title for subsequently printed tables\n");

505 HELP0(" tuples_only\n"

506 " if set, only actual table data is shown\n");

507 HELP0(" unicode_border_linestyle\n"

508 " unicode_column_linestyle\n"

509 " unicode_header_linestyle\n"

510 " set the style of Unicode line drawing [single, double]\n");

511 HELP0(" xheader_width\n"

512 " set the maximum width of the header for expanded output\n"

513 " [full, column, page, integer value]\n");

514

515 HELP0("\nEnvironment variables:\n");

516 HELP0("Usage:\n");

517

518#ifndef WIN32

519 HELP0(" NAME=VALUE [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");

520#else

521 HELP0(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n");

522#endif

523

524 HELP0(" COLUMNS\n"

525 " number of columns for wrapped format\n");

526 HELP0(" PGAPPNAME\n"

527 " same as the application_name connection parameter\n");

528 HELP0(" PGDATABASE\n"

529 " same as the dbname connection parameter\n");

530 HELP0(" PGHOST\n"

531 " same as the host connection parameter\n");

532 HELP0(" PGPASSFILE\n"

533 " password file name\n");

534 HELP0(" PGPASSWORD\n"

535 " connection password (not recommended)\n");

536 HELP0(" PGPORT\n"

537 " same as the port connection parameter\n");

538 HELP0(" PGUSER\n"

539 " same as the user connection parameter\n");

540 HELP0(" PSQL_EDITOR, EDITOR, VISUAL\n"

541 " editor used by the \\e, \\ef, and \\ev commands\n");

542 HELP0(" PSQL_EDITOR_LINENUMBER_ARG\n"

543 " how to specify a line number when invoking the editor\n");

544 HELP0(" PSQL_HISTORY\n"

545 " alternative location for the command history file\n");

546 HELP0(" PSQL_PAGER, PAGER\n"

547 " name of external pager program\n");

548#ifndef WIN32

549 HELP0(" PSQL_WATCH_PAGER\n"

550 " name of external pager program used for \\watch\n");

551#endif

552 HELP0(" PSQLRC\n"

553 " alternative location for the user's .psqlrc file\n");

555 " shell used by the \\! command\n");

556 HELP0(" TMPDIR\n"

557 " directory for temporary files\n");

558

559

560 nlcount = 0;

561 for (const char *ptr = buf.data; *ptr; ptr++)

562 {

563 if (*ptr == '\n')

564 nlcount++;

565 }

566

567

569

571

573

575}

576

577

578

579

580

581

582

583void

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

585{

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

587

588 if (!topic || strlen(topic) == 0)

589 {

590

591 int screen_width;

592 int ncolumns;

593 int nrows;

595 int i;

596 int j;

597

598

599#ifdef TIOCGWINSZ

600 struct winsize screen_size;

601

602 if (ioctl(fileno(stdout), TIOCGWINSZ, &screen_size) == -1)

603 screen_width = 80;

604 else

605 screen_width = screen_size.ws_col;

606#else

607 screen_width = 80;

608#endif

609

610 ncolumns = (screen_width - 3) / (QL_MAX_CMD_LEN + 1);

611 ncolumns = Max(ncolumns, 1);

612 nrows = (QL_HELP_COUNT + (ncolumns - 1)) / ncolumns;

613

615

616 fputs(_("Available help:\n"), output);

617

618 for (i = 0; i < nrows; i++)

619 {

621 for (j = 0; j < ncolumns - 1; j++)

623 QL_MAX_CMD_LEN + 1,

625 if (i + j * nrows < QL_HELP_COUNT)

629 }

630

632 }

633 else

634 {

635 int i,

636 pass;

638 size_t len,

639 wordlen,

640 j;

641 int nl_count;

642

643

644

645

646

647

648 len = strlen(topic);

649

650 for (pass = 1; pass <= 3; pass++)

651 {

652 if (pass > 1)

653

654 {

655 wordlen = j = 1;

656 while (j < len && topic[j++] != ' ')

657 wordlen++;

658 if (pass == 2 && j < len)

659 {

660 wordlen++;

661 while (j < len && topic[j++] != ' ')

662 wordlen++;

663 }

664 if (wordlen >= len)

665 {

666

667 continue;

668 }

669 len = wordlen;

670 }

671

672

673

674

675

676 nl_count = 0;

677 for (i = 0; QL_HELP[i].cmd; i++)

678 {

680 strcmp(topic, "*") == 0)

681 {

682

683 nl_count += 7 + QL_HELP[i].nl_count;

684

685

687 break;

688 }

689 }

690

691 if (nl_count == 0)

692 continue;

693

696

697 for (i = 0; QL_HELP[i].cmd; i++)

698 {

700 strcmp(topic, "*") == 0)

701 {

703 char *url;

704

706 QL_HELP[i].syntaxfunc(&buffer);

707 url = psprintf("https://www.postgresql.org/docs/%s/%s.html",

708 strstr(PG_VERSION, "devel") ? "devel" : PG_MAJORVERSION,

709 QL_HELP[i].docbook_id);

710

712 "Description: %s\n"

713 "Syntax:\n%s\n\n"

714 "URL: %s\n\n"),

715 QL_HELP[i].cmd,

718 url);

721

722

724 break;

725 }

726 }

727 break;

728 }

729

730

732 {

735 "Try \\h with no arguments to see available help.\n"),

736 topic);

737 }

738

740 }

741}

742

743

744

745void

747{

748 puts("PostgreSQL Database Management System\n"

749 "(formerly known as Postgres, then as Postgres95)\n\n"

752 "Permission to use, copy, modify, and distribute this software and its\n"

753 "documentation for any purpose, without fee, and without a written agreement\n"

754 "is hereby granted, provided that the above copyright notice and this\n"

755 "paragraph and the following two paragraphs appear in all copies.\n\n"

756 "IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR\n"

757 "DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING\n"

758 "LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS\n"

759 "DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE\n"

760 "POSSIBILITY OF SUCH DAMAGE.\n\n"

761 "THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,\n"

762 "INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\n"

763 "AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS\n"

764 "ON AN \"AS IS\" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO\n"

765 "PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n");

766}

#define fprintf(file, fmt, msg)

char * PQdb(const PGconn *conn)

FILE * PageOutput(int lines, const printTableOpt *topt)

void ClosePager(FILE *pagerpipe)

void helpVariables(unsigned short int pager)

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

void usage(unsigned short int pager)

void slashUsage(unsigned short int pager)

void print_copyright(void)

int pg_strcasecmp(const char *s1, const char *s2)

int pg_strncasecmp(const char *s1, const char *s2, size_t n)

void initPQExpBuffer(PQExpBuffer str)

void termPQExpBuffer(PQExpBuffer str)

char * psprintf(const char *fmt,...)

#define DEFAULT_FIELD_SEP

unsigned short int expanded