Skip to content

Commit 6cd68a2

Browse files
committed
Clarify docs. Fixes #1530.
[SVN r45448]
1 parent f0eae2c commit 6cd68a2

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

doc/overview.xml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,14 +185,16 @@ desc.add_options()
185185
("email", value<string>()->multitoken(), "email to send to")
186186
;
187187
</programlisting>
188-
For the first parameter, we specify only the name and the
189-
description. No value can be specified in the parsed source.
190-
For the first option, the user must specify a value, using a single
191-
token. For the third option, the user may either provide a single token
192-
for the value, or no token at all. For the last option, the value can
193-
span several tokens. For example, the following command line is OK:
188+
For the first option (<literal>help</literal>), we specify only the name
189+
and the description. No value can be specified in the parsed source.
190+
For the second option (<literal>compression</literal>), the user must
191+
specify a value, using a single token. For the third option
192+
(<literal>verbose</literal>), the user may either provide a single token
193+
for the value, or no token at all. For the last option
194+
(<literal>email</literal>), the value can span several tokens. For
195+
example, the following command line is OK:
194196
<screen>
195-
test --help --compression 10 --verbose --email beadle@mars beadle2@mars
197+
test --help --compression 10 --verbose --email beagle@mars beagle2@mars
196198
</screen>
197199
</para>
198200

0 commit comments

Comments
 (0)