From 840f2fae3995a3e263801ad07d1285d35ddd9485 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 2 Jun 2010 19:00:38 +0200
Subject: Update description of the --options-file option

---
 doc/cli.1     | 21 ++++++++++++++++-----
 doc/cli.xhtml | 22 ++++++++++++++++------
 2 files changed, 32 insertions(+), 11 deletions(-)

(limited to 'doc')

diff --git a/doc/cli.1 b/doc/cli.1
index b42652e..739b845 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -73,6 +73,10 @@ Write the generated files to \fIdir\fP instead of the current directory\.
 .IP "\fB--generate-modifier\fP"
 Generate option value modifiers in addition to accessors\.
 
+.IP "\fB--generate-specifier\fP"
+Generate functions for determining whether the option was specified on the
+command line\.
+
 .IP "\fB--generate-file-scanner\fP"
 Generate the argv_file_scanner implementation\. This scanner is capable of
 reading command line arguments from the argv array as well as files
@@ -181,11 +185,18 @@ is used instead\. All C++ keywords are already in this list\.
 .IP "\fB--options-file\fP \fIfile\fP"
 Read additional options from \fIfile\fP with each option appearing on a
 separate line optionally followed by space and an option value\. Empty lines
-and lines starting with \fB#\fP are ignored\. The semantics of providing
-options in a file is equivalent to providing the same set of options in the
-same order on the command line at the point where the \fB--options-file\fP
-option is specified except that shell escaping and quoting is not required\.
-Repeat this option to specify more than one options files\.
+and lines starting with \fB#\fP are ignored\. Option values can be enclosed
+in double quotes (\fB""\fP) to preserve leading and trailing whitespaces as
+well as to specify empty values\. If the value itself contains trailing or
+leading double quote, enclose it with an extra pair of double quotes, for
+example \fB""x""\fP\. Non-leading and non-trailing quotes are interpreted as
+being part of the option value\.
+
+The semantics of providing options in a file is equivalent to providing the
+same set of options in the same order on the command line at the point where
+the \fB--options-file\fP option is specified except that the shell escaping
+and quoting is not required\. Repeat this option to specify more than one
+options files\.
 
 .\"
 .\" DIAGNOSTICS
diff --git a/doc/cli.xhtml b/doc/cli.xhtml
index d39e8ac..5a136af 100644
--- a/doc/cli.xhtml
+++ b/doc/cli.xhtml
@@ -96,6 +96,10 @@
   <dt><code><b>--generate-modifier</b></code></dt>
   <dd>Generate option value modifiers in addition to accessors.</dd>
 
+  <dt><code><b>--generate-specifier</b></code></dt>
+  <dd>Generate functions for determining whether the option was specified on the
+  command line.</dd>
+
   <dt><code><b>--generate-file-scanner</b></code></dt>
   <dd>Generate the <code>argv_file_scanner</code> implementation. This scanner is
   capable of reading command line arguments from the <code>argv</code> array
@@ -207,12 +211,18 @@
   <dt><code><b>--options-file</b></code> <i>file</i></dt>
   <dd>Read additional options from <i>file</i> with each option appearing on a
   separate line optionally followed by space and an option value. Empty lines
-  and lines starting with <code><b>#</b></code> are ignored. The semantics of
-  providing options in a file is equivalent to providing the same set of
-  options in the same order on the command line at the point where the
-  <code><b>--options-file</b></code> option is specified except that shell
-  escaping and quoting is not required. Repeat this option to specify more
-  than one options files.</dd>
+  and lines starting with <code><b>#</b></code> are ignored. Option values can
+  be enclosed in double quotes (<code><b>""</b></code>) to preserve leading
+  and trailing whitespaces as well as to specify empty values. If the value
+  itself contains trailing or leading double quote, enclose it with an extra
+  pair of double quotes, for example <code><b>""x""</b></code>. Non-leading
+  and non-trailing quotes are interpreted as being part of the option value.
+
+  <p>The semantics of providing options in a file is equivalent to providing
+  the same set of options in the same order on the command line at the point
+  where the <code><b>--options-file</b></code> option is specified except that
+  the shell escaping and quoting is not required. Repeat this option to
+  specify more than one options files.</p></dd>
 
 </dl>
   <h1>DIAGNOSTICS</h1>
-- 
cgit v1.1