Use on/off consistently for GUC variables in postgresql.conf and the

documentation, to match SHOW.

Author: bmomjian

doc/src/sgml/runtime.sgml

@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.333 2005/07/01 13:29:23 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.334 2005/07/02 18:29:03 momjian Exp $
 -->
 
 <chapter Id="runtime">
@@ -2461,7 +2461,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"'  # Windows
         rather than append to, any existing log file of the same name.
         However, truncation will occur only when a new file is being opened
         due to time-based rotation, not during server startup or size-based
-        rotation.  When false, pre-existing files will be appended to in
+        rotation.  When off, pre-existing files will be appended to in
         all cases.  For example, using this option in combination with
         a <varname>log_filename</varname> like <literal>postgresql-%H.log</literal>
         would result in generating twenty-four hourly log files and then
@@ -2474,14 +2474,14 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"'  # Windows
         <literal>server_log.Mon</literal>, <literal>server_log.Tue</literal>, 
         etc, and automatically overwrite last week's log with this week's log,
         set <varname>log_filename</varname> to <literal>server_log.%a</literal>, 
-        <varname>log_truncate_on_rotation</varname> to <literal>true</literal>, and 
+        <varname>log_truncate_on_rotation</varname> to <literal>on</literal>, and 
         <varname>log_rotation_age</varname> to <literal>1440</literal>.
        </para>
        <para>
         Example: To keep 24 hours of logs, one log file per hour, but 
         also rotate sooner if the log file size exceeds 1GB, set 
         <varname>log_filename</varname> to <literal>server_log.%H%M</literal>, 
-        <varname>log_truncate_on_rotation</varname> to <literal>true</literal>, 
+        <varname>log_truncate_on_rotation</varname> to <literal>on</literal>, 
         <varname>log_rotation_age</varname> to <literal>60</literal>, and 
         <varname>log_rotation_size</varname> to <literal>1000000</literal>.
         Including <literal>%M</> in <varname>log_filename</varname> allows
@@ -3258,7 +3258,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"'  # Windows
       </indexterm>
       <listitem>
        <para>
-        This parameter is normally true.  When set to false, it disables
+        This parameter is normally on.  When set to off, it disables
         validation of the function body string during <xref
         linkend="sql-createfunction"
         endterm="sql-createfunction-title">.  Disabling validation is
@@ -3307,7 +3307,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"'  # Windows
        <para>
         A read-only SQL transaction cannot alter non-temporary tables.
         This parameter controls the default read-only status of each new
-        transaction. The default is false (read/write).
+        transaction. The default is off (read/write).
        </para>
 
        <para>
@@ -3385,11 +3385,11 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"'  # Windows
       <indexterm><primary>time zone</><secondary>Australian</></>
       <listitem>
        <para>
-        If set to true, <literal>ACST</literal>,
+        If set to on, <literal>ACST</literal>,
         <literal>CST</literal>, <literal>EST</literal>, and
         <literal>SAT</literal> are interpreted as Australian time
         zones rather than as North/South American time zones and
-        Saturday. The default is false.
+        Saturday. The default is off.
        </para>
       </listitem>
      </varlistentry>
@@ -3670,12 +3670,12 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
       </indexterm>
       <listitem>
        <para>
-        When <literal>true</>, tables that are referenced by a query
+        When <literal>on</>, tables that are referenced by a query
         will be automatically added to the <literal>FROM</> clause if
         not already present. This behavior does not comply with the
         SQL standard and many people dislike it because it can mask
         mistakes (such as referencing a table where you should have
-        referenced its alias). The default is <literal>false</>. This
+        referenced its alias). The default is <literal>off</>. This
         variable can be enabled for compatibility with releases of
         <productname>PostgreSQL</> prior to 8.1, where this behavior
         was allowed by default.
@@ -3744,7 +3744,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
         determines whether OIDs will be included in tables created by
         <command>SELECT INTO</command>. In <productname>PostgreSQL</>
         8.1 <varname>default_with_oids</> is disabled by default; in
-        prior versions of PostgreSQL, it was true by default.
+        prior versions of PostgreSQL, it was on by default.
        </para>
 
        <para>
@@ -3997,9 +3997,9 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
        <para>
         Reports whether ordinary string literals
         (<literal>'...'</>) treat backslashes literally, as specified in
-        the SQL standard.  The value is currently always <literal>false</>,
+        the SQL standard.  The value is currently always <literal>off</>,
         indicating that backslashes are treated as escapes.  It is planned
-        that this will change to <literal>true</> in a future
+        that this will change to <literal>on</> in a future
         <productname>PostgreSQL</productname> release when string literal
         syntax changes to meet the standard.  Applications may check this
         parameter to determine how string literals will be processed.
@@ -4164,7 +4164,7 @@ plruby.bar = true        # generates error, unknown class name
       </indexterm>
       <listitem>
        <para>
-        If true, emit WAL-related debugging output. This option is
+        If on, emit WAL-related debugging output. This option is
         only available if the <symbol>WAL_DEBUG</symbol> macro was
         defined when <productname>PostgreSQL</productname> was
         compiled.
@@ -4181,14 +4181,14 @@ plruby.bar = true        # generates error, unknown class name
        <para>
         Detection of a damaged page header normally causes
         <productname>PostgreSQL</> to report an error, aborting the current
-        command.  Setting <varname>zero_damaged_pages</> to true causes
+        command.  Setting <varname>zero_damaged_pages</> to on causes
         the system to instead report a warning, zero out the damaged page,
         and continue processing.  This behavior <emphasis>will destroy data</>,
         namely all the rows on the damaged page.  But it allows you to get
         past the error and retrieve rows from any undamaged pages that may
         be present in the table.  So it is useful for recovering data if
         corruption has occurred due to hardware or software error.  You should
-        generally not set this true until you have given up hope of recovering
+        generally not set this on until you have given up hope of recovering
         data from the damaged page(s) of a table.  The
         default setting is off, and it can only be changed by a superuser.
        </para>

src/backend/utils/misc/postgresql.conf.sample

@@ -62,12 +62,12 @@
 # - Security & Authentication -
 
 #authentication_timeout = 60	# 1-600, in seconds
-#ssl = false
-#password_encryption = true
-#db_user_namespace = false
+#ssl = off
+#password_encryption = on
+#db_user_namespace = off
 # Kerberos
 #krb_server_keyfile = ''
-#krb_caseins_users = false
+#krb_caseins_users = off
 #krb_srvname = 'postgres'
 
 
@@ -117,7 +117,7 @@
 
 # - Settings -
 
-#fsync = true			# turns forced synchronization on or off
+#fsync = on			# turns forced synchronization on or off
 #wal_sync_method = fsync	# the default varies across platforms:
 				# fsync, fdatasync, fsync_writethrough,
 				# open_sync, open_datasync
@@ -142,15 +142,15 @@
 
 # - Planner Method Configuration -
 
-#enable_bitmapscan = true
-#enable_hashagg = true
-#enable_hashjoin = true
-#enable_indexscan = true
-#enable_mergejoin = true
-#enable_nestloop = true
-#enable_seqscan = true
-#enable_sort = true
-#enable_tidscan = true
+#enable_bitmapscan = on
+#enable_hashagg = on
+#enable_hashjoin = on
+#enable_indexscan = on
+#enable_mergejoin = on
+#enable_nestloop = on
+#enable_seqscan = on
+#enable_sort = on
+#enable_tidscan = on
 
 # - Planner Cost Constants -
 
@@ -162,7 +162,7 @@
 
 # - Genetic Query Optimizer -
 
-#geqo = true
+#geqo = on
 #geqo_threshold = 12
 #geqo_effort = 5		# range 1-10
 #geqo_pool_size = 0		# selects default based on effort
@@ -186,24 +186,25 @@
                                 # syslog and eventlog, depending on
                                 # platform.
 
-# This is relevant when logging to stderr:
-#redirect_stderr = false    # Enable capturing of stderr into log files.
-# These are only relevant if redirect_stderr is true:
-#log_directory = 'pg_log'   # Directory where log files are written.
-                            # May be specified absolute or relative to PGDATA
+# This is used when logging to stderr:
+#redirect_stderr = off		# Enable capturing of stderr into log files.
+
+# These are only used if redirect_stderr is on:
+#log_directory = 'pg_log'	# Directory where log files are written.
+				# Can be absolute or relative to PGDATA
 #log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # Log file name pattern.
-                            # May include strftime() escapes
-#log_truncate_on_rotation = false  # If true, any existing log file of the 
-                            # same name as the new log file will be truncated
-                            # rather than appended to.  But such truncation
-                            # only occurs on time-driven rotation,
-                            # not on restarts or size-driven rotation.
-                            # Default is false, meaning append to existing 
-                            # files in all cases.
-#log_rotation_age = 1440    # Automatic rotation of logfiles will happen after
-                            # so many minutes.  0 to disable.
-#log_rotation_size = 10240  # Automatic rotation of logfiles will happen after
-                            # so many kilobytes of log output.  0 to disable.
+				# Can include strftime() escapes
+#log_truncate_on_rotation = off # If on, any existing log file of the same 
+				# name as the new log file will be truncated
+				# rather than appended to.  But such truncation
+				# only occurs on time-driven rotation,
+				# not on restarts or size-driven rotation.
+				# Default is off, meaning append to existing 
+				# files in all cases.
+#log_rotation_age = 1440	# Automatic rotation of logfiles will happen after
+				# so many minutes.	0 to disable.
+#log_rotation_size = 10240	# Automatic rotation of logfiles will happen after
+				# so many kilobytes of log output.  0 to disable.
 
 # These are relevant when logging to syslog:
 #syslog_facility = 'LOCAL0'
@@ -230,17 +231,17 @@
 #log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
 				 # and their durations, in milliseconds.
 
-#silent_mode = false		 # DO NOT USE without syslog or redirect_stderr
+#silent_mode = off		 # DO NOT USE without syslog or redirect_stderr
 
 # - What to Log -
 
-#debug_print_parse = false
-#debug_print_rewritten = false
-#debug_print_plan = false
-#debug_pretty_print = false
-#log_connections = false
-#log_disconnections = false
-#log_duration = false
+#debug_print_parse = off
+#debug_print_rewritten = off
+#debug_print_plan = off
+#debug_pretty_print = off
+#log_connections = off
+#log_disconnections = off
+#log_duration = off
 #log_line_prefix = ''		# %u = user name
 				# %d = database name
 				# %r = remote host and port
@@ -257,7 +258,7 @@
 				# %% = '%'
 				# e.g. '<%u%%%d> '
 #log_statement = 'none'		# none, mod, ddl, all
-#log_hostname = false
+#log_hostname = off
 
 
 #---------------------------------------------------------------------------
@@ -266,18 +267,18 @@
 
 # - Statistics Monitoring -
 
-#log_parser_stats = false
-#log_planner_stats = false
-#log_executor_stats = false
-#log_statement_stats = false
+#log_parser_stats = off
+#log_planner_stats = off
+#log_executor_stats = off
+#log_statement_stats = off
 
 # - Query/Index Statistics Collector -
 
-#stats_start_collector = true
-#stats_command_string = false
-#stats_block_level = false
-#stats_row_level = false
-#stats_reset_on_server_start = true
+#stats_start_collector = on
+#stats_command_string = off
+#stats_block_level = off
+#stats_row_level = off
+#stats_reset_on_server_start = on
 
 
 #---------------------------------------------------------------------------
@@ -288,16 +289,16 @@
 
 #search_path = '$user,public'	# schema names
 #default_tablespace = ''	# a tablespace name, or '' for default
-#check_function_bodies = true
+#check_function_bodies = on
 #default_transaction_isolation = 'read committed'
-#default_transaction_read_only = false
+#default_transaction_read_only = off
 #statement_timeout = 0		# 0 is disabled, in milliseconds
 
 # - Locale and Formatting -
 
 #datestyle = 'iso, mdy'
 #timezone = unknown		# actually, defaults to TZ environment setting
-#australian_timezones = false
+#australian_timezones = off
 #extra_float_digits = 0		# min -15, max 2
 #client_encoding = sql_ascii	# actually, defaults to database encoding
 
@@ -309,7 +310,7 @@
 
 # - Other Defaults -
 
-#explain_pretty_print = true
+#explain_pretty_print = on
 #dynamic_library_path = '$libdir'
 
 
@@ -327,12 +328,12 @@
 
 # - Previous Postgres Versions -
 
-#add_missing_from = false
+#add_missing_from = off
 #regex_flavor = advanced	# advanced, extended, or basic
-#sql_inheritance = true
-#default_with_oids = false
-#escape_string_warning = false
+#sql_inheritance = on
+#default_with_oids = off
+#escape_string_warning = off
 
 # - Other Platforms & Clients -
 
-#transform_null_equals = false
+#transform_null_equals = off