]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
lsfd.1.adoc: Fix wording and markup
authorMario Blättermann <mario.blaettermann@gmail.com>
Thu, 2 Dec 2021 19:41:14 +0000 (20:41 +0100)
committerGitHub <noreply@github.com>
Thu, 2 Dec 2021 19:41:14 +0000 (20:41 +0100)
misc-utils/lsfd.1.adoc

index a67fa4ab046f85b889f46661c2b8304a8ab1bd1f..3062010ea3bb348ec5f2cb862d4e81218b4f1209 100644 (file)
@@ -42,8 +42,8 @@ Use JSON output format.
 Don't print headings.
 
 *-o*, *--output* _list_::
-Specify which output columns to print. See the "OUTPUT COLUMNS"
-section for details of available column.
+Specify which output columns to print. See the *OUTPUT COLUMNS*
+section for details of available columns.
 +
 The default list of columns may be extended if _list_ is specified in
 the format _+list_ (e.g., *lsfd -o +DELETED*).
@@ -55,38 +55,38 @@ Use raw output format.
 Don't truncate text in columns.
 
 *-p*, *--pid* _pids_::
-Collect information only specified processes.
+Collect information only for specified processes.
 _pids_ is a list of pids. A comma or whitespaces can be used as separators.
-You can use this option with *pidof*(1). See "FILTER EXAMPLES".
+You can use this option with *pidof*(1). See *FILTER EXAMPLES*.
 +
 Both *-Q* option with an expression including PID, e.g. -Q (PID == 1),
 and *-p* option, e.g. -p 1, may print the same output but using *-p*
-option is a much more efficient because *-p* option works much earlier
-stage of processing than *-Q* option.
+option is much more efficient because *-p* option works at a much earlier
+stage of processing than the *-Q* option.
 
 *-Q*, *--filter* _expr_::
-Print the files only satisfying with the condition represented by the _expr_.
-See also "FILTER EXAMPLES".
+Print only the files matching the condition represented by the _expr_.
+See also *FILTER EXAMPLES*.
 
 *-C*, *--counter* _label_:_filter_expr_::
 Define a custom counter used in *--summary* output. *lsfd* makes a
 counter named _label_. During collect information, *lsfd* counts files
-satisfying _filter_expr_, and stores the counted number to the
+matching _filter_expr_, and stores the counted number to the
 counter named _label_. *lsfd* applies filters defined with *--filter*
-options before couring; files excluded by the filters are not counted.
+options before counting; files excluded by the filters are not counted.
 +
-See "FILTER EXPRESSION" about _filter_expr_.
+See *FILTER EXPRESSION* about _filter_expr_.
 _label_ should not include _{_ nor _:_. You can define multiple
-counters with specifying this option multiple times.
+counters by specifying this option multiple times.
 +
-See also "COUNTER EXAMPLES".
+See also *COUNTER EXAMPLES*.
 
 *--summary*[=_when_]::
 This option controls summary lines output. The optional argument _when_
 can be *only*, *append* or *never*. If the _when_ argument is omitted,
-it defaults to *"only"*.
+it defaults to *only*.
 +
-The summary reports counters. A counter comes from a label and an
+The summary reports counters. A counter consists of a label and an
 integer value.  *--counter* is the option for defining a counter.  If
 a user defines no counter, *lsfd* uses the definitions of pre-defined
 built-in counters (default counters) to make the summary output.
@@ -95,7 +95,7 @@ CAUTION: Using *--summary* and *--json* may make the output broken. Only combini
 
 *--debug-filter*::
 Dump the internal data structure for the filter and exit. This is useful
-only for lsfd developers.
+only for *lsfd* developers.
 
 *--dump-counters*::
 Dump the definition of counters used in *--summary* output.
@@ -218,7 +218,7 @@ An expression consists of column names, literals and, operators like:
 Before evaluation, *lsfd* substitutes column names in the given
 expression with actual column values in the line. There are three
 different data types: _boolean_, _string_, and _number_.  For columns
-with a _boolean_ type, the vale can be stand-alone.  For _string_ and
+with a _boolean_ type, the value can be stand-alone.  For _string_ and
 _number_ values, the value must be an operand of an operator, for
 example, `(PID == 1)`. See the "OUTPUT COLUMNS" about the types of
 columns.
@@ -260,7 +260,7 @@ operators.  Use _(_ and _)_ explicitly for grouping the
 sub-expressions if your expression uses more than two operators.
 
 About _number_ typed values, the filter engine supports only
-zero or positive numbers.
+non-negative integers.
 
 === Semi-formal syntax