]> git.ipfire.org Git - thirdparty/util-linux.git/blob - sys-utils/rfkill.8
docs: (man) remove double quotes (") in .SH lines
[thirdparty/util-linux.git] / sys-utils / rfkill.8
1 .\" -*- nroff -*-
2 .TH RFKILL "8" "2017-07-06" "util-linux" "System Administration"
3 .SH NAME
4 rfkill \- tool for enabling and disabling wireless devices
5 .SH SYNOPSIS
6 .B rfkill
7 .RI [ options ]
8 .RI [ command ]
9 .RI [ id|type \ ...]
10
11 .SH DESCRIPTION
12 .B rfkill
13 lists, enabling and disabling wireless devices.
14
15 The command "list" output format is deprecated and maintained for backward
16 compatibility only. The new output format is the default when no command is
17 specified or when the option \fB\-\-output\fR is used.
18
19 The default output is subject to change. So whenever possible, you should
20 avoid using default outputs in your scripts. Always explicitly define expected
21 columns by using the \fB\-\-output\fR option together with a columns list in
22 environments where a stable output is required.
23
24
25 .SH OPTIONS
26 .TP
27 \fB\-J\fR, \fB\-\-json\fR
28 Use JSON output format.
29 .TP
30 \fB\-n\fR, \fB\-\-noheadings\fR
31 Do not print a header line.
32 .TP
33 \fB\-o\fR, \fB\-\-output\fR
34 Specify which output columns to print. Use \-\-help to get a list of
35 available columns.
36 .TP
37 .B \-\-output\-all
38 Output all available columns.
39 .TP
40 \fB\-r\fR, \fB\-\-raw\fR
41 Use the raw output format.
42 .TP
43 .B \-\-help
44 Display help text and exit.
45 .TP
46 .B \-\-version
47 Display version information and exit.
48 .SH COMMANDS
49 .TP
50 .B help
51 Display help text and exit.
52 .TP
53 .B event
54 Listen for rfkill events and display them on stdout.
55 .TP
56 \fBlist \fR[\fIid\fR|\fItype\fR ...]
57 List the current state of all available devices. The command output format is deprecated, see the section DESCRIPTION.
58 It is a good idea to check with
59 .B list
60 command
61 .IR id " or " type
62 scope is appropriate before setting
63 .BR block " or " unblock .
64 Special
65 .I all
66 type string will match everything. Use of multiple
67 .IR id " or " type
68 arguments is supported.
69 .TP
70 \fBblock \fBid\fR|\fBtype\fR [...]
71 Disable the corresponding device.
72 .TP
73 \fBunblock \fBid\fR|\fBtype\fR [...]
74 Enable the corresponding device. If the device is hard\-blocked, for example
75 via a hardware switch, it will remain unavailable though it is now
76 soft\-unblocked.
77 .SH EXAMPLES
78 rfkill --output ID,TYPE
79 .br
80 rfkill block all
81 .br
82 rfkill unblock wlan
83 .br
84 rfkill block bluetooth uwb wimax wwan gps fm nfc
85 .SH AUTHORS
86 .B rfkill
87 was originally written by
88 .MT johannes@\:sipsolutions.\:net
89 Johannes Berg
90 .ME
91 and
92 .MT marcel@\:holtmann.\:org
93 Marcel Holtmann
94 .ME .
95 The code has been later modified by
96 .MT kerolasa@\:iki.\:fi
97 Sami Kerola
98 .ME
99 and
100 .MT kzak@\:redhat.\:com
101 Karel Zak
102 .ME
103 for util-linux project.
104 .PP
105 This manual page was written by
106 .MT linux@\:youmustbejoking.\:demon.\:co.uk
107 Darren Salt
108 .ME ,
109 for the Debian project (and may be used by others).
110 .SH SEE ALSO
111 .BR powertop (8),
112 .BR systemd-rfkill (8),
113 .UR https://\:git.\:kernel.\:org/\:pub/\:scm/\:linux/\:kernel/\:git/\:torvalds/\:linux.git/\:tree/\:Documentation/\:driver-api/\:rfkill.rst
114 Linux kernel documentation
115 .UE
116 .SH AVAILABILITY
117 The rfkill command is part of the util\-linux package and is available from
118 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util\-linux/
119 Linux Kernel Archive
120 .UE .