vvelox
/
Net-Wireless-802_11-WPA-CLI
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

clean up some of the POD formatting

This commit is contained in:
Zane C. B-H 2018-07-23 22:47:46 -05:00
parent ff85f4a89d
commit e46562448e
2 changed files with 36 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Net-Wireless-802_11-WPA-CLI/Changes
View File

@ -1,5 +1,8 @@
Revision history for Net-Wireless-802_11-WPA-CLI Revision history for Net-Wireless-802_11-WPA-CLI
2.1.0 2018-?-?/?:?
- POD formatting cleanup.
2.1.0 2011-08-19/06:00 2.1.0 2011-08-19/06:00
-Add missing dependency to Makefile.PL. -Add missing dependency to Makefile.PL.
-POD cleanup. -POD cleanup.

66
Net-Wireless-802_11-WPA-CLI/lib/Net/Wireless/802_11/WPA/CLI.pm
View File

@ -33,7 +33,7 @@ This initializes the object to be used for making use of wpa_cli.
my $foo->Net::Wireless::802_11::WPA::CLI->new(); my $foo->Net::Wireless::802_11::WPA::CLI->new();
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
=cut =cut
@ -92,7 +92,7 @@ No arguments are taken.
The returned value is a the new network ID. The returned value is a the new network ID.
$newNetworkID=$foo->add_network; $newNetworkID=$foo->add_network;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -185,9 +185,9 @@ This is the SSID for the for AP in question.
my %status=$foo->bss($bssid); my %status=$foo->bss($bssid);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
=cut =cut
sub bss{ sub bss{
@ -254,7 +254,7 @@ Disconnect and wait for a reassosiate command.
No arguments are taken. No arguments are taken.
$return=$foo->disconnect; $return=$foo->disconnect;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -277,7 +277,7 @@ This disables a network ID.
One argument is required and that is the network ID in question. One argument is required and that is the network ID in question.
$foo->disable_network($networkID) $foo->disable_network($networkID)
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -309,7 +309,7 @@ This enables a network ID.
One argument is required and that is the network ID to enable. One argument is required and that is the network ID to enable.
$foo->enable_network($networkID) $foo->enable_network($networkID)
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -348,7 +348,7 @@ that can be requested are as below.
No arguments are taken. No arguments are taken.
my @capabilities=$foo->get_capability('eap'); my @capabilities=$foo->get_capability('eap');
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -408,7 +408,7 @@ This gets a variable for for a specific network ID.
Two arguments are taken and that is the network ID and variable. Two arguments are taken and that is the network ID and variable.
$value=$foo->get_network($networkID, $variable); $value=$foo->get_network($networkID, $variable);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -474,7 +474,7 @@ it will be set to 'any'.
This is the flags for the network. This key may not be defined. This is the flags for the network. This key may not be defined.
%return=$foo->list_networks; %return=$foo->list_networks;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -538,7 +538,7 @@ This sets a new password for a network.
Two arguments are taken. The first is the network ID and Two arguments are taken. The first is the network ID and
the second is the new password. the second is the new password.
$return=$foo->new_password($networkID, $newpass); $return=$foo->new_password($networkID, $newpass);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -569,7 +569,7 @@ This sets the pin for a network.
Two arguments are taken. The first is the network ID and the second is the pin. Two arguments are taken. The first is the network ID and the second is the pin.
$foo->pin($networkID, $newpin); $foo->pin($networkID, $newpin);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -600,7 +600,7 @@ Force preauthentication for a BSSID.
One argument is accepted and the is the BSSID in question. One argument is accepted and the is the BSSID in question.
$foo->preauthenticate($BSSID); $foo->preauthenticate($BSSID);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -647,7 +647,7 @@ This causes wpa_supplicant to reread it's configuration file.
No arguments are taken. No arguments are taken.
$return=$obj->reconfigure; $return=$obj->reconfigure;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -670,7 +670,7 @@ This removes the specified network.
One argument is accepted and it the network ID. One argument is accepted and it the network ID.
$return=$foo->remove_network($networkID) $return=$foo->remove_network($networkID)
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -702,7 +702,7 @@ does not need write permissions to file being used
No arguments are taken. No arguments are taken.
my $returned=$foo->save_config; my $returned=$foo->save_config;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -725,7 +725,7 @@ This requests a new BSS scan.
No arguments are taken. No arguments are taken.
my $returned=$foo->scan; my $returned=$foo->scan;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -771,13 +771,13 @@ This is the signal level of the seen AP.
This is the flags for the AP. This is the flags for the AP.
my %scan=$foo->scan_results; my %scan=$foo->scan_results;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
}else{ }else{
print "BSSID, SSID, FREQ, SIGNAL, FLAGS\n"; print "BSSID, SSID, FREQ, SIGNAL, FLAGS\n";
my @keys=keys(%scan); my @keys=keys(%scan);
my $int=0; my $int=0;
while( defined( $keys[$int] ) ){ while( defined( $keys[$int] ) ){
@ -785,7 +785,7 @@ This is the flags for the AP.
$scan{$keys[$int]}{frequency}.', ' $scan{$keys[$int]}{frequency}.', '
.$scan{$keys[$int]}{signal}.', ' .$scan{$keys[$int]}{signal}.', '
.$scan{$keys[$int]}{flags}; .$scan{$keys[$int]}{flags};
$int++; $int++;
} }
} }
@ -848,7 +848,7 @@ This is the network ID to select, while disabling the others.
One argument is accepted and it is the network ID to select. One argument is accepted and it is the network ID to select.
$return=$foo->select_network($networkID) $return=$foo->select_network($networkID)
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -881,7 +881,7 @@ Three arguments are taken. The first is the network ID,
the second is the variable to set, and the third is the the second is the variable to set, and the third is the
value to set it to. value to set it to.
$foo->set_network($networkID, $variable, $value); $foo->set_network($networkID, $variable, $value);
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -914,9 +914,9 @@ No arguments are taken.
my %status=$foo->status; my %status=$foo->status;
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
=cut =cut
sub status{ sub status{
@ -956,10 +956,10 @@ sub status{
This gets the MIB variables (dot1x, dot11). This gets the MIB variables (dot1x, dot11).
%return=$foo->mib; %return=$foo->mib;
if( $foo->error ){ if( $foo->error ){
warn('error:'.$foo->error.': '.$foo->errorString); warn('error:'.$foo->error.': '.$foo->errorString);
} }
=cut =cut
@ -1001,10 +1001,10 @@ A status of 'FAIL' will also set a error of 5.
A unknown status will also set a error of 6. A unknown status will also set a error of 6.
$returned=$foo->run_TF_command($command, 0); $returned=$foo->run_TF_command($command, 0);
if( $foo->error ){ if( $foo->error ){
warn('error:'.$foo->error.': '.$foo->errorString); warn('error:'.$foo->error.': '.$foo->errorString);
} }
=cut =cut
@ -1054,7 +1054,7 @@ arguments for it.
UNDEF is returned upon with running wpa_cli. Otherwise the return is the return UNDEF is returned upon with running wpa_cli. Otherwise the return is the return
from executed command. from executed command.
$returned=$foo->run_command($command) $returned=$foo->run_command($command)
if( $foo->error ){ if( $foo->error ){
warn('Error:'.$foo->error.': '.$foo->errorString); warn('Error:'.$foo->error.': '.$foo->errorString);
} }
@ -1204,7 +1204,7 @@ L<http://search.cpan.org/dist/Net-Wireless-802_11-WPA-CLI>
=head1 COPYRIGHT & LICENSE =head1 COPYRIGHT & LICENSE
Copyright 2011 Zane C. Bowers-Hadley, all rights reserved. Copyright 2018 Zane C. Bowers-Hadley, all rights reserved.
This program is free software; you can redistribute it and/or modify it This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. under the same terms as Perl itself.