summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Sabino Mullane2009-08-12 10:42:19 +0000
committerGreg Sabino Mullane2009-08-12 10:42:19 +0000
commitca96bf01dd959982f04d0976c62be40fff5529af (patch)
tree9c6cb12c2e9328fceb78dd520758fe0c21a38baa
parent026629457ae404d9ee565263d909f01292ec8ad7 (diff)
Add documentation for check_postgresrc
-rwxr-xr-xcheck_postgres.pl13
1 files changed, 13 insertions, 0 deletions
diff --git a/check_postgres.pl b/check_postgres.pl
index fafbeda5d..57c6b9cc3 100755
--- a/check_postgres.pl
+++ b/check_postgres.pl
@@ -7621,6 +7621,19 @@ make sure that the databases can be contacted, and that certain per-action
prerequisites are met, such as whether the user is a superuser, if the version
of Postgres is new enough, and if stats_row_level is enabled.
+=head1 FILES
+
+In addition to command-line configurations, you can put any options inside of a file. The file
+F<.check_postgresrc> in the current directory will be used if found. If not found, then the file
+F<~/.check_postgresrc> will be used. Finally, the file /etc/check_postgresrc will be used if available.
+The format of the file is option = value, one per line. Any line starting with a '#' will be skipped.
+Any values loaded from a check_postgresrc file will be overwritten by command-line options. All
+check_postgresrc files can be ignored by supplying a C<--no-checkpostgresrc> argument.
+
+=head1 ENVIRONMENT VARIABLES
+
+The encironment variable I<$ENV{HOME}> is used to look for a F<.check_postgresrc> file.
+
=head1 TIPS AND TRICKS
Since this program uses the B<psql> program, make sure it is accessible to the