]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - sys-utils/rfkill.8
su: change error message
[thirdparty/util-linux.git] / sys-utils / rfkill.8
index c79e24365f15c194043773b20b50d3123377b256..9eff913b8adba8730b4776661a66f8f1c2b22f74 100644 (file)
@@ -1,10 +1,27 @@
 .\" -*- nroff -*-
-.TH RFKILL "8" "2017-06-24" "util-linux" "System Administration"
+.TH RFKILL "8" "2017-07-06" "util-linux" "System Administration"
 .SH NAME
 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
@@ -17,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
@@ -33,32 +53,35 @@ Display help text and exit.
 .B event
 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
+\fBlist \fR[\fIid\fR|\fItype\fR ...]
+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
-.BR id " or " type
+.IR id " or " type
 scope is appropriate before setting
 .BR block " or " unblock .
 Special
-.B all
-type string will match everything.
+.I all
+type string will match everything.  Use of multiple
+.IR id " or " type
+arguments is supported.
 .TP
-\fBblock \fBid\fR|\fBtype\fR
+\fBblock \fBid\fR|\fBtype\fR [...]
 Disable the corresponding device.
 .TP
-\fBunblock \fBid\fR|\fBtype\fR
+\fBunblock \fBid\fR|\fBtype\fR [...]
 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
 rfkill unblock wlan
+.br
+rfkill block bluetooth uwb wimax wwan gps fm nfc
 .SH AUTHORS
 .B rfkill
 was originally written by
@@ -69,6 +92,15 @@ and
 .MT marcel@\:holtmann.\:org
 Marcel Holtmann
 .ME .
+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
 .MT linux@\:youmustbejoking.\:demon.\:co.uk
@@ -77,6 +109,7 @@ Darren Salt
 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
 Linux kernel documentation
 .UE