From 03c25dd900d97c0868ad20b925a78d41ec603578 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Wed, 2 Feb 2011 18:06:38 -0500 Subject: [PATCH] Mark all GUC variables with markup, rather than . --- doc/src/sgml/datetime.sgml | 6 ++-- doc/src/sgml/libpq.sgml | 46 +++++++++++++++--------------- doc/src/sgml/maintenance.sgml | 14 ++++----- doc/src/sgml/pgarchivecleanup.sgml | 2 +- doc/src/sgml/pgstandby.sgml | 12 ++++---- doc/src/sgml/protocol.sgml | 38 ++++++++++++------------ doc/src/sgml/ref/pg_dump.sgml | 2 +- 7 files changed, 60 insertions(+), 60 deletions(-) diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml index 0b55446245..707bd5abb6 100644 --- a/doc/src/sgml/datetime.sgml +++ b/doc/src/sgml/datetime.sgml @@ -360,10 +360,10 @@ - timezone_abbreviations can be set to any file name + timezone_abbreviations can be set to any file name found in .../share/timezonesets/, if the file's name is entirely alphabetic. (The prohibition against non-alphabetic - characters in timezone_abbreviations prevents reading + characters in timezone_abbreviations prevents reading files outside the intended directory, as well as reading editor backup files and other extraneous files.) @@ -420,7 +420,7 @@ according to the zoneinfo timezone database. The zone name definitions found in these files can be copied and pasted into a custom configuration file as needed. Note that these files cannot be directly - referenced as timezone_abbreviations settings, because of + referenced as timezone_abbreviations settings, because of the dot embedded in their names. diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 7b709709cb..ab09f35c9d 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1418,46 +1418,46 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName); Parameters reported as of the current release include - server_version, - server_encoding, - client_encoding, - application_name, - is_superuser, - session_authorization, - DateStyle, - IntervalStyle, - TimeZone, - integer_datetimes, and - standard_conforming_strings. - (server_encoding, TimeZone, and - integer_datetimes were not reported by releases before 8.0; - standard_conforming_strings was not reported by releases + server_version, + server_encoding, + client_encoding, + application_name, + is_superuser, + session_authorization, + DateStyle, + IntervalStyle, + TimeZone, + integer_datetimes, and + standard_conforming_strings. + (server_encoding, TimeZone, and + integer_datetimes were not reported by releases before 8.0; + standard_conforming_strings was not reported by releases before 8.1; - IntervalStyle was not reported by releases before 8.4; - application_name was not reported by releases before 9.0.) + IntervalStyle was not reported by releases before 8.4; + application_name was not reported by releases before 9.0.) Note that - server_version, - server_encoding and - integer_datetimes + server_version, + server_encoding and + integer_datetimes cannot change after startup. Pre-3.0-protocol servers do not report parameter settings, but libpq includes logic to obtain values for - server_version and client_encoding anyway. + server_version and client_encoding anyway. Applications are encouraged to use PQparameterStatus rather than ad hoc code to determine these values. (Beware however that on a pre-3.0 connection, changing - client_encoding via SET after connection + client_encoding via SET after connection startup will not be reflected by PQparameterStatus.) - For server_version, see also + For server_version, see also PQserverVersion, which returns the information in a numeric form that is much easier to compare against. - If no value for standard_conforming_strings is reported, + If no value for standard_conforming_strings is reported, applications can assume it is off, that is, backslashes are treated as escapes in string literals. Also, the presence of this parameter can be taken as an indication that the escape string diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index f3d1669f3a..03cc6c987a 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -670,13 +670,13 @@ analyze threshold = analyze base threshold + analyze scale factor * number of tu autovacuum will only touch the table if it must do so to prevent transaction ID wraparound. Another two parameters, - autovacuum_vacuum_cost_delay and - autovacuum_vacuum_cost_limit, are used to set + autovacuum_vacuum_cost_delay and + autovacuum_vacuum_cost_limit, are used to set table-specific values for the cost-based vacuum delay feature (see ). - autovacuum_freeze_min_age, - autovacuum_freeze_max_age and - autovacuum_freeze_table_age are used to set + autovacuum_freeze_min_age, + autovacuum_freeze_max_age and + autovacuum_freeze_table_age are used to set values for , and respectively. @@ -764,7 +764,7 @@ analyze threshold = analyze base threshold + analyze scale factor * number of tu A better approach is to send the server's stderr output to some type of log rotation program. There is a built-in log rotation facility, which you can use by - setting the configuration parameter logging_collector to + setting the configuration parameter logging_collector to true in postgresql.conf. The control parameters for this program are described in . You can also use this approach @@ -794,7 +794,7 @@ pg_ctl start | rotatelogs /var/log/pgsql_log 86400 Another production-grade approach to managing log output is to send it to syslog and let syslog deal with file rotation. To do this, set the - configuration parameter log_destination to syslog + configuration parameter log_destination to syslog (to log to syslog only) in postgresql.conf. Then you can send a SIGHUP signal to the syslog daemon whenever you want to force it diff --git a/doc/src/sgml/pgarchivecleanup.sgml b/doc/src/sgml/pgarchivecleanup.sgml index 026f5b27fe..725f3ed07c 100644 --- a/doc/src/sgml/pgarchivecleanup.sgml +++ b/doc/src/sgml/pgarchivecleanup.sgml @@ -111,7 +111,7 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E" archive_cleanup_command = 'pg_archivecleanup -d /mnt/standby/archive %r 2>>cleanup.log' where the archive directory is physically located on the standby server, - so that the archive_command is accessing it across NFS, + so that the archive_command is accessing it across NFS, but the files are local to the standby. This will: diff --git a/doc/src/sgml/pgstandby.sgml b/doc/src/sgml/pgstandby.sgml index a99fdf988e..7f0a8744fa 100644 --- a/doc/src/sgml/pgstandby.sgml +++ b/doc/src/sgml/pgstandby.sgml @@ -15,7 +15,7 @@ pg_standby is designed to be a waiting - restore_command, which is needed to turn a standard + restore_command, which is needed to turn a standard archive recovery into a warm standby operation. Other configuration is required as well, all of which is described in the main server manual (see ). @@ -61,7 +61,7 @@ restore_command = 'pg_standby archiveDir %f %p %r' pg_standby option ... archivelocation nextwalfile xlogfilepath restartwalfile - When used within restore_command, the %f and + When used within restore_command, the %f and %p macros should be specified for nextwalfile and xlogfilepath respectively, to provide the actual file and path required for the restore. @@ -241,7 +241,7 @@ restore_command = 'pg_standby -d -s 2 -t /tmp/pgsql.trigger.5442 .../archive %f recovery_end_command = 'rm -f /tmp/pgsql.trigger.5442' where the archive directory is physically located on the standby server, - so that the archive_command is accessing it across NFS, + so that the archive_command is accessing it across NFS, but the files are local to the standby (enabling use of ln). This will: @@ -285,8 +285,8 @@ restore_command = 'pg_standby -d -s 5 -t C:\pgsql.trigger.5442 ...\archive %f %p recovery_end_command = 'del C:\pgsql.trigger.5442' Note that backslashes need to be doubled in the - archive_command, but not in the - restore_command or recovery_end_command. + archive_command, but not in the + restore_command or recovery_end_command. This will: @@ -357,7 +357,7 @@ recovery_end_command = 'del C:\pgsql.trigger.5442' PostgreSQL 8.4 provides the - recovery_end_command option. Without this option + recovery_end_command option. Without this option a leftover trigger file can be hazardous. diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 73c05edacb..4521496352 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1092,27 +1092,27 @@ At present there is a hard-wired set of parameters for which ParameterStatus will be generated: they are - server_version, - server_encoding, - client_encoding, - application_name, - is_superuser, - session_authorization, - DateStyle, - IntervalStyle, - TimeZone, - integer_datetimes, and - standard_conforming_strings. - (server_encoding, TimeZone, and - integer_datetimes were not reported by releases before 8.0; - standard_conforming_strings was not reported by releases + server_version, + server_encoding, + client_encoding, + application_name, + is_superuser, + session_authorization, + DateStyle, + IntervalStyle, + TimeZone, + integer_datetimes, and + standard_conforming_strings. + (server_encoding, TimeZone, and + integer_datetimes were not reported by releases before 8.0; + standard_conforming_strings was not reported by releases before 8.1; - IntervalStyle was not reported by releases before 8.4; - application_name was not reported by releases before 9.0.) + IntervalStyle was not reported by releases before 8.4; + application_name was not reported by releases before 9.0.) Note that - server_version, - server_encoding and - integer_datetimes + server_version, + server_encoding and + integer_datetimes are pseudo-parameters that cannot change after startup. This set might change in the future, or even become configurable. Accordingly, a frontend should simply ignore ParameterStatus for diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index fdc4b928d5..f90d669995 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -864,7 +864,7 @@ PostgreSQL documentation The database activity of pg_dump is normally collected by the statistics collector. If this is - undesirable, you can set parameter track_counts + undesirable, you can set parameter track_counts to false via PGOPTIONS or the ALTER USER command. -- GitLab