Realign the running text in this file to 79 characters wide. Some other

copy-editing.

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

@@ -6,34 +6,34 @@
 #
 #   name = value
 #
-# (The '=' is optional.)  White space may be used.  Comments are introduced
-# with '#' anywhere on a line.  The complete list of option names and
-# allowed values can be found in the PostgreSQL documentation.  The
-# commented-out settings shown in this file represent the default values.
+# (The "=" is optional.)  Whitespace may be used.  Comments are introduced with
+# "#" anywhere on a line.  The complete list of parameter names and allowed
+# values can be found in the PostgreSQL documentation.
 #
-# Please note that re-commenting a setting is NOT sufficient to revert it
-# to the default value, unless you restart the server.
+# The commented-out settings shown in this file represent the default values.
+# Re-commenting a setting is NOT sufficient to revert it to the default value;
+# you need to reload the server.
 #
-# Any option can also be given as a command line switch to the server,
-# e.g., 'postgres -c log_connections=on'.  Some options can be changed at
-# run-time with the 'SET' SQL command.
+# This file is read on server startup and when the server receives a SIGHUP
+# signal.  If you edit the file on a running system, you have to SIGHUP the
+# server for the changes to take effect, or use "pg_ctl reload".  Some
+# parameters, which are marked below, require a server shutdown and restart to
+# take effect.
 #
-# This file is read on server startup and when the server receives a
-# SIGHUP.  If you edit the file on a running system, you have to SIGHUP the
-# server for the changes to take effect, or use "pg_ctl reload". Some
-# settings, which are marked below, require a server shutdown and restart
-# to take effect.
+# Any parameter can also be given as a command-line option to the server, e.g.,
+# "postgres -c log_connections=on".  Some paramters can be changed at run time
+# with the "SET" SQL command.
 #
 # Memory units:  kB = kilobytes MB = megabytes GB = gigabytes
 # Time units:    ms = milliseconds s = seconds min = minutes h = hours d = days
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # FILE LOCATIONS
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
-# The default values of these variables are driven from the -D command line
-# switch or PGDATA environment variable, represented here as ConfigDir.
+# The default values of these variables are driven from the -D command-line
+# option or PGDATA environment variable, represented here as ConfigDir.
 
 #data_directory = 'ConfigDir'		# use data in another directory
 					# (change requires restart)
@@ -47,48 +47,48 @@
 					# (change requires restart)
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # CONNECTIONS AND AUTHENTICATION
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Connection Settings -
 
-#listen_addresses = 'localhost'		# what IP address(es) to listen on; 
+#listen_addresses = 'localhost'		# what IP address(es) to listen on;
 					# comma-separated list of addresses;
 					# defaults to 'localhost', '*' = all
 					# (change requires restart)
 #port = 5432				# (change requires restart)
 #max_connections = 100			# (change requires restart)
-# Note: increasing max_connections costs ~400 bytes of shared memory per 
-# connection slot, plus lock space (see max_locks_per_transaction).  You
-# might also need to raise shared_buffers to support more connections.
+# Note:  Increasing max_connections costs ~400 bytes of shared memory per 
+# connection slot, plus lock space (see max_locks_per_transaction).  You might
+# also need to raise shared_buffers to support more connections.
 #superuser_reserved_connections = 3	# (change requires restart)
 #unix_socket_directory = ''		# (change requires restart)
 #unix_socket_group = ''			# (change requires restart)
-#unix_socket_permissions = 0777		# octal
+#unix_socket_permissions = 0777		# begin with 0 to use octal notation
 					# (change requires restart)
 #bonjour_name = ''			# defaults to the computer name
 					# (change requires restart)
 
-# - Security & Authentication -
+# - Security and Authentication -
 
 #authentication_timeout = 1min		# 1s-600s
 #ssl = off				# (change requires restart)
-#ssl_ciphers = 'ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH'	# Allowed SSL ciphers
+#ssl_ciphers = 'ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH'	# allowed SSL ciphers
 					# (change requires restart)
 #password_encryption = on
 #db_user_namespace = off
 
 # Kerberos and GSSAPI
 #krb_server_keyfile = ''		# (change requires restart)
-#krb_srvname = 'postgres'		# (change requires restart, kerberos only)
+#krb_srvname = 'postgres'		# (change requires restart, Kerberos only)
 #krb_server_hostname = ''		# empty string matches any keytab entry
-					# (change requires restart, kerberos only)
+					# (change requires restart, Kerberos only)
 #krb_caseins_users = off		# (change requires restart)
 #krb_realm = ''           		# (change requires restart)
 
 # - TCP Keepalives -
-# see 'man 7 tcp' for details
+# see "man 7 tcp" for details
 
 #tcp_keepalives_idle = 0		# TCP_KEEPIDLE, in seconds;
 					# 0 selects the system default
@@ -98,9 +98,9 @@
 					# 0 selects the system default
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # RESOURCE USAGE (except WAL)
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Memory -
 
@@ -109,7 +109,7 @@
 #temp_buffers = 8MB			# min 800kB
 #max_prepared_transactions = 5		# can be 0 or more
 					# (change requires restart)
-# Note: increasing max_prepared_transactions costs ~600 bytes of shared memory
+# Note:  Increasing max_prepared_transactions costs ~600 bytes of shared memory
 # per transaction slot, plus lock space (see max_locks_per_transaction).
 #work_mem = 1MB				# min 64kB
 #maintenance_work_mem = 16MB		# min 1MB
@@ -136,16 +136,16 @@
 #vacuum_cost_page_dirty = 20		# 0-10000 credits
 #vacuum_cost_limit = 200		# 0-10000 credits
 
-# - Background writer -
+# - Background Writer -
 
 #bgwriter_delay = 200ms			# 10-10000ms between rounds
 #bgwriter_lru_maxpages = 100		# 0-1000 max buffers written/round
 #bgwriter_lru_multiplier = 2.0		# 0-10.0 multipler on buffers scanned/round
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # WRITE AHEAD LOG
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Settings -
 
@@ -161,7 +161,7 @@
 #full_page_writes = on			# recover from partial page writes
 #wal_buffers = 64kB			# min 32kB
 					# (change requires restart)
-#wal_writer_delay = 200ms		# range 1-10000, in milliseconds
+#wal_writer_delay = 200ms		# 1-10000 milliseconds
 
 #commit_delay = 0			# range 0-100000, in microseconds
 #commit_siblings = 5			# range 1-1000
@@ -179,12 +179,12 @@
 				# (change requires restart)
 #archive_command = ''		# command to use to archive a logfile segment
 #archive_timeout = 0		# force a logfile segment switch after this
-				# many seconds; 0 is off
+				# time; 0 is off
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # QUERY TUNING
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Planner Method Configuration -
 
@@ -222,44 +222,44 @@
 #constraint_exclusion = off
 #from_collapse_limit = 8
 #join_collapse_limit = 8		# 1 disables collapsing of explicit 
-					# JOINs
+					# JOIN clauses
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # ERROR REPORTING AND LOGGING
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Where to Log -
 
-#log_destination = 'stderr'		# Valid values are combinations of 
-					# stderr, csvlog, syslog and eventlog, 
-					# depending on platform.
-					# csvlog requires logging_collector to be on
+#log_destination = 'stderr'		# Valid values are combinations of
+					# stderr, csvlog, syslog and eventlog,
+					# depending on platform.  csvlog
+					# requires logging_collector to be on.
 
 # This is used when logging to stderr:
-#logging_collector = off		# Enable capturing of stderr and csvlog 
-					# into log files. Required to be on for csvlogs.
+#logging_collector = off		# Enable capturing of stderr and csvlog
+					# into log files. Required to be on for
+					# csvlogs.
 					# (change requires restart)
 
 # These are only used if logging_collector 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.
-					# 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
+#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,
+					# can include strftime() escapes
+#log_truncate_on_rotation = off		# If on, an 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
+					# or size-driven rotation.  Default is
 					# off, meaning append to existing files
 					# in all cases.
-#log_rotation_age = 1d			# Automatic rotation of logfiles will 
-					# happen after that time.  0 to 
-					# disable.
+#log_rotation_age = 1d			# Automatic rotation of logfiles will
+					# happen after that time.  0 to disable.
 #log_rotation_size = 10MB		# Automatic rotation of logfiles will 
-					# happen after that much log
-					# output.  0 to disable.
+					# happen after that much log output.
+					# 0 to disable.
 
 # These are relevant when logging to syslog:
 #syslog_facility = 'LOCAL0'
@@ -268,7 +268,7 @@
 
 # - When to Log -
 
-#client_min_messages = notice		# Values in order of decreasing detail:
+#client_min_messages = notice		# values in order of decreasing detail:
 					#   debug5
 					#   debug4
 					#   debug3
@@ -279,7 +279,7 @@
 					#   warning
 					#   error
 
-#log_min_messages = notice		# Values in order of decreasing detail:
+#log_min_messages = notice		# values in order of decreasing detail:
 					#   debug5
 					#   debug4
 					#   debug3
@@ -295,7 +295,7 @@
 
 #log_error_verbosity = default		# terse, default, or verbose messages
 
-#log_min_error_statement = error	# Values in order of decreasing detail:
+#log_min_error_statement = error	# values in order of decreasing detail:
 				 	#   debug5
 					#   debug4
 					#   debug3
@@ -311,10 +311,9 @@
 
 #log_min_duration_statement = -1	# -1 is disabled, 0 logs all statements
 					# and their durations, > 0 logs only
-					# statements running at least N msec.
+					# statements running at least this time.
 
-
-#silent_mode = off			# DO NOT USE without syslog or 
+#silent_mode = off			# DO NOT USE without syslog or
 					# logging_collector
 					# (change requires restart)
 
@@ -329,35 +328,36 @@
 #log_disconnections = off
 #log_duration = off
 #log_hostname = off
-#log_line_prefix = ''			# Special values:
+#log_line_prefix = ''			# special values:
 					#   %u = user name
 					#   %d = database name
 					#   %r = remote host and port
 					#   %h = remote host
-					#   %p = PID
-					#   %t = timestamp (no milliseconds)
+					#   %p = process ID
+					#   %t = timestamp without milliseconds
 					#   %m = timestamp with milliseconds
 					#   %i = command tag
-					#   %c = session id
+					#   %c = session ID
 					#   %l = session line number
 					#   %s = session start timestamp
-					#   %v = virtual transaction id
-					#   %x = transaction id (0 if none)
-					#   %q = stop here in non-session 
+					#   %v = virtual transaction ID
+					#   %x = transaction ID (0 if none)
+					#   %q = stop here in non-session
 					#        processes
 					#   %% = '%'
 					# e.g. '<%u%%%d> '
-#log_lock_waits = off			# Log lock waits >= deadlock_timeout
+#log_lock_waits = off			# log lock waits >= deadlock_timeout
 #log_statement = 'none'			# none, ddl, mod, all
-#log_temp_files = -1			# Log temporary files equal or larger
-					# than specified number of kilobytes.
-					# -1 disables;  0 logs all temp files
-#log_timezone = unknown			# actually, defaults to TZ 
-					# environment setting
+#log_temp_files = -1			# log temporary files equal or larger
+					# than specified size;
+					# -1 disables, 0 logs all temp files
+#log_timezone = unknown			# actually, defaults to TZ environment
+					# setting
+
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # RUNTIME STATISTICS
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Query/Index Statistics Collector -
 
@@ -374,47 +374,43 @@
 #log_statement_stats = off
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # AUTOVACUUM PARAMETERS
-#---------------------------------------------------------------------------
-
-#autovacuum = on			# enable autovacuum subprocess?
-					# 'on' requires track_counts
-					# to also be on
-#log_autovacuum_min_duration = -1	# -1 disables, 0 logs all actions
-					# and their durations, > 0 logs only
-					# actions running at least N msec.
-#autovacuum_max_workers = 3		# max # of autovacuum subprocesses
+#------------------------------------------------------------------------------
+
+#autovacuum = on			# Enable autovacuum subprocess?  'on' 
+					# requires track_counts to also be on.
+#log_autovacuum_min_duration = -1	# -1 disables, 0 logs all actions and
+					# their durations, > 0 logs only
+					# actions running at least that time.
+#autovacuum_max_workers = 3		# max number of autovacuum subprocesses
 #autovacuum_naptime = 1min		# time between autovacuum runs
-#autovacuum_vacuum_threshold = 50	# min # of tuple updates before
+#autovacuum_vacuum_threshold = 50	# min number of row updates before
 					# vacuum
-#autovacuum_analyze_threshold = 50	# min # of tuple updates before 
-					# analyze
-#autovacuum_vacuum_scale_factor = 0.2	# fraction of rel size before 
-					# vacuum
-#autovacuum_analyze_scale_factor = 0.1	# fraction of rel size before 
+#autovacuum_analyze_threshold = 50	# min number of row updates before 
 					# analyze
+#autovacuum_vacuum_scale_factor = 0.2	# fraction of table size before vacuum
+#autovacuum_analyze_scale_factor = 0.1	# fraction of table size before analyze
 #autovacuum_freeze_max_age = 200000000	# maximum XID age before forced vacuum
 					# (change requires restart)
-#autovacuum_vacuum_cost_delay = 20	# default vacuum cost delay for 
-					# autovacuum, -1 means use 
+#autovacuum_vacuum_cost_delay = 20	# default vacuum cost delay for
+					# autovacuum, -1 means use
 					# vacuum_cost_delay
-#autovacuum_vacuum_cost_limit = -1	# default vacuum cost limit for 
+#autovacuum_vacuum_cost_limit = -1	# default vacuum cost limit for
 					# autovacuum, -1 means use
 					# vacuum_cost_limit
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # CLIENT CONNECTION DEFAULTS
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 # - Statement Behavior -
 
 #search_path = '"$user",public'		# schema names
-#default_tablespace = ''		# a tablespace name, '' uses
-					# the default
-#temp_tablespaces = ''			# a list of tablespace names,
-					# '' uses only default tablespace
+#default_tablespace = ''		# a tablespace name, '' uses the default
+#temp_tablespaces = ''			# a list of tablespace names, '' uses
+					# only default tablespace
 #check_function_bodies = on
 #default_transaction_isolation = 'read committed'
 #default_transaction_read_only = off
@@ -427,21 +423,21 @@
 # - Locale and Formatting -
 
 #datestyle = 'iso, mdy'
-#timezone = unknown			# actually, defaults to TZ 
-					# environment setting
-#timezone_abbreviations = 'Default'     # select the set of available timezone
-					# abbreviations. Currently, there are
+#timezone = unknown			# actually, defaults to TZ environment
+					# setting
+#timezone_abbreviations = 'Default'     # Select the set of available time zone
+					# abbreviations.  Currently, there are
 					#   Default
 					#   Australia
 					#   India
-					# However you can also create your own
-					# file in share/timezonesets/.
+					# You can create your own file in
+					# share/timezonesets/.
 #extra_float_digits = 0			# min -15, max 2
 #client_encoding = sql_ascii		# actually, defaults to database
 					# encoding
 
-# These settings are initialized by initdb -- they might be changed
-#lc_messages = 'C'			# locale for system error message 
+# These settings are initialized by initdb, but they can be changed.
+#lc_messages = 'C'			# locale for system error message
 					# strings
 #lc_monetary = 'C'			# locale for monetary formatting
 #lc_numeric = 'C'			# locale for number formatting
@@ -457,23 +453,23 @@
 #local_preload_libraries = ''
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # LOCK MANAGEMENT
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 #deadlock_timeout = 1s
 #max_locks_per_transaction = 64		# min 10
 					# (change requires restart)
-# Note: each lock table slot uses ~270 bytes of shared memory, and there are
+# Note:  Each lock table slot uses ~270 bytes of shared memory, and there are
 # max_locks_per_transaction * (max_connections + max_prepared_transactions)
 # lock table slots.
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # VERSION/PLATFORM COMPATIBILITY
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
-# - Previous Postgres Versions -
+# - Previous PostgreSQL Versions -
 
 #add_missing_from = off
 #array_nulls = on
@@ -484,13 +480,13 @@
 #regex_flavor = advanced		# advanced, extended, or basic
 #sql_inheritance = on
 
-# - Other Platforms & Clients -
+# - Other Platforms and Clients -
 
 #transform_null_equals = off
 
 
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 # CUSTOMIZED OPTIONS
-#---------------------------------------------------------------------------
+#------------------------------------------------------------------------------
 
 #custom_variable_classes = ''		# list of custom variable class names