-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathterm_wifi.1
153 lines (125 loc) · 5.78 KB
/
term_wifi.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.TH term_wifi 1 " 08 March 24"
.SH SYNOPSIS
.P
term_wifi is a command-line or terminal-menu based wifi setup tool intended for machines that lack a graphical environment. Initially only IP4 is supported when not using dhcp. This program is a front-end to the iw, iwconfig and wpa_supplicant tools, and should automatically find them if they\(aqre in /bin, /usr/bin, /sbin or /usr/sbin.
.P
Most operations that involve wifi will have to be performed as the root user. Either run this program as root or, when running as another user, the program will prompt you for your root or sudo password. This is not stored in any config file.
.P
The program can be used in command-line mode, or in the default \(aqinteractive\(aq mode that displays a simple terminal user interface.
.SH REQUIRED HELPER PROGRAMS
.P
term_wifi requires iwconfig or iw to be installed for wifi scanning/setup, wpa_supplicant for WPA networks, dhcpcd for dhcp support and ifconfig and route for network setup.
.P
if term_wifi is not run as root, then it will try to use sudo, or if that\(aqs not installed, su, to run network commands with root permissions.
.P
qr-code export requires qrencode utility to be installed, and also an image viewer. term_wifi searches for a default list of image viewers, but this can be overridden with the
.na
\-viewer
.ad
option.
.SH USAGE
.nf
term_wifi interfaces list interfaces
term_wifi scan <interface> scan networks and output details
term_wifi add <essid> <address> <netmask> <gateway> <dns server> add a config for a network
term_wifi add <essid> dhcp add a config for a network using dhcp
term_wifi forget <essid> delete (forget) network
term_wifi list list configured networks
term_wifi join <interface> <essid> join a configured network
term_wifi leave <interface> leave current network
term_wifi connect <essid> join configured network with default interface
term_wifi qrcode <essid> display qr code for saved network with essid '<essid>\(aq
term_wifi qrcode <essid> \-viewer <list> display qr code for saved network with essid '<essid>' using first viewer program found in comma\-separated list '<list>\(aq
term_wifi qrcode <essid> \-o <path> write qr code for network '<essid>' to PNG file at <path>
term_wifi \-? this help
term_wifi \-h this help
term_wifi \-help this help
term_wifi \-\-help this help
options that apply to connect/interactive mode
\-i <interface> interface to use
\-ap <access point mac address> access point to join (if many for same essid)
\-k <key> authentication key for given essid/network)
.fi
.ad b
.P
you can use
.na
\-i <interface>
.ad
to specify and interface to use for the \(aqconnect\(aq, \(aqscan\(aq and tui commands.
.SH INTERACTIVE (USER INTERFACE) MODE
.P
if term_wifi is run without any arguments the user will be presented with a simple terminal user interface. You can use the \(aq-i\(aq option to show the tui for a given wifi device like so:
.nf
term_wifi \-i wlan1
.fi
.ad b
.SH EXAMPLES: Command line mode
.P
To view available wifi networks:
.nf
term_wifi scan <interface>
.fi
.ad b
.P
To configure a wifi network for use:
.nf
term_wifi add <essid> dhcp
term_wifi add <essid> <ip4 address> <netmask> <gateway> <dns server>
.fi
.ad b
.P
You can add a network to the stored config with either of these commands. These two commands also accept
.na
\-k <key>` and `\-ap <access point>
.ad
options. the
.na
\-k
.ad
option allows specifying the wifi key/password. If it\(aqs not specified with this option then the user will be prompted for it. The
.na
\-ap
.ad
option allows specifiying an access-point mac address, in order to distinguish different networks with the same essid.
.P
Once a setup is added to known networks you can join to it with:
.nf
term_wifi join <interface> <essid>
.fi
.ad b
.P
\(aqconnect\(aq does the same thing as \(aqjoin\(aq but uses the default interface:
.nf
term_wifi connect <essid>
.fi
.ad b
.P
If a wifi password is not known at this stage, you will be prompted for one. If the current user is not root you will likely be prompted for the system root password too.
.P
To leave a wifi network that you\(aqre currently connected to use:
.nf
term_wifi leave <interface>
.fi
.ad b
.P
To view available wifi interfaces:
.nf
term_wifi interfaces
.fi
.ad b
.P
To view currently configured wifi networks:
.nf
term_wifi list
.fi
.ad b
.P
To \(aqforget\(aq (delete) a configured network
.nf
term_wifi forget <essid>
.fi
.ad b
.SH QR CODES
.P
the command-line \(aqqrcode\(aq action will produce a qrcode PNG and attempt to find an image-viewer to display it. You can specify an image-viewer command using the \(aq-viewer\(aq option. Failing that, term_wifi has an internal list of image-viewer programs to try. After all the image viewers, there are two options that output sixel images to the terminal, provided your terminal supports sixel image display. Finally, if nothing matching is found, the ultimate fallback is to use qrencodes \(aqANSI256\(aq display message to create a giant QR code with ANSI graphics.