Mercurial > illumos > git > illumos-omnios

comparison usr/src/man/man1m/wificonfig.1m @ 23918:f3c8f3a2a25c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
13404 man page spelling errors Reviewed by: Ryan Zezeski <ryan@oxide.computer> Reviewed by: Robert Mustacchi <rm@fingolfin.org> Approved by: Richard Lowe <richlowe@richlowe.net>
author Peter Tribble <peter.tribble@gmail.com>
date Thu, 31 Dec 2020 10:47:42 +0000
parents 5b2854ecc12d
children
comparison
equal deleted inserted replaced
23917:265d423ec4f7 23918:f3c8f3a2a25c
1 '\" te 1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved 2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. 3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. 4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] 5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH WIFICONFIG 1M "Oct 31, 2007" 6 .TH WIFICONFIG 1M "December 28, 2020"
7 .SH NAME 7 .SH NAME
8 wificonfig \- WLAN configuration 8 wificonfig \- WLAN configuration
9 .SH SYNOPSIS 9 .SH SYNOPSIS
10 .LP
11 .nf 10 .nf
12 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] autoconf 11 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] autoconf
13 [\fIwait\fR={\fIn\fR|\fIforever\fR}] 12 [\fIwait\fR={\fIn\fR|\fIforever\fR}]
14 .fi 13 .fi
15 14
115 .nf 114 .nf
116 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] setprefer \fIprofile\fR [\fIn\fR] 115 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] setprefer \fIprofile\fR [\fIn\fR]
117 .fi 116 .fi
118 117
119 .SH DESCRIPTION 118 .SH DESCRIPTION
120 .sp
121 .LP
122 \fBwificonfig\fR defines a set of subcommands and parameters to configure 119 \fBwificonfig\fR defines a set of subcommands and parameters to configure
123 \fBWiFi\fR interfaces in the system. A driver may support all parameters or a 120 \fBWiFi\fR interfaces in the system. A driver may support all parameters or a
124 subset of these parameters. 121 subset of these parameters.
125 .sp 122 .sp
126 .LP 123 .LP
165 be found, \fBwificonfig\fR uses its built-in heuristics to automatically 162 be found, \fBwificonfig\fR uses its built-in heuristics to automatically
166 configure the interface. (See the \fBautoconf\fR subcommand for the 163 configure the interface. (See the \fBautoconf\fR subcommand for the
167 heuristics). A few subcommands (\fBlistprefer\fR, \fBsetprefer\fR, 164 heuristics). A few subcommands (\fBlistprefer\fR, \fBsetprefer\fR,
168 \fBremoveprefer\fR) are defined to manipulate the Preference List. 165 \fBremoveprefer\fR) are defined to manipulate the Preference List.
169 .SH OPTIONS 166 .SH OPTIONS
170 .sp
171 .LP
172 The following options are supported: 167 The following options are supported:
173 .sp 168 .sp
174 .ne 2 169 .ne 2
175 .na 170 .na
176 \fB\fB-i\fR \fIinterface\fR\fR 171 \fB\fB-i\fR \fIinterface\fR\fR
189 affects the location of the private files where \fBwificonfig\fR stores the 184 affects the location of the private files where \fBwificonfig\fR stores the
190 Configuration Profiles and \fBWEP\fR keys. 185 Configuration Profiles and \fBWEP\fR keys.
191 .RE 186 .RE
192 187
193 .SS "OPERANDS" 188 .SS "OPERANDS"
194 .sp
195 .LP
196 The following operand is supported: 189 The following operand is supported:
197 .sp 190 .sp
198 .ne 2 191 .ne 2
199 .na 192 .na
200 \fBprofile\fR 193 \fBprofile\fR
205 and any strings contained in brackets, such as "[foo]", are not allowed as a 198 and any strings contained in brackets, such as "[foo]", are not allowed as a
206 profile name. 199 profile name.
207 .RE 200 .RE
208 201
209 .SS "SUBCOMMANDS" 202 .SS "SUBCOMMANDS"
210 .sp
211 .LP
212 The following subcommands are supported: 203 The following subcommands are supported:
213 .sp 204 .sp
214 .ne 2 205 .ne 2
215 .na 206 .na
216 \fB\fBautoconf\fR [wait={\fIn\fR|\fIforever\fR}]\fR 207 \fB\fBautoconf\fR [wait={\fIn\fR|\fIforever\fR}]\fR
263 equivalent to the \fBrestoredef\fR subcommand, except that the "essid" 254 equivalent to the \fBrestoredef\fR subcommand, except that the "essid"
264 parameter is set as "profile". 255 parameter is set as "profile".
265 .sp 256 .sp
266 If the \fBWLAN\fRs in the Preference list are available, the user can specify 257 If the \fBWLAN\fRs in the Preference list are available, the user can specify
267 the number of seconds to wait before \fBconnect\fR returns using the wait 258 the number of seconds to wait before \fBconnect\fR returns using the wait
268 option. By default (without the wait option), \fBconnect\fR trys for 10 259 option. By default (without the wait option), \fBconnect\fR tries for 10
269 seconds. If "\fIforever\fR" or -1 follows the wait option, \fBwificonfig\fR 260 seconds. If "\fIforever\fR" or -1 follows the wait option, \fBwificonfig\fR
270 tries until the \fBNIC\fR is successfully connected to the profile or essid 261 tries until the \fBNIC\fR is successfully connected to the profile or essid
271 that was specified. 262 that was specified.
272 .sp 263 .sp
273 The \fBconnect\fR subcommand prints one of the following lines depending on 264 The \fBconnect\fR subcommand prints one of the following lines depending on
274 whether or not a Configuration Profile was found for the specified name: 265 whether or not a Configuration Profile was found for the specified name:
275 .sp 266 .sp
276 .in +2 267 .in +2
277 .nf 268 .nf
278 Connecting to profile <name> 269 Connecting to profile <name>
279 Connecting to essid <name> 270 Connecting to essid <name>
280 .fi 271 .fi
281 .in -2 272 .in -2
282 .sp 273 .sp
283 274
779 The "solaris.network.wifi.config" authorization is required for this 770 The "solaris.network.wifi.config" authorization is required for this
780 subcommand. 771 subcommand.
781 .RE 772 .RE
782 773
783 .SH EXAMPLES 774 .SH EXAMPLES
784 .LP
785 \fBExample 1 \fRListing the Parameters Supported by a Driver 775 \fBExample 1 \fRListing the Parameters Supported by a Driver
786 .sp 776 .sp
787 .LP 777 .LP
788 To display what parameters the \fIath\fR driver supports and the read/write 778 To display what parameters the \fIath\fR driver supports and the read/write
789 modes of the parameters: 779 modes of the parameters:
882 % wificonfig history 872 % wificonfig history
883 873
884 WLAN history: 874 WLAN history:
885 875
886 essid bssid encryption last seen 876 essid bssid encryption last seen
887 myXXX 00:0f:24:11:12:14 WEP Fri Sep 13 09:15:24 2004 877 myXXX 00:0f:24:11:12:14 WEP Fri Sep 13 09:15:24 2004
888 my_office_ssid 00:0f:24:11:12:15 WEP Fri Sep 13 13:20:04 2004 878 my_office_ssid 00:0f:24:11:12:15 WEP Fri Sep 13 13:20:04 2004
889 my_neighbor1 00:0f:24:11:12:16 NONE Fri Sep 14 08:01:26 2004 879 my_neighbor1 00:0f:24:11:12:16 NONE Fri Sep 14 08:01:26 2004
890 my_neighbor2 00:0f:24:11:12:17 WEP Fri Sep 18 21:33:12 2004 880 my_neighbor2 00:0f:24:11:12:17 WEP Fri Sep 18 21:33:12 2004
891 .fi 881 .fi
892 .in -2 882 .in -2
893 .sp 883 .sp
894 884
895 .LP 885 .LP
908 .sp 898 .sp
909 899
910 .sp 900 .sp
911 .LP 901 .LP
912 If the Preference List is empty, or none of the \fBWLAN\fRs listed by the 902 If the Preference List is empty, or none of the \fBWLAN\fRs listed by the
913 Proference List can be found, \fBwificonfig\fR uses the default configuration, 903 Preference List can be found, \fBwificonfig\fR uses the default configuration,
914 directs the interface to scan and join the \fBWLAN\fR using the built-in 904 directs the interface to scan and join the \fBWLAN\fR using the built-in
915 heuristics specified above. 905 heuristics specified above.
916 906
917 .LP 907 .LP
918 \fBExample 7 \fRConnecting To a WLAN 908 \fBExample 7 \fRConnecting To a WLAN
1009 .fi 999 .fi
1010 .in -2 1000 .in -2
1011 .sp 1001 .sp
1012 1002
1013 .SH EXIT STATUS 1003 .SH EXIT STATUS
1014 .sp
1015 .ne 2 1004 .ne 2
1016 .na 1005 .na
1017 \fB\fB0\fR\fR 1006 \fB\fB0\fR\fR
1018 .ad 1007 .ad
1019 .RS 5n 1008 .RS 5n
1047 .RS 5n 1036 .RS 5n
1048 Minor error 1037 Minor error
1049 .RE 1038 .RE
1050 1039
1051 .SH ATTRIBUTES 1040 .SH ATTRIBUTES
1052 .sp
1053 .LP
1054 See \fBattributes\fR(5) for descriptions of the following attributes: 1041 See \fBattributes\fR(5) for descriptions of the following attributes:
1055 .sp 1042 .sp
1056 1043
1057 .sp 1044 .sp
1058 .TS 1045 .TS
1063 _ 1050 _
1064 Interface Stability Unstable 1051 Interface Stability Unstable
1065 .TE 1052 .TE
1066 1053
1067 .SH SEE ALSO 1054 .SH SEE ALSO
1068 .sp
1069 .LP
1070 \fBps\fR(1), \fBifconfig\fR(1M), \fBattributes\fR(5), \fBath\fR(7D) 1055 \fBps\fR(1), \fBifconfig\fR(1M), \fBattributes\fR(5), \fBath\fR(7D)