postgresql/src/bin/psql/help.h

/*
 * psql - the PostgreSQL interactive terminal
 *
 * Copyright (c) 2000-2024, PostgreSQL Global Development Group
 *
 * src/bin/psql/help.h
 */
#ifndef HELP_H
#define HELP_H

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

#endif
another set of cleanups 2000-01-19 00:30:24 +01:00			`/*`
			`* psql - the PostgreSQL interactive terminal`
			`*`
Update copyright for 2024 Reported-by: Michael Paquier Discussion: https://postgr.es/m/ZZKTDPxBBMt3C0J9@paquier.xyz Backpatch-through: 12 2024-01-04 02:49:05 +01:00			`* Copyright (c) 2000-2024, PostgreSQL Global Development Group`
another set of cleanups 2000-01-19 00:30:24 +01:00			`*`
Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00			`* src/bin/psql/help.h`
another set of cleanups 2000-01-19 00:30:24 +01:00			`*/`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00			`#ifndef HELP_H`
			`#define HELP_H`

Add new psql help topics, accessible to both --help and \?. Add --help=<topic> for the commandline, and \? <topic> as a backslash command, to show more help than the invocations without parameters do. "commands", "variables" and "options" currently exist as help topics describing, respectively, backslash commands, psql variables, and commandline switches. Without parameters the help commands show their previous topic. Some further wordsmithing or extending of the added help content might be needed; but there seems little benefit delaying the overall feature further. Author: Pavel Stehule, editorialized by many Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit Menon-Sen and Erik Rijkers. Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com, CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com 2014-09-09 22:19:14 +02:00			`void usage(unsigned short int pager);`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00
Here is a patch that does just that, while maintaining the "traditional" behavior, so the change should be transparent. Use the command "\pset pager always" to turn it on. Anything else does the normal toggle between "on" and "off" Greg Sabino Mullane 2002-11-08 20:12:21 +01:00			`void slashUsage(unsigned short int pager);`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00
Add new psql help topics, accessible to both --help and \?. Add --help=<topic> for the commandline, and \? <topic> as a backslash command, to show more help than the invocations without parameters do. "commands", "variables" and "options" currently exist as help topics describing, respectively, backslash commands, psql variables, and commandline switches. Without parameters the help commands show their previous topic. Some further wordsmithing or extending of the added help content might be needed; but there seems little benefit delaying the overall feature further. Author: Pavel Stehule, editorialized by many Reviewed-By: Andres Freund, Petr Jelinek, Fujii Masao, MauMau, Abhijit Menon-Sen and Erik Rijkers. Discussion: CAFj8pRDVGuC-nXBfe2CK8vpyzd2Dsr9GVpbrATAnZO=2YQ0s2Q@mail.gmail.com, CAFj8pRA54AbTv2RXDTRxiAd8hy8wxmoVLqhJDRCwEnhdd7OUkw@mail.gmail.com 2014-09-09 22:19:14 +02:00			`void helpVariables(unsigned short int pager);`

Make the printing code somewhat more independent by not relying on functions and global variables from the rest of psql. Also clean up some data type mismatches created by the last pager patch. 2003-03-18 23:15:44 +01:00			`void helpSQL(const char *topic, unsigned short int pager);`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00
psql cleanup 1999-11-05 00:14:30 +01:00			`void print_copyright(void);`
Another pgindent run. Fixes enum indenting, and improves #endif spacing. Also adds space for one-line comments. 2001-10-28 07:26:15 +01:00
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00			`#endif`