Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit03c25dd

Browse files
committed
Mark all GUC variables with <varname> markup, rather than <literal>.
1 parent2b6e2de commit03c25dd

File tree

7 files changed

+60
-60
lines changed

7 files changed

+60
-60
lines changed

‎doc/src/sgml/datetime.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -360,10 +360,10 @@
360360
</para>
361361

362362
<para>
363-
<literal>timezone_abbreviations</> can be set to any file name
363+
<varname>timezone_abbreviations</> can be set to any file name
364364
found in <filename>.../share/timezonesets/</>, if the file's name
365365
is entirely alphabetic. (The prohibition against non-alphabetic
366-
characters in <literal>timezone_abbreviations</> prevents reading
366+
characters in <varname>timezone_abbreviations</> prevents reading
367367
files outside the intended directory, as well as reading editor
368368
backup files and other extraneous files.)
369369
</para>
@@ -420,7 +420,7 @@
420420
according to the <literal>zoneinfo</> timezone database. The zone name
421421
definitions found in these files can be copied and pasted into a custom
422422
configuration file as needed. Note that these files cannot be directly
423-
referenced as <literal>timezone_abbreviations</> settings, because of
423+
referenced as <varname>timezone_abbreviations</> settings, because of
424424
the dot embedded in their names.
425425
</para>
426426

‎doc/src/sgml/libpq.sgml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1418,46 +1418,46 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
14181418

14191419
<para>
14201420
Parameters reported as of the current release include
1421-
<literal>server_version</>,
1422-
<literal>server_encoding</>,
1423-
<literal>client_encoding</>,
1424-
<literal>application_name</>,
1425-
<literal>is_superuser</>,
1426-
<literal>session_authorization</>,
1427-
<literal>DateStyle</>,
1428-
<literal>IntervalStyle</>,
1429-
<literal>TimeZone</>,
1430-
<literal>integer_datetimes</>, and
1431-
<literal>standard_conforming_strings</>.
1432-
(<literal>server_encoding</>, <literal>TimeZone</>, and
1433-
<literal>integer_datetimes</> were not reported by releases before 8.0;
1434-
<literal>standard_conforming_strings</> was not reported by releases
1421+
<varname>server_version</>,
1422+
<varname>server_encoding</>,
1423+
<varname>client_encoding</>,
1424+
<varname>application_name</>,
1425+
<varname>is_superuser</>,
1426+
<varname>session_authorization</>,
1427+
<varname>DateStyle</>,
1428+
<varname>IntervalStyle</>,
1429+
<varname>TimeZone</>,
1430+
<varname>integer_datetimes</>, and
1431+
<varname>standard_conforming_strings</>.
1432+
(<varname>server_encoding</>, <varname>TimeZone</>, and
1433+
<varname>integer_datetimes</> were not reported by releases before 8.0;
1434+
<varname>standard_conforming_strings</> was not reported by releases
14351435
before 8.1;
1436-
<literal>IntervalStyle</> was not reported by releases before 8.4;
1437-
<literal>application_name</> was not reported by releases before 9.0.)
1436+
<varname>IntervalStyle</> was not reported by releases before 8.4;
1437+
<varname>application_name</> was not reported by releases before 9.0.)
14381438
Note that
1439-
<literal>server_version</>,
1440-
<literal>server_encoding</> and
1441-
<literal>integer_datetimes</>
1439+
<varname>server_version</>,
1440+
<varname>server_encoding</> and
1441+
<varname>integer_datetimes</>
14421442
cannot change after startup.
14431443
</para>
14441444

14451445
<para>
14461446
Pre-3.0-protocol servers do not report parameter settings, but
14471447
<application>libpq</> includes logic to obtain values for
1448-
<literal>server_version</> and <literal>client_encoding</> anyway.
1448+
<varname>server_version</> and <varname>client_encoding</> anyway.
14491449
Applications are encouraged to use <function>PQparameterStatus</>
14501450
rather than <foreignphrase>ad hoc</> code to determine these values.
14511451
(Beware however that on a pre-3.0 connection, changing
1452-
<literal>client_encoding</> via <command>SET</> after connection
1452+
<varname>client_encoding</> via <command>SET</> after connection
14531453
startup will not be reflected by <function>PQparameterStatus</>.)
1454-
For <literal>server_version</>, see also
1454+
For <varname>server_version</>, see also
14551455
<function>PQserverVersion</>, which returns the information in a
14561456
numeric form that is much easier to compare against.
14571457
</para>
14581458

14591459
<para>
1460-
If no value for <literal>standard_conforming_strings</> is reported,
1460+
If no value for <varname>standard_conforming_strings</> is reported,
14611461
applications can assume it is <literal>off</>, that is, backslashes
14621462
are treated as escapes in string literals. Also, the presence of
14631463
this parameter can be taken as an indication that the escape string

‎doc/src/sgml/maintenance.sgml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -670,13 +670,13 @@ analyze threshold = analyze base threshold + analyze scale factor * number of tu
670670
autovacuum will only touch the table if it must do so
671671
to prevent transaction ID wraparound.
672672
Another two parameters,
673-
<literal>autovacuum_vacuum_cost_delay</literal> and
674-
<literal>autovacuum_vacuum_cost_limit</literal>, are used to set
673+
<varname>autovacuum_vacuum_cost_delay</> and
674+
<varname>autovacuum_vacuum_cost_limit</>, are used to set
675675
table-specific values for the cost-based vacuum delay feature
676676
(see <xref linkend="runtime-config-resource-vacuum-cost">).
677-
<literal>autovacuum_freeze_min_age</literal>,
678-
<literal>autovacuum_freeze_max_age</literal> and
679-
<literal>autovacuum_freeze_table_age</literal> are used to set
677+
<varname>autovacuum_freeze_min_age</>,
678+
<varname>autovacuum_freeze_max_age</> and
679+
<varname>autovacuum_freeze_table_age</> are used to set
680680
values for <xref linkend="guc-vacuum-freeze-min-age">,
681681
<xref linkend="guc-autovacuum-freeze-max-age"> and
682682
<xref linkend="guc-vacuum-freeze-table-age"> respectively.
@@ -764,7 +764,7 @@ analyze threshold = analyze base threshold + analyze scale factor * number of tu
764764
A better approach is to send the server's
765765
<systemitem>stderr</> output to some type of log rotation program.
766766
There is a built-in log rotation facility, which you can use by
767-
setting the configuration parameter <literal>logging_collector</> to
767+
setting the configuration parameter <varname>logging_collector</> to
768768
<literal>true</> in <filename>postgresql.conf</>. The control
769769
parameters for this program are described in <xref
770770
linkend="runtime-config-logging-where">. You can also use this approach
@@ -794,7 +794,7 @@ pg_ctl start | rotatelogs /var/log/pgsql_log 86400
794794
Another production-grade approach to managing log output is to
795795
send it to <application>syslog</> and let
796796
<application>syslog</> deal with file rotation. To do this, set the
797-
configuration parameter <literal>log_destination</> to <literal>syslog</>
797+
configuration parameter <varname>log_destination</> to <literal>syslog</>
798798
(to log to <application>syslog</> only) in
799799
<filename>postgresql.conf</>. Then you can send a <literal>SIGHUP</literal>
800800
signal to the <application>syslog</> daemon whenever you want to force it

‎doc/src/sgml/pgarchivecleanup.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
111111
archive_cleanup_command = 'pg_archivecleanup -d /mnt/standby/archive %r 2>>cleanup.log'
112112
</programlisting>
113113
where the archive directory is physically located on the standby server,
114-
so that the <literal>archive_command</> is accessing it across NFS,
114+
so that the <varname>archive_command</> is accessing it across NFS,
115115
but the files are local to the standby.
116116
This will:
117117
</para>

‎doc/src/sgml/pgstandby.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
<para>
1717
<application>pg_standby</> is designed to be a waiting
18-
<literal>restore_command</literal>, which is needed to turn a standard
18+
<varname>restore_command</>, which is needed to turn a standard
1919
archive recovery into a warm standby operation. Other
2020
configuration is required as well, all of which is described in the main
2121
server manual (see <xref linkend="warm-standby">).
@@ -61,7 +61,7 @@ restore_command = 'pg_standby <replaceable>archiveDir</> %f %p %r'
6161
<synopsis>
6262
pg_standby <optional> <replaceable>option</> ... </optional> <replaceable>archivelocation</> <replaceable>nextwalfile</> <replaceable>xlogfilepath</> <optional> <replaceable>restartwalfile</> </optional>
6363
</synopsis>
64-
When used within <literal>restore_command</literal>, the <literal>%f</> and
64+
When used within <varname>restore_command</>, the <literal>%f</> and
6565
<literal>%p</> macros should be specified for <replaceable>nextwalfile</>
6666
and <replaceable>xlogfilepath</> respectively, to provide the actual file
6767
and path required for the restore.
@@ -241,7 +241,7 @@ restore_command = 'pg_standby -d -s 2 -t /tmp/pgsql.trigger.5442 .../archive %f
241241
recovery_end_command = 'rm -f /tmp/pgsql.trigger.5442'
242242
</programlisting>
243243
where the archive directory is physically located on the standby server,
244-
so that the <literal>archive_command</> is accessing it across NFS,
244+
so that the <varname>archive_command</> is accessing it across NFS,
245245
but the files are local to the standby (enabling use of <literal>ln</>).
246246
This will:
247247
<itemizedlist>
@@ -285,8 +285,8 @@ restore_command = 'pg_standby -d -s 5 -t C:\pgsql.trigger.5442 ...\archive %f %p
285285
recovery_end_command = 'del C:\pgsql.trigger.5442'
286286
</programlisting>
287287
Note that backslashes need to be doubled in the
288-
<literal>archive_command</>, but <emphasis>not</emphasis> in the
289-
<literal>restore_command</> or <literal>recovery_end_command</>.
288+
<varname>archive_command</>, but <emphasis>not</emphasis> in the
289+
<varname>restore_command</> or <varname>recovery_end_command</>.
290290
This will:
291291
<itemizedlist>
292292
<listitem>
@@ -357,7 +357,7 @@ recovery_end_command = 'del C:\pgsql.trigger.5442'
357357
</para>
358358
<para>
359359
<productname>PostgreSQL</> 8.4 provides the
360-
<literal>recovery_end_command</literal> option. Without this option
360+
<varname>recovery_end_command</> option. Without this option
361361
a leftover trigger file can be hazardous.
362362
</para>
363363
</sect2>

‎doc/src/sgml/protocol.sgml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,27 +1092,27 @@
10921092
<para>
10931093
At present there is a hard-wired set of parameters for which
10941094
ParameterStatus will be generated: they are
1095-
<literal>server_version</>,
1096-
<literal>server_encoding</>,
1097-
<literal>client_encoding</>,
1098-
<literal>application_name</>,
1099-
<literal>is_superuser</>,
1100-
<literal>session_authorization</>,
1101-
<literal>DateStyle</>,
1102-
<literal>IntervalStyle</>,
1103-
<literal>TimeZone</>,
1104-
<literal>integer_datetimes</>, and
1105-
<literal>standard_conforming_strings</>.
1106-
(<literal>server_encoding</>, <literal>TimeZone</>, and
1107-
<literal>integer_datetimes</> were not reported by releases before 8.0;
1108-
<literal>standard_conforming_strings</> was not reported by releases
1095+
<varname>server_version</>,
1096+
<varname>server_encoding</>,
1097+
<varname>client_encoding</>,
1098+
<varname>application_name</>,
1099+
<varname>is_superuser</>,
1100+
<varname>session_authorization</>,
1101+
<varname>DateStyle</>,
1102+
<varname>IntervalStyle</>,
1103+
<varname>TimeZone</>,
1104+
<varname>integer_datetimes</>, and
1105+
<varname>standard_conforming_strings</>.
1106+
(<varname>server_encoding</>, <varname>TimeZone</>, and
1107+
<varname>integer_datetimes</> were not reported by releases before 8.0;
1108+
<varname>standard_conforming_strings</> was not reported by releases
11091109
before 8.1;
1110-
<literal>IntervalStyle</> was not reported by releases before 8.4;
1111-
<literal>application_name</> was not reported by releases before 9.0.)
1110+
<varname>IntervalStyle</> was not reported by releases before 8.4;
1111+
<varname>application_name</> was not reported by releases before 9.0.)
11121112
Note that
1113-
<literal>server_version</>,
1114-
<literal>server_encoding</> and
1115-
<literal>integer_datetimes</>
1113+
<varname>server_version</>,
1114+
<varname>server_encoding</> and
1115+
<varname>integer_datetimes</>
11161116
are pseudo-parameters that cannot change after startup.
11171117
This set might change in the future, or even become configurable.
11181118
Accordingly, a frontend should simply ignore ParameterStatus for

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,7 @@ PostgreSQL documentation
864864
<para>
865865
The database activity of <application>pg_dump</application> is
866866
normally collected by the statistics collector. If this is
867-
undesirable, you can set parameter <literal>track_counts</literal>
867+
undesirable, you can set parameter <varname>track_counts</>
868868
to false via <envar>PGOPTIONS</envar> or the <literal>ALTER
869869
USER</literal> command.
870870
</para>

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp