Hello
2014-06-21 15:51 GMT+02:00 MauMau <maumau...@gmail.com>:
> eFrom: "Pavel Stehule" <pavel.steh...@gmail.com>
>
>> here is a prototype:
>>
>
> The patch applied and built with success. There are a few minor things:
>
>
> (1)
> help_variables() lacks description of some variables such as SINGLELINE
> and SINGLESTEP. I think this help should list all available variables,
> because users may want to know the existence of those missing variables.
> Based on this, modify these lines: remove "some" from the first line and
> the entire second line.
>
> + printf(_("List of some variables (options) for use from command
> line.\n"));
> + printf(_("Complete list you find in psql section in the PostgreSQL
> documentation.\n\n"));
>
>
I fixed it
>
> (2)
> The indent is different from other lines. Leave just two spaces at the
> beginning of the line.
>
> + printf(_(" --help-variables list of available configuration
> variables (options), then exit\n"));
>
I am not sure in this point. It is aligned left with all long options:
-?, --help show this help, then exit
--help-variables list of available configuration variables
(options), then exit
Input and output options:
-a, --echo-all echo all input from script
-e, --echo-queries echo commands sent to server
-E, --echo-hidden display queries that internal commands generate
I am thinking so current implementation has sense.
>
>
> (3)
> This change is unnecessary. See src/bin/pg_dumpall.c for similar switches.
>
> - while ((c = getopt_long(argc, argv, "aAc:d:eEf:F:h:HlL:no:p:P:qR:
> sStT:U:v:VwWxXz?01",
> or+ while ((c = getopt_long(argc, argv, "aAc:d:eEf:F:h:HlL:no:p:P:qR:
> sStT:U:v:VwWxXz?001",
>
fixed
>
> Regards
> MauMau
>
>
updated patch is in attachment
Regards
Pavel
commit 826bd11fb4e9ac4b26cfe2e3702535f6b9527c12
Author: Pavel Stehule <pavel.steh...@gmail.com>
Date: Sun Jun 22 00:08:24 2014 +0200
initial
diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c
index 3aa3c16..aa11808 100644
--- a/src/bin/psql/help.c
+++ b/src/bin/psql/help.c
@@ -78,12 +78,13 @@ usage(void)
printf(_(" -f, --file=FILENAME execute commands from file, then exit\n"));
printf(_(" -l, --list list available databases, then exit\n"));
printf(_(" -v, --set=, --variable=NAME=VALUE\n"
- " set psql variable NAME to VALUE\n"));
+ " set psql variable NAME to VALUE e.g.: -v ON_ERROR_STOP=1\n"));
printf(_(" -V, --version output version information, then exit\n"));
printf(_(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n"));
printf(_(" -1 (\"one\"), --single-transaction\n"
" execute as a single transaction (if non-interactive)\n"));
printf(_(" -?, --help show this help, then exit\n"));
+ printf(_(" --help-variables list of available configuration variables (options), then exit\n"));
printf(_("\nInput and output options:\n"));
printf(_(" -a, --echo-all echo all input from script\n"));
@@ -279,6 +280,80 @@ slashUsage(unsigned short int pager)
}
+/*
+ * show list of available variables (options) from command line
+ */
+void
+help_variables(void)
+{
+ printf(_("List of variables (options) for use from command line.\n"));
+
+ printf(_("psql variables:\n"));
+ printf(_("Usage:\n"));
+ printf(_(" psql --set=NAME=VALUE\n or \\set NAME VALUE in interactive mode\n\n"));
+
+ printf(_(" AUTOCOMMIT when is on, successful SQL command is automatically commited\n"));
+ printf(_(" COMP_KEYWORD_CASE determines which letter case to use when completing an SQL key word\n"));
+ printf(_(" DBNAME the name of currently connected database\n"));
+ printf(_(" ECHO all lines from input can be written to standard output\n"));
+ printf(_(" ECHO_HIDDEN display queries for internal commands (same as -E option)\n"));
+ printf(_(" ENCODING the current client character set encoding\n"));
+ printf(_(" FETCH_COUNT how many rows should be for one page (default 0 unlimited)\n"));
+ printf(_(" HISTCONTROL when is set, control history list [ignorespace, ignoredups, ignoreboth]\n"));
+ printf(_(" HISTFILE file name that be used for store history list\n"));
+ printf(_(" HISTSIZE the number of commands to store in the command history\n"));
+ printf(_(" HOST the currently connected database server\n"));
+ printf(_(" IGNOREEOF if unset, sending an EOF to interactive session terminates application\n"));
+ printf(_(" LASTOID the value of last affected OID\n"));
+ printf(_(" ON_ERROR_ROLLBACK when is on, raise ROLLBACK on error automatically\n"));
+ printf(_(" ON_ERROR_STOP when is set, then batch execution stop immediately after error\n"));
+ printf(_(" PORT the database server port to which is currently used\n"));
+ printf(_(" PROPMPT1, PROPMT2, PROPMPT3 specify a look of psql prompt\n"));
+ printf(_(" QUIET when is set, run quietly (same as -q option)\n"));
+ printf(_(" SIGLELINE end of line terminates SQL command mode (same as -S option)\n"));
+ printf(_(" SINGLESTEP confirm each query mode (same as -s option)\n"));
+ printf(_(" USER the database user that are currently connected\n"));
+ printf(_(" VERBOSITY control verbosity of error reports [default, verbose, terse]\n"));
+
+ printf(_("\nPrinting options:\n"));
+ printf(_("Usage:\n"));
+ printf(_(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] in interactive mode\n\n"));
+
+ printf(_(" border number of border style\n"));
+ printf(_(" fieldsep specify field separator for unaligned output\n"));
+ printf(_(" fieldsep_zero field separator in unaligned mode will be zero\n"));
+ printf(_(" format set output format [unaligned, aligned, wrapped, html, latex, ..]\n"));
+ printf(_(" linestyle sets the border line drawing style [ascii, old-ascii, unicode]\n"));
+ printf(_(" null sets the string to be printed in place of a null value\n"));
+ printf(_(" pager when the pager option is off, the pager program is not used\n"));
+ printf(_(" recordsep specifies the record (line) separator to use in unaligned output format\n"));
+ printf(_(" recordsep_zero record separator be in unaligned output format a zero byte\n"));
+ printf(_(" title sets the table title for any subsequently printed tables\n"));
+ printf(_(" tuples_only in tuples-only mode, only actual table data is shown\n"));
+
+ printf(_("\nEnvironment options:\n"));
+ printf(_("Usage:\n"));
+ printf(_(" NAME=VALUE, [NAME=VALUE] psql ...\n or \\setenv NAME [VALUE] in interactive mode\n\n"));
+
+ printf(_(" COLUMNS number of columns for wrapped format\n"));
+ printf(_(" PAGER used pager\n"));
+ printf(_(" PGDATABASE same as the dbname connection parameter\n"));
+ printf(_(" PGHOST same as the host connection parameter\n"));
+ printf(_(" PGPORT same as the port connection parameter\n"));
+ printf(_(" PGUSER same as the user connection parameter\n"));
+ printf(_(" PGPASSWORD possibility to set password\n"));
+ printf(_(" PSQL_EDITOR, EDITOR, VISUAL editor used by \\e \\ef commands\n"));
+ printf(_(" PSQL_EDITOR_LINE_NUMBER_ARG style how to line number is used in editor\n"));
+ printf(_(" PSQL_HISTORY alternative location for the command history file\n"));
+ printf(_(" PSQL_RC alternative location of the user's .psqlrc file\n"));
+ printf(_(" SHELL command executed by the \\! command\n"));
+ printf(_(" TMPDIR directory for storing temporary files\n"));
+
+ printf(_("\nFor more information consult the psql section in the PostgreSQL\n"
+ "documentation.\n\n"));
+ printf(_("Report bugs to <pgsql-b...@postgresql.org>.\n"));
+}
+
/*
* helpSQL -- help with SQL commands
diff --git a/src/bin/psql/help.h b/src/bin/psql/help.h
index 054d5a4..e7affff 100644
--- a/src/bin/psql/help.h
+++ b/src/bin/psql/help.h
@@ -12,6 +12,8 @@ void usage(void);
void slashUsage(unsigned short int pager);
+void help_variables(void);
+
void helpSQL(const char *topic, unsigned short int pager);
void print_copyright(void);
diff --git a/src/bin/psql/startup.c b/src/bin/psql/startup.c
index 45653a1..d911159 100644
--- a/src/bin/psql/startup.c
+++ b/src/bin/psql/startup.c
@@ -383,6 +383,7 @@ parse_psql_options(int argc, char *argv[], struct adhoc_opts * options)
{"expanded", no_argument, NULL, 'x'},
{"no-psqlrc", no_argument, NULL, 'X'},
{"help", no_argument, NULL, '?'},
+ {"help-variables", no_argument, NULL, 1},
{NULL, 0, NULL, 0}
};
@@ -566,6 +567,9 @@ parse_psql_options(int argc, char *argv[], struct adhoc_opts * options)
exit(EXIT_FAILURE);
}
break;
+ case 1:
+ help_variables();
+ exit(EXIT_SUCCESS);
default:
fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
pset.progname);
--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers
