diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index db4bcce56eac..e27e58df1658 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -516,6 +516,19 @@ LOGLEVEL=-Dorg.apache.commons.logging.simplelog.defaultlog=WARN that is done below. Instead, list the major components of the command line, such as where input and output files go. + + + Below are some addtional recommendations for an application synopsis: + + + + Options that are common across multiple applications should also + have consistent argument names. For example, + datadir and filename. + + + + diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 7613174c18b5..bd0dbff8caa5 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -28,7 +28,7 @@ PostgreSQL documentation - directory + datadir @@ -190,8 +190,8 @@ PostgreSQL documentation - - + + This option specifies the directory where the database cluster diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml index 95043aa329c0..9aabe96400c0 100644 --- a/doc/src/sgml/ref/pg_checksums.sgml +++ b/doc/src/sgml/ref/pg_checksums.sgml @@ -61,8 +61,8 @@ PostgreSQL documentation - - + + Specifies the directory where the database cluster is stored. diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml index b47fdca9dfcb..e890967c7f7a 100644 --- a/doc/src/sgml/ref/pg_controldata.sgml +++ b/doc/src/sgml/ref/pg_controldata.sgml @@ -22,7 +22,7 @@ PostgreSQL documentation pg_controldata - option + option @@ -47,14 +47,51 @@ PostgreSQL documentation This utility can only be run by the user who initialized the cluster because it requires read access to the data directory. You can specify the data directory on the command line, or use - the environment variable PGDATA. This utility supports the options - and , which print the - pg_controldata version and exit. It also - supports options and , which output the - supported arguments. + the environment variable PGDATA. + + Options + + + The following command-line options are available: + + + + + + + + Specifies the location of the database directory. + + + + + + + + + + Print the pg_controldata version and exit. + + + + + + + + + + Show help about pg_controldata command line + arguments, and exit. + + + + + + + Environment diff --git a/doc/src/sgml/ref/pg_createsubscriber.sgml b/doc/src/sgml/ref/pg_createsubscriber.sgml index 4b1d08d5f16d..a9528000719d 100644 --- a/doc/src/sgml/ref/pg_createsubscriber.sgml +++ b/doc/src/sgml/ref/pg_createsubscriber.sgml @@ -126,8 +126,8 @@ PostgreSQL documentation - - + + The target directory that contains a cluster directory from a physical diff --git a/doc/src/sgml/ref/pg_resetwal.sgml b/doc/src/sgml/ref/pg_resetwal.sgml index 2c019c2aac6e..b38bc0f3fab6 100644 --- a/doc/src/sgml/ref/pg_resetwal.sgml +++ b/doc/src/sgml/ref/pg_resetwal.sgml @@ -22,6 +22,7 @@ PostgreSQL documentation pg_resetwal + option @@ -30,7 +31,6 @@ PostgreSQL documentation - option diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 5485033ed8c7..eceff9dae329 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -28,9 +28,9 @@ PostgreSQL documentation - directory + datadir - + @@ -142,8 +142,8 @@ PostgreSQL documentation - - + + This option specifies the target data directory that is synchronized @@ -154,7 +154,7 @@ PostgreSQL documentation - + Specifies the file system path to the data directory of the source diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml index ce23add5577e..d1715ff51242 100644 --- a/doc/src/sgml/ref/pg_waldump.sgml +++ b/doc/src/sgml/ref/pg_waldump.sgml @@ -22,8 +22,8 @@ PostgreSQL documentation pg_waldump - - + option + startsegendseg diff --git a/doc/src/sgml/ref/pg_walsummary.sgml b/doc/src/sgml/ref/pg_walsummary.sgml index 57b2d24650cf..0fd9dbf95084 100644 --- a/doc/src/sgml/ref/pg_walsummary.sgml +++ b/doc/src/sgml/ref/pg_walsummary.sgml @@ -23,7 +23,7 @@ PostgreSQL documentation pg_walsummary option - file + filename @@ -31,7 +31,7 @@ PostgreSQL documentation Description pg_walsummary is used to print the contents of - WAL summary files. These binary files are found with the + WAL summary files. These binary files are found within the pg_wal/summaries subdirectory of the data directory, and can be converted to text using this tool. This is not ordinarily necessary, since WAL summary files primarily exist to support @@ -56,6 +56,16 @@ PostgreSQL documentation + + filename + + + A binary WAL summary file, found within the pg_wal/summaries + subdirectory of the data directory. + + + + diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index aeeed297437e..07de6aa9cf43 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -22,6 +22,7 @@ PostgreSQL documentation pg_upgrade + option oldbindir newbindir @@ -29,7 +30,6 @@ PostgreSQL documentation oldconfigdir newconfigdir - option