diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml index b9331830f7..c7517e4b28 100644 --- a/doc/src/sgml/backup.sgml +++ b/doc/src/sgml/backup.sgml @@ -1248,8 +1248,8 @@ SELECT pg_stop_backup(); Set recovery configuration settings in - postgresql.conf (see ) and create a file + configuration file + (see ) and create a file recovery.signal in the cluster data directory. You might also want to temporarily modify pg_hba.conf to prevent @@ -1534,7 +1534,8 @@ restore_command = 'gunzip < /mnt/server/archivedir/%f > %p' Many people choose to use scripts to define their archive_command, so that their - postgresql.conf entry looks very simple: + configuration file + entry looks very simple: archive_command = 'local_backup_script.sh "%p" "%f"' diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 606e80df0e..677e5b8e1a 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -600,7 +600,8 @@ include_dir 'conf.d' command-line option or PGDATA environment variable must point to the directory containing the configuration files, and the data_directory parameter must be set in - postgresql.conf (or on the command line) to show + configuration file + (or on the command line) to show where the data directory is actually located. Notice that data_directory overrides and PGDATA for the location @@ -998,8 +999,9 @@ include_dir 'conf.d' hung clients from occupying a connection indefinitely. If this value is specified without units, it is taken as seconds. The default is one minute (1m). - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -1038,7 +1040,8 @@ include_dir 'conf.d' Sets the location of the Kerberos server key file. See for details. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. @@ -1054,7 +1057,8 @@ include_dir 'conf.d' Sets whether GSSAPI user names should be treated case-insensitively. The default is off (case sensitive). This parameter can only be - set in the postgresql.conf file or on the server command line. + set in the configuration file + or on the server command line. @@ -1068,8 +1072,9 @@ include_dir 'conf.d' This parameter enables per-database user names. It is off by default. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -1130,8 +1135,9 @@ include_dir 'conf.d' Enables SSL connections. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is off. @@ -1148,8 +1154,9 @@ include_dir 'conf.d' Specifies the name of the file containing the SSL server certificate authority (CA). Relative paths are relative to the data directory. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is empty, meaning no CA file is loaded, and client certificate verification is not performed. @@ -1166,8 +1173,9 @@ include_dir 'conf.d' Specifies the name of the file containing the SSL server certificate. Relative paths are relative to the data directory. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is server.crt. @@ -1184,8 +1192,9 @@ include_dir 'conf.d' Specifies the name of the file containing the SSL server certificate revocation list (CRL). Relative paths are relative to the data directory. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is empty, meaning no CRL file is loaded. @@ -1201,8 +1210,9 @@ include_dir 'conf.d' Specifies the name of the file containing the SSL server private key. Relative paths are relative to the data directory. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is server.key. @@ -1230,7 +1240,8 @@ include_dir 'conf.d' This parameter can only be set in the - postgresql.conf file or on the server command + configuration file + or on the server command line. @@ -1304,8 +1315,9 @@ include_dir 'conf.d' Specifies whether to use the server's SSL cipher preferences, rather than the client's. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is on. @@ -1331,8 +1343,9 @@ include_dir 'conf.d' exchange. It needs to be supported by all clients that connect. It does not need to be the same curve used by the server's Elliptic Curve key. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is prime256v1. @@ -1408,8 +1421,9 @@ include_dir 'conf.d' - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -1442,8 +1456,9 @@ include_dir 'conf.d' mechanism is adequately secure. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -1468,8 +1483,9 @@ include_dir 'conf.d' passphrase is obtained from a file, for example. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -2178,7 +2194,8 @@ include_dir 'conf.d' bgwriter_delay to a value that is not a multiple of 10 might have the same results as setting it to the next higher multiple of 10. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. @@ -2196,8 +2213,9 @@ include_dir 'conf.d' background writing. (Note that checkpoints, which are managed by a separate, dedicated auxiliary process, are unaffected.) The default value is 100 buffers. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -2224,8 +2242,9 @@ include_dir 'conf.d' while smaller values intentionally leave writes to be done by server processes. The default is 2.0. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -2256,8 +2275,9 @@ include_dir 'conf.d' 2MB. The default is 512kB on Linux, 0 elsewhere. (If BLCKSZ is not 8kB, the default and maximum values scale proportionally to it.) - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -2685,8 +2705,9 @@ include_dir 'conf.d' - fsync can only be set in the postgresql.conf - file or on the server command line. + fsync can only be set in the + configuration file + or on the server command line. If you turn this parameter off, also consider turning off . @@ -2814,8 +2835,9 @@ include_dir 'conf.d' configuration in order to create a crash-safe configuration or achieve optimal performance. These aspects are discussed in . - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -2860,8 +2882,9 @@ include_dir 'conf.d' - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. The default is on. @@ -3010,7 +3033,8 @@ include_dir 'conf.d' milliseconds; setting wal_writer_delay to a value that is not a multiple of 10 might have the same results as setting it to the next higher multiple of 10. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. @@ -3034,7 +3058,8 @@ include_dir 'conf.d' that is XLOG_BLCKSZ bytes, typically 8kB. The default is 1MB. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + file or on the server command line. @@ -3134,8 +3159,9 @@ include_dir 'conf.d' The default is five minutes (5min). Increasing this parameter can increase the amount of time needed for crash recovery. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3150,8 +3176,9 @@ include_dir 'conf.d' Specifies the target of checkpoint completion, as a fraction of total time between checkpoints. The default is 0.5. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3182,8 +3209,9 @@ include_dir 'conf.d' and 2MB. The default is 256kB on Linux, 0 elsewhere. (If BLCKSZ is not 8kB, the default and maximum values scale proportionally to it.) - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3205,8 +3233,9 @@ include_dir 'conf.d' Zero disables the warning. No warnings will be generated if checkpoint_timeout is less than checkpoint_warning. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3228,8 +3257,9 @@ include_dir 'conf.d' The default is 1 GB. Increasing this parameter can increase the amount of time needed for crash recovery. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3249,8 +3279,9 @@ include_dir 'conf.d' jobs. If this value is specified without units, it is taken as megabytes. The default is 80 MB. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3311,8 +3342,9 @@ include_dir 'conf.d' . - This parameter can only be set in the postgresql.conf - file or on the server command line. It is ignored unless + This parameter can only be set in the + configuration file + or on the server command line. It is ignored unless archive_mode was enabled at server start. If archive_command is an empty string (the default) while archive_mode is enabled, WAL archiving is temporarily @@ -3356,7 +3388,8 @@ include_dir 'conf.d' server more quickly than that. If this value is specified without units, it is taken as seconds. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. @@ -3500,8 +3533,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows found), a fatal error will be raised. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3529,8 +3563,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows database will not proceed with startup. - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. @@ -3882,7 +3917,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows archiving. If this value is specified without units, it is taken as megabytes. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. @@ -3945,9 +3981,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows - Record commit time of transactions. This parameter - can only be set in postgresql.conf file or on the server - command line. The default value is off. + Record commit time of transactions. This parameter can only be set in + configuration file + or on the server command line. The default value is off. @@ -4094,8 +4130,9 @@ ANY num_sync ( configuration file + or on the server command line. @@ -4120,8 +4157,9 @@ ANY num_sync ( configuration file + or on the server command line. You should also consider setting hot_standby_feedback @@ -4180,8 +4218,9 @@ ANY num_sync ( configuration file + or on the server command line. If this parameter is changed while the WAL receiver process is running, that process is signaled to shut down and expected to restart with the new setting (except if primary_conninfo @@ -4202,8 +4241,9 @@ ANY num_sync ( ). - This parameter can only be set in the postgresql.conf - file or on the server command line. + This parameter can only be set in the + configuration file + or on the server command line. If this parameter is changed while the WAL receiver process is running, that process is signaled to shut down and expected to restart with the new setting. @@ -4225,8 +4265,9 @@ ANY num_sync ( configuration file + or on the server command line. @@ -4266,8 +4307,9 @@ ANY num_sync ( configuration file + or on the server command line. Note that max_standby_archive_delay is not the same as the @@ -4298,8 +4340,9 @@ ANY num_sync ( configuration file + or on the server command line. Note that max_standby_streaming_delay is not the same as @@ -4325,7 +4368,8 @@ ANY num_sync ( ). The default is off. This parameter can only be set in the - postgresql.conf file or on the server command line. + configuration file + or on the server command line. If this parameter is changed while the WAL receiver process is running, that process is signaled to shut down and expected to restart with the new setting. @@ -4357,9 +4401,9 @@ ANY num_sync ( configuration file + or on the server command line. @@ -4380,7 +4424,8 @@ ANY num_sync (