From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sat, 4 Nov 2006 18:20:40 +0000 (+0000)
Subject: Correct documentation error: in 8.1 and 8.2, %p in archive and restore
X-Git-Url: http://git.postgresql.org/gitweb/static/gitweb.js?a=commitdiff_plain;h=048f413bd35a165ad85888980edc6e4d9a7a6eb1;p=users%2Fbernd%2Fpostgres.git

Correct documentation error: in 8.1 and 8.2, %p in archive and restore
command strings inserts relative not absolute path of file to process.
This is a side-effect of 2005-07-04 change that makes the server use
relative paths in general.  Noted by Bernd Helmle.
---

diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml
index 14d052d4b9..2318a04d13 100644
--- a/doc/src/sgml/backup.sgml
+++ b/doc/src/sgml/backup.sgml
@@ -501,8 +501,10 @@ tar -cf backup.tar /usr/local/pgsql/data
     linkend="guc-archive-command"> configuration parameter, which in practice
     will always be placed in the <filename>postgresql.conf</filename> file.
     In this string,
-    any <literal>%p</> is replaced by the absolute path of the file to
+    any <literal>%p</> is replaced by the path name of the file to
     archive, while any <literal>%f</> is replaced by the file name only.
+    (The path name is relative to the working directory of the server,
+    i.e., the cluster's data directory.)
     Write <literal>%%</> if you need to embed an actual <literal>%</>
     character in the command.  The simplest useful command is something
     like
@@ -882,7 +884,9 @@ SELECT pg_stop_backup();
     WAL file segments.  Like the <varname>archive_command</>, this is
     a shell command string.  It may contain <literal>%f</>, which is
     replaced by the name of the desired log file, and <literal>%p</>,
-    which is replaced by the absolute path to copy the log file to.
+    which is replaced by the path name to copy the log file to.
+    (The path name is relative to the working directory of the server,
+    i.e., the cluster's data directory.)
     Write <literal>%%</> if you need to embed an actual <literal>%</>
     character in the command.  The simplest useful command is
     something like
@@ -956,8 +960,10 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
         the WAL file series. This parameter is required.
         Any <literal>%f</> in the string is
         replaced by the name of the file to retrieve from the archive,
-        and any <literal>%p</> is replaced by the absolute path to copy
+        and any <literal>%p</> is replaced by the path name to copy
         it to on the server.
+        (The path name is relative to the working directory of the server,
+        i.e., the cluster's data directory.)
         Write <literal>%%</> to embed an actual <literal>%</> character
         in the command. 
        </para>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index caab60778f..b13e0c338b 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1496,9 +1496,11 @@ SET ENABLE_SEQSCAN TO OFF;
         The shell command to execute to archive a completed segment of
         the WAL file series. If this is an empty string (the default),
         WAL archiving is disabled. Any <literal>%p</> in the string is
-        replaced by the absolute path of the file to archive, and any
-        <literal>%f</> is replaced by the file name only. Use
-        <literal>%%</> to embed an actual <literal>%</> character in the
+        replaced by the path name of the file to archive, and any
+        <literal>%f</> is replaced by the file name only.
+        (The path name is relative to the working directory of the server,
+        i.e., the cluster's data directory.)
+        Use <literal>%%</> to embed an actual <literal>%</> character in the
         command. For more information see <xref
         linkend="backup-archiving-wal">. This option can only be set at
         server start or in the <filename>postgresql.conf</filename>