summaryrefslogtreecommitdiff
path: root/doc/avtools-common-opts.texi
diff options
context:
space:
mode:
authorDerek Buitenhuis <derek.buitenhuis@gmail.com>2013-03-30 15:21:36 -0400
committerDerek Buitenhuis <derek.buitenhuis@gmail.com>2013-03-31 18:22:09 -0400
commit0cb2d32453ed6eae54716c990ab51b355e535df1 (patch)
tree9bccd70c3de77b2ed3b847c87a53c62ee1b31b11 /doc/avtools-common-opts.texi
parenta034cdf49d1a434ab751c2cc9672973bc0238540 (diff)
doc: Fix broken English in the common options description
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Diffstat (limited to 'doc/avtools-common-opts.texi')
-rw-r--r--doc/avtools-common-opts.texi21
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/avtools-common-opts.texi b/doc/avtools-common-opts.texi
index c18f667bfa..37f27a9475 100644
--- a/doc/avtools-common-opts.texi
+++ b/doc/avtools-common-opts.texi
@@ -1,16 +1,17 @@
-All the numerical options, if not specified otherwise, accept in input
-a string representing a number, which may contain one of the
-SI unit prefixes, for example 'K', 'M', 'G'.
-If 'i' is appended after the prefix, binary prefixes are used,
-which are based on powers of 1024 instead of powers of 1000.
-The 'B' postfix multiplies the value by 8, and can be
-appended after a unit prefix or used alone. This allows using for
-example 'KB', 'MiB', 'G' and 'B' as number postfix.
+All the numerical options, if not specified otherwise, accept a string
+representing a number as input, which may be followed by one of the SI
+unit prefixes, for example: 'K', 'M', or 'G'.
+
+If 'i' is appended to the SI unit prefix, the complete prefix will be
+interpreted as a unit prefix for binary multiplies, which are based on
+powers of 1024 instead of powers of 1000. Appending 'B' to the SI unit
+prefix multiplies the value by 8. This allows using, for example:
+'KB', 'MiB', 'G' and 'B' as number suffixes.
Options which do not take arguments are boolean options, and set the
corresponding value to true. They can be set to false by prefixing
-with "no" the option name, for example using "-nofoo" in the
-command line will set to false the boolean option with name "foo".
+the option name with "no". For example using "-nofoo"
+will set the boolean option with name "foo" to false.
@anchor{Stream specifiers}
@section Stream specifiers