fix man page formatting error
[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 
28 command, which is used to configure the device driver for Marvell's 
29 uAP wireless interface.
30 .SH OPTIONS
31 .TP
32 .B \-d <debug_level>
33 Enable debugging output, level can be 0, 1, or 2.
34 .TP
35 .B \-h, \-\-help
36 Show summary of options and commands.
37 .TP
38 .B \-i <interface>
39 Select interface to configure.
40 .TP
41 .B \-v
42 Show version of program.
43 .SH COMMANDS
44 For more information on the usage of each command use:
45         uaputl.exe <command> --help
46 .TP
47 .B sys_config
48 Set/get uAP's profile
49 .TP
50 .B sys_info                     
51 Display system info
52 .TP
53 .B sys_reset                    
54 Reset uAP
55 .TP
56 .B bss_start                    
57 Start the BSS
58 .TP
59 .B bss_stop                     
60 Stop the BSS
61 .TP
62 .B sta_deauth                   
63 Deauth client
64 .TP
65 .B sta_list                     
66 Display list of clients
67 .TP
68 .B sys_cfg_ap_mac_address               
69 Set/get uAP mac address
70 .TP
71 .B sys_cfg_ssid                 
72 Set/get uAP ssid
73 .TP
74 .B sys_cfg_beacon_period                
75 Set/get uAP beacon period
76 .TP
77 .B sys_cfg_dtim_period          
78 Set/get uAP dtim period
79 .TP
80 .B sys_cfg_channel                      
81 Set/get uAP radio channel
82 .TP
83 .B sys_cfg_scan_channels                
84 Set/get uAP radio channel list
85 .TP
86 .B sys_cfg_rates                        
87 Set/get uAP rates
88 .TP
89 .B sys_cfg_rates_ext            
90 Set/get uAP rates (extended)
91 .TP
92 .B sys_cfg_tx_power             
93 Set/get uAP tx power
94 .TP
95 .B sys_cfg_bcast_ssid_ctl               
96 Set/get uAP broadcast ssid
97 .TP
98 .B sys_cfg_preamble_ctl         
99 Get uAP preamble
100 .TP
101 .B sys_cfg_antenna_ctl          
102 Set/get uAP tx/rx antenna
103 .TP
104 .B sys_cfg_rts_threshold                
105 Set/get uAP rts threshold
106 .TP
107 .B sys_cfg_frag_threshold               
108 Set/get uAP frag threshold
109 .TP
110 .B sys_cfg_radio_ctl            
111 Set/get uAP radio on/off
112 .TP
113 .B sys_cfg_tx_data_rate         
114 Set/get uAP tx rate
115 .TP
116 .B sys_cfg_mcbc_data_rate               
117 Set/get uAP MCBC rate
118 .TP
119 .B sys_cfg_rsn_replay_prot              
120 Set/get RSN replay protection
121 .TP
122 .B sys_cfg_pkt_fwd_ctl          
123 Set/get uAP packet forwarding
124 .TP
125 .B sys_cfg_sta_ageout_timer             
126 Set/get station ageout timer
127 .TP
128 .B sys_cfg_auth                 
129 Set/get uAP authentication mode
130 .TP
131 .B sys_cfg_protocol             
132 Set/get uAP security protocol
133 .TP
134 .B sys_cfg_wep_key                      
135 Set/get uAP wep key
136 .TP
137 .B sys_cfg_cipher                       
138 Set/get uAP WPA/WPA cipher
139 .TP
140 .B sys_cfg_wpa_passphrase               
141 Set/get uAP WPA or WPA2 passphrase
142 .TP
143 .B sys_cfg_group_rekey_timer            
144 Set/get uAP group re-key time
145 .TP
146 .B sys_cfg_max_sta_num          
147 Set/get uAP max station number
148 .TP
149 .B sys_cfg_retry_limit          
150 Set/get uAP retry limit number
151 .TP
152 .B sys_cfg_custom_ie                    
153 Set/get custom IE configuration
154 .TP
155 .B sta_filter_table             
156 Set/get uAP mac filter
157 .TP
158 .B regrdwr                              
159 Read/Write register command
160 .TP
161 .B memaccess                    
162 Read/Write to a memory address command
163 .TP
164 .B rdeeprom                     
165 Read EEPROM 
166 .TP
167 .B cfg_data                     
168 Get/Set configuration file from/to firmware
169 .TP
170 .B sys_debug                    
171 Set/Get debug parameter
172 .TP
173 .B sys_cfg_80211d                       
174 Set/Get 802.11D info
175 .TP
176 .B uap_stats                    
177 Get uAP stats
178 .TP
179 .B powermode                    
180 Set/get uAP power mode
181 .TP
182 .B coex_config                  
183 Set/get uAP BT coex configuration
184 .SH SEE ALSO
185 .BR uapevent (1).
186 .br
187 .PP
188 This manual page was written by Bdale Garbee <bdale@gag.com>,
189 for the Debian project (and may be used by others).