initial packaging for Debian
[debian/uaputl] / debian / uaputl.1
diff --git a/debian/uaputl.1 b/debian/uaputl.1
new file mode 100644 (file)
index 0000000..da74fa3
--- /dev/null
@@ -0,0 +1,188 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH UAPUTL 1 "July 20, 2011"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+uaputl \- configure Marvell uAP wireless driver
+.SH SYNOPSIS
+.B uaputl
+.RI [ options ] 
+.RI < command > 
+.RI [ parameters ]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B uaputl command, which is used to configure the device driver for Marvell's 
+uAP wireless interface.
+.SH OPTIONS
+.TP
+.B \-d <debug_level>
+Enable debugging output, level can be 0, 1, or 2.
+.TP
+.B \-h, \-\-help
+Show summary of options and commands.
+.TP
+.B \-i <interface>
+Select interface to configure.
+.TP
+.B \-v
+Show version of program.
+.SH COMMANDS
+For more information on the usage of each command use:
+        uaputl.exe <command> --help
+.TP
+.B sys_config
+Set/get uAP's profile
+.TP
+.B sys_info                    
+Display system info
+.TP
+.B sys_reset                   
+Reset uAP
+.TP
+.B bss_start                   
+Start the BSS
+.TP
+.B bss_stop                    
+Stop the BSS
+.TP
+.B sta_deauth                  
+Deauth client
+.TP
+.B sta_list                    
+Display list of clients
+.TP
+.B sys_cfg_ap_mac_address              
+Set/get uAP mac address
+.TP
+.B sys_cfg_ssid                        
+Set/get uAP ssid
+.TP
+.B sys_cfg_beacon_period               
+Set/get uAP beacon period
+.TP
+.B sys_cfg_dtim_period         
+Set/get uAP dtim period
+.TP
+.B sys_cfg_channel                     
+Set/get uAP radio channel
+.TP
+.B sys_cfg_scan_channels               
+Set/get uAP radio channel list
+.TP
+.B sys_cfg_rates                       
+Set/get uAP rates
+.TP
+.B sys_cfg_rates_ext           
+Set/get uAP rates (extended)
+.TP
+.B sys_cfg_tx_power            
+Set/get uAP tx power
+.TP
+.B sys_cfg_bcast_ssid_ctl              
+Set/get uAP broadcast ssid
+.TP
+.B sys_cfg_preamble_ctl                
+Get uAP preamble
+.TP
+.B sys_cfg_antenna_ctl         
+Set/get uAP tx/rx antenna
+.TP
+.B sys_cfg_rts_threshold               
+Set/get uAP rts threshold
+.TP
+.B sys_cfg_frag_threshold              
+Set/get uAP frag threshold
+.TP
+.B sys_cfg_radio_ctl           
+Set/get uAP radio on/off
+.TP
+.B sys_cfg_tx_data_rate                
+Set/get uAP tx rate
+.TP
+.B sys_cfg_mcbc_data_rate              
+Set/get uAP MCBC rate
+.TP
+.B sys_cfg_rsn_replay_prot             
+Set/get RSN replay protection
+.TP
+.B sys_cfg_pkt_fwd_ctl         
+Set/get uAP packet forwarding
+.TP
+.B sys_cfg_sta_ageout_timer            
+Set/get station ageout timer
+.TP
+.B sys_cfg_auth                        
+Set/get uAP authentication mode
+.TP
+.B sys_cfg_protocol            
+Set/get uAP security protocol
+.TP
+.B sys_cfg_wep_key                     
+Set/get uAP wep key
+.TP
+.B sys_cfg_cipher                      
+Set/get uAP WPA/WPA cipher
+.TP
+.B sys_cfg_wpa_passphrase              
+Set/get uAP WPA or WPA2 passphrase
+.TP
+.B sys_cfg_group_rekey_timer           
+Set/get uAP group re-key time
+.TP
+.B sys_cfg_max_sta_num         
+Set/get uAP max station number
+.TP
+.B sys_cfg_retry_limit         
+Set/get uAP retry limit number
+.TP
+.B sys_cfg_custom_ie                   
+Set/get custom IE configuration
+.TP
+.B sta_filter_table            
+Set/get uAP mac filter
+.TP
+.B regrdwr                             
+Read/Write register command
+.TP
+.B memaccess                   
+Read/Write to a memory address command
+.TP
+.B rdeeprom                    
+Read EEPROM 
+.TP
+.B cfg_data                    
+Get/Set configuration file from/to firmware
+.TP
+.B sys_debug                   
+Set/Get debug parameter
+.TP
+.B sys_cfg_80211d                      
+Set/Get 802.11D info
+.TP
+.B uap_stats                   
+Get uAP stats
+.TP
+.B powermode                   
+Set/get uAP power mode
+.TP
+.B coex_config                 
+Set/get uAP BT coex configuration
+.SH SEE ALSO
+.BR uapevent (1).
+.br
+.PP
+This manual page was written by Bdale Garbee <bdale@gag.com>,
+for the Debian project (and may be used by others).