]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - sys-utils/rfkill.8
docs: Fix dead references to kernel documentation
[thirdparty/util-linux.git] / sys-utils / rfkill.8
index 0cb704070536197f6248f3f8477c6b5c53dc82cd..eb640954f2dc8f768af41fada9318096d6f9f7c3 100644 (file)
@@ -4,17 +4,24 @@
 rfkill \- tool for enabling and disabling wireless devices
 .SH SYNOPSIS
 .B rfkill
-.RI [ options ] " command" " [" id | type \ ...]
+.RI [ options ]
+.RI [ command ]
+.RI [ id|type \ ...]
 
 .SH DESCRIPTION
 .B rfkill
 lists, enabling and disabling wireless devices.
 
+The command "list" output format is deprecated and maintained for backward
+compatibility only. The new output format is the default when no command is
+specified or when the option \fB\-\-output\fR is used.
+
 The default output is subject to change.  So whenever possible, you should
 avoid using default outputs in your scripts.  Always explicitly define expected
 columns by using the \fB\-\-output\fR option together with a columns list in
 environments where a stable output is required.
 
+
 .SH OPTIONS
 .TP
 \fB\-J\fR, \fB\-\-json\fR
@@ -27,6 +34,9 @@ Do not print a header line.
 Specify which output columns to print.  Use \-\-help to get a list of
 available columns.
 .TP
+.B \-\-output\-all
+Output all available columns.
+.TP
 \fB\-r\fR, \fB\-\-raw\fR
 Use the raw output format.
 .TP
@@ -44,9 +54,8 @@ Display help text and exit.
 Listen for rfkill events and display them on stdout.
 .TP
 \fBlist \fR[\fIid\fR|\fItype\fR ...]
-List the current state of all available devices.  The full list has TYPE and
-ID columns that one can use to limit the scope.  It is a good idea to check
-with
+List the current state of all available devices.  The command output format is deprecated, see the section DESCRIPTION.
+It is a good idea to check with
 .B list
 command
 .IR id " or " type
@@ -66,7 +75,7 @@ Enable the corresponding device.  If the device is hard\-blocked, for example
 via a hardware switch, it will remain unavailable though it is now
 soft\-unblocked.
 .SH EXAMPLES
-rfkill list
+rfkill --output ID,TYPE
 .br
 rfkill block all
 .br
@@ -83,10 +92,14 @@ and
 .MT marcel@\:holtmann.\:org
 Marcel Holtmann
 .ME .
-The code has been later modifified by
+The code has been later modified by
 .MT kerolasa@\:iki.\:fi
 Sami Kerola
 .ME
+and
+.MT kzak@\:redhat.\:com
+Karel Zak
+.ME
 for util-linux project.
 .PP
 This manual page was written by
@@ -97,7 +110,7 @@ for the Debian project (and may be used by others).
 .SH "SEE ALSO"
 .BR powertop (8),
 .BR systemd-rfkill (8),
-.UR https://\:git.\:kernel.\:org/\:pub/\:scm/\:linux/\:kernel/\:git/\:torvalds/\:linux.git/\:tree/\:Documentation/\:rfkill.txt
+.UR https://\:git.\:kernel.\:org/\:pub/\:scm/\:linux/\:kernel/\:git/\:torvalds/\:linux.git/\:tree/\:Documentation/\:driver-api/\:rfkill.rst
 Linux kernel documentation
 .UE
 .SH AVAILABILITY