initial packaging for Debian
[debian/uaputl] / debian / uaputl.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH UAPUTL 1 "July 20, 2011"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 uaputl \- configure Marvell uAP wireless driver
20 .SH SYNOPSIS
21 .B uaputl
22 .RI [ options ] 
23 .RI < command > 
24 .RI [ parameters ]
25 .SH DESCRIPTION
26 This manual page documents briefly the
27 .B uaputl command, which is used to configure the device driver for Marvell's 
28 uAP wireless interface.
29 .SH OPTIONS
30 .TP
31 .B \-d <debug_level>
32 Enable debugging output, level can be 0, 1, or 2.
33 .TP
34 .B \-h, \-\-help
35 Show summary of options and commands.
36 .TP
37 .B \-i <interface>
38 Select interface to configure.
39 .TP
40 .B \-v
41 Show version of program.
42 .SH COMMANDS
43 For more information on the usage of each command use:
44         uaputl.exe <command> --help
45 .TP
46 .B sys_config
47 Set/get uAP's profile
48 .TP
49 .B sys_info                     
50 Display system info
51 .TP
52 .B sys_reset                    
53 Reset uAP
54 .TP
55 .B bss_start                    
56 Start the BSS
57 .TP
58 .B bss_stop                     
59 Stop the BSS
60 .TP
61 .B sta_deauth                   
62 Deauth client
63 .TP
64 .B sta_list                     
65 Display list of clients
66 .TP
67 .B sys_cfg_ap_mac_address               
68 Set/get uAP mac address
69 .TP
70 .B sys_cfg_ssid                 
71 Set/get uAP ssid
72 .TP
73 .B sys_cfg_beacon_period                
74 Set/get uAP beacon period
75 .TP
76 .B sys_cfg_dtim_period          
77 Set/get uAP dtim period
78 .TP
79 .B sys_cfg_channel                      
80 Set/get uAP radio channel
81 .TP
82 .B sys_cfg_scan_channels                
83 Set/get uAP radio channel list
84 .TP
85 .B sys_cfg_rates                        
86 Set/get uAP rates
87 .TP
88 .B sys_cfg_rates_ext            
89 Set/get uAP rates (extended)
90 .TP
91 .B sys_cfg_tx_power             
92 Set/get uAP tx power
93 .TP
94 .B sys_cfg_bcast_ssid_ctl               
95 Set/get uAP broadcast ssid
96 .TP
97 .B sys_cfg_preamble_ctl         
98 Get uAP preamble
99 .TP
100 .B sys_cfg_antenna_ctl          
101 Set/get uAP tx/rx antenna
102 .TP
103 .B sys_cfg_rts_threshold                
104 Set/get uAP rts threshold
105 .TP
106 .B sys_cfg_frag_threshold               
107 Set/get uAP frag threshold
108 .TP
109 .B sys_cfg_radio_ctl            
110 Set/get uAP radio on/off
111 .TP
112 .B sys_cfg_tx_data_rate         
113 Set/get uAP tx rate
114 .TP
115 .B sys_cfg_mcbc_data_rate               
116 Set/get uAP MCBC rate
117 .TP
118 .B sys_cfg_rsn_replay_prot              
119 Set/get RSN replay protection
120 .TP
121 .B sys_cfg_pkt_fwd_ctl          
122 Set/get uAP packet forwarding
123 .TP
124 .B sys_cfg_sta_ageout_timer             
125 Set/get station ageout timer
126 .TP
127 .B sys_cfg_auth                 
128 Set/get uAP authentication mode
129 .TP
130 .B sys_cfg_protocol             
131 Set/get uAP security protocol
132 .TP
133 .B sys_cfg_wep_key                      
134 Set/get uAP wep key
135 .TP
136 .B sys_cfg_cipher                       
137 Set/get uAP WPA/WPA cipher
138 .TP
139 .B sys_cfg_wpa_passphrase               
140 Set/get uAP WPA or WPA2 passphrase
141 .TP
142 .B sys_cfg_group_rekey_timer            
143 Set/get uAP group re-key time
144 .TP
145 .B sys_cfg_max_sta_num          
146 Set/get uAP max station number
147 .TP
148 .B sys_cfg_retry_limit          
149 Set/get uAP retry limit number
150 .TP
151 .B sys_cfg_custom_ie                    
152 Set/get custom IE configuration
153 .TP
154 .B sta_filter_table             
155 Set/get uAP mac filter
156 .TP
157 .B regrdwr                              
158 Read/Write register command
159 .TP
160 .B memaccess                    
161 Read/Write to a memory address command
162 .TP
163 .B rdeeprom                     
164 Read EEPROM 
165 .TP
166 .B cfg_data                     
167 Get/Set configuration file from/to firmware
168 .TP
169 .B sys_debug                    
170 Set/Get debug parameter
171 .TP
172 .B sys_cfg_80211d                       
173 Set/Get 802.11D info
174 .TP
175 .B uap_stats                    
176 Get uAP stats
177 .TP
178 .B powermode                    
179 Set/get uAP power mode
180 .TP
181 .B coex_config                  
182 Set/get uAP BT coex configuration
183 .SH SEE ALSO
184 .BR uapevent (1).
185 .br
186 .PP
187 This manual page was written by Bdale Garbee <bdale@gag.com>,
188 for the Debian project (and may be used by others).