]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
zramctl: (man) mention the required arguments for -p and -r
authorBenno Schulenberg <bensberg@telfort.nl>
Sun, 6 Apr 2025 15:21:47 +0000 (17:21 +0200)
committerKarel Zak <kzak@redhat.com>
Tue, 8 Apr 2025 10:37:27 +0000 (12:37 +0200)
Also, sort the options strictly alphabetically ("r" before "raw").

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
sys-utils/zramctl.8.adoc
sys-utils/zramctl.c

index 4cc402e5c789b2c64a942b50e0835121738cb163..c08f1e0050321bebc9a7e2b6fd1d0c8d1b5ac372 100644 (file)
@@ -54,18 +54,21 @@ Define the status output columns to be used. If no output arrangement is specifi
 +
 The default list of columns may be extended if _list_ is specified in the format _+list_ (e.g., *zramctl -o+COMP-RATIO*).
 
-*-p*, *--algorithm-params*::
-Set the algorithm parameters, for example, *level=9 dict=/etc/dictionary* to set compression level and pre-trained dictionary. Parameters are algorithm specific.
-
 *--output-all*::
 Output all available columns.
 
+*-p*, *--algorithm-params* _parameter_...::
+Specify the parameters for the selected compression algorithm.
+For example, *level=9 dict=/etc/dictionary* sets the compression level
+and pre-trained dictionary. Parameters are algorithm-specific.
+
+*-r*, *--reset* _zramdev_...::
+Reset the specified zram device(s).
+The settings of a zram device can be changed only after a reset.
+
 *--raw*::
 Use the raw format for status output.
 
-*-r*, *--reset*::
-Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset.
-
 *-s*, *--size* _size_::
 Create a zram device of the specified _size_. Zram devices are aligned to memory pages; when the requested _size_ is not a multiple of the page size, it will be rounded up to the next multiple. When not otherwise specified, the unit of the _size_ parameter is bytes.
 +
index b9ea5998ef824aee0fc5f6e5fe70a6b76879ec58..fdb173ea59226e0c829272333ec092586bb2dd90 100644 (file)
@@ -751,9 +751,9 @@ static void __attribute__((__noreturn__)) usage(void)
        fputs(_(" -n, --noheadings          don't print headings\n"), out);
        fputs(_(" -o, --output <list>       columns to use for status output\n"), out);
        fputs(_("     --output-all          output all columns\n"), out);
-       fputs(_(" -p, --algorithm-params <parameters>\n"
+       fputs(_(" -p, --algorithm-params <parameter>...\n"
                "                           parameters for the compression algorithm\n"), out);
-       fputs(_(" -r, --reset               reset all specified devices\n"), out);
+       fputs(_(" -r, --reset <device>...   reset the specified zram devices\n"), out);
        fputs(_("     --raw                 use raw status output format\n"), out);
        fputs(_(" -s, --size <size>         device size\n"), out);
        fputs(_(" -t, --streams <number>    number of compression streams\n"), out);