docs: Fix dead references to kernel documentation

[thirdparty/util-linux.git] / sys-utils / zramctl.8

diff --git a/sys-utils/zramctl.8 b/sys-utils/zramctl.8
index 74240a1ca4dfeea581eff983891a606e2a73d4c8..12983f144376d42638766787a5fa58e9d52f7820 100644 (file)
--- a/sys-utils/zramctl.8
+++ b/sys-utils/zramctl.8
@@ -39,16 +39,21 @@ Set up a zram device:
 .SH DESCRIPTION
 .B zramctl
 is used to quickly set up zram device parameters, to reset zram devices, and to
-query the status of used zram devices.  If no option is given, all zram devices
-are shown.
-
+query the status of used zram devices.
+.PP
+If no option is given, all non-zero size zram devices are shown.
+.PP
+Note that \fIzramdev\fP node specified on command line has to already exist. The command
+.B zramctl
+creates a new /dev/zram<N> nodes only when \fB\-\-find\fR option specified. It's possible
+(and common) that after system boot /dev/zram<N> nodes are not created yet.
 .SH OPTIONS
 .TP
-.BR \-a , " \-\-algorithm lzo" | lz4
+.BR \-a , " \-\-algorithm lzo" | lz4 | lz4hc | deflate | 842
 Set the compression algorithm to be used for compressing data in the zram device.
 .TP
 .BR \-f , " \-\-find"
-Find the first unused zram device.  If a \fB--size\fR argument is present, then
+Find the first unused zram device.  If a \fB\-\-size\fR argument is present, then
 initialize the device.
 .TP
 .BR \-n , " \-\-noheadings"
@@ -59,6 +64,9 @@ Define the status output columns to be used.  If no output arrangement is
 specified, then a default set is used.
 Use \fB\-\-help\fP to get a list of all supported columns.
 .TP
+.B \-\-output\-all
+Output all available columns.
+.TP
 .B \-\-raw
 Use the raw format for status output.
 .TP
@@ -67,9 +75,11 @@ Reset the options of the specified zram device(s).  Zram device settings
 can be changed only after a reset.
 .TP
 .BR \-s , " \-\-size " \fIsize
-Force the zram driver to reread the size of the file associated with
-the specified zram device
-
+Create a zram device of the specified \fIsize\fR.
+Zram devices are aligned to memory pages; when the requested \fIsize\fR 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 \fIsize\fR parameter is bytes.
+.IP
 The \fIsize\fR argument may be followed by the multiplicative suffixes KiB (=1024),
 MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB"
 is optional, e.g., "K" has the same meaning as "KiB") or the suffixes
@@ -107,6 +117,10 @@ and use it as swap device.
 # swapoff /dev/zram0
 # zramctl --reset /dev/zram0
 .fi
+.SH SEE ALSO
+.UR http://git.\:kernel.\:org\:/cgit\:/linux\:/kernel\:/git\:/torvalds\:/linux.git\:/tree\:/Documentation\:/admin-guide\:/blockdev\:/zram.rst
+Linux kernel documentation
+.UE .
 .SH AUTHORS
 .nf
 Timofey Titovets <nefelim4ag@gmail.com>
@@ -114,4 +128,4 @@ Karel Zak <kzak@redhat.com>
 .fi
 .SH AVAILABILITY
 The zramctl command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+https://www.kernel.org/pub/linux/utils/util-linux/.