aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/postgres-ref.sgml
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2015-06-29 12:42:52 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2015-06-29 12:42:52 -0400
commitcbc8d65639344c390a1d1a7f646c186ff3ad8693 (patch)
tree46c7ad96d8f554aea527f30247363f4fc85f8ef5 /doc/src/sgml/ref/postgres-ref.sgml
parent07cb8b02ab4c8b65bb2e3b87ad2402fdc6cce978 (diff)
downloadpostgresql-cbc8d65639344c390a1d1a7f646c186ff3ad8693.tar.gz
postgresql-cbc8d65639344c390a1d1a7f646c186ff3ad8693.zip
Code + docs review for escaping of option values (commit 11a020eb6).
Avoid memory leak from incorrect choice of how to free a StringInfo (resetStringInfo doesn't do it). Now that pg_split_opts doesn't scribble on the optstr, mark that as "const" for clarity. Attach the commentary in protocol.sgml to the right place, and add documentation about the user-visible effects of this change on postgres' -o option and libpq's PGOPTIONS option.
Diffstat (limited to 'doc/src/sgml/ref/postgres-ref.sgml')
-rw-r--r--doc/src/sgml/ref/postgres-ref.sgml14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml
index 3b5617181ca..e2e99092428 100644
--- a/doc/src/sgml/ref/postgres-ref.sgml
+++ b/doc/src/sgml/ref/postgres-ref.sgml
@@ -284,12 +284,18 @@ PostgreSQL documentation
<term><option>-o <replaceable class="parameter">extra-options</replaceable></option></term>
<listitem>
<para>
- The command-line-style options specified in <replaceable
+ The command-line-style arguments specified in <replaceable
class="parameter">extra-options</replaceable> are passed to
all server processes started by this
- <command>postgres</command> process. If the option string contains
- any spaces, the entire string must be quoted; multiple
- option invocations are appended.
+ <command>postgres</command> process.
+ </para>
+
+ <para>
+ Spaces within <replaceable class="parameter">extra-options</> are
+ considered to separate arguments, unless escaped with a backslash
+ (<literal>\</>); write <literal>\\</> to represent a literal
+ backslash. Multiple arguments can also be specified via multiple
+ uses of <option>-o</>.
</para>
<para>