From: Robert 'phaylon' Sedlacek Date: Thu, 30 Aug 2012 20:41:05 +0000 (+0000) Subject: documentation and attribution fixes X-Git-Tag: v0.001_001~8 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=f24afb0e56b651bd94bcda7d8d1918d0a7dc0f65;p=scpubgit%2FSystem-Introspector.git documentation and attribution fixes --- diff --git a/bin/system-introspector b/bin/system-introspector index 119c4a9..68bda45 100755 --- a/bin/system-introspector +++ b/bin/system-introspector @@ -53,6 +53,10 @@ system-introspector - Generate System Introspection Data system-introspector --storage [OPTIONS] +=head1 DESCRIPTION + +See L for more details. + =head1 OPTIONS =head2 -s , --storage @@ -75,4 +79,16 @@ Fetch the specified group. Can be used multiple times. Display help. +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + =cut diff --git a/lib/System/Introspector.pm b/lib/System/Introspector.pm index 2bf4ec8..acbd4a3 100644 --- a/lib/System/Introspector.pm +++ b/lib/System/Introspector.pm @@ -25,24 +25,26 @@ introspection. The introspection is done executing a set of probes on the remote system that gather specific information. Gathered results are stored in JSON format. -=head1 CONTRIBUTORS +=head1 AUTHOR -phaylon - Robert Sedlacek (cpan:PHAYLON) + phaylon - Robert Sedlacek (cpan:PHAYLON) -=head1 AUTHOR +=head1 CONTRIBUTORS -mst - Matt S. Trout (cpan:MSTROUT) + mst - Matt S. Trout (cpan:MSTROUT) -=head1 SPONSORED +=head1 SPONSORS Lots of this stuff sponsored by L. =head1 COPYRIGHT -Copyright (c) 2012 the System::Introspector L and L -as listed above. +Copyright (c) 2012 the System::Introspector L, L +and L as listed above. =head1 LICENSE This library is free software and may be distributed under the same terms as perl itself. + +=cut diff --git a/lib/System/Introspector/Config.pm b/lib/System/Introspector/Config.pm index ff71115..898f1b3 100644 --- a/lib/System/Introspector/Config.pm +++ b/lib/System/Introspector/Config.pm @@ -75,3 +75,29 @@ sub config_for_group { } 1; + +=head1 NAME + +System::Introspector::Config - Configuration file access + +=head1 SEE ALSO + +=over + +=item L + +=back + +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Gatherer.pm b/lib/System/Introspector/Gatherer.pm index d88f590..36a8288 100644 --- a/lib/System/Introspector/Gatherer.pm +++ b/lib/System/Introspector/Gatherer.pm @@ -58,3 +58,31 @@ sub new_from_spec { } 1; + +__END__ + +=head1 NAME + +System::Introspector::Gatherer - Remote Gather Handler + +=head1 SEE ALSO + +=over + +=item L + +=back + +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Gatherer/Bridge.pm b/lib/System/Introspector/Gatherer/Bridge.pm index e802691..ffe357c 100644 --- a/lib/System/Introspector/Gatherer/Bridge.pm +++ b/lib/System/Introspector/Gatherer/Bridge.pm @@ -17,3 +17,31 @@ sub _build_remote { sub gather { (shift)->remote->gather(@_) } 1; + +__END__ + +=head1 NAME + +System::Introspector::Gatherer::Bridge - Bridged Connections + +=head1 SEE ALSO + +=over + +=item L + +=back + +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/DiskUsage.pm b/lib/System/Introspector/Probe/DiskUsage.pm index 0f210c4..be908c2 100644 --- a/lib/System/Introspector/Probe/DiskUsage.pm +++ b/lib/System/Introspector/Probe/DiskUsage.pm @@ -39,7 +39,7 @@ __END__ =head1 NAME -System::Introspector::DiskUsage - Gather disk space usage data +System::Introspector::Probe::DiskUsage - Gather disk space usage data =head1 DESCRIPTION @@ -53,5 +53,16 @@ Uses C to get data about current disk usage. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/FileHandles.pm b/lib/System/Introspector/Probe/FileHandles.pm index a3289b2..0f17745 100644 --- a/lib/System/Introspector/Probe/FileHandles.pm +++ b/lib/System/Introspector/Probe/FileHandles.pm @@ -36,7 +36,7 @@ __END__ =head1 NAME -System::Introspector::FileHandles - Gather opened filehandles +System::Introspector::Probe::FileHandles - Gather opened filehandles =head1 DESCRIPTION @@ -50,5 +50,16 @@ Uses C to build a list of open filehandles. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Groups.pm b/lib/System/Introspector/Probe/Groups.pm index abdbb7c..44cd6ce 100644 --- a/lib/System/Introspector/Probe/Groups.pm +++ b/lib/System/Introspector/Probe/Groups.pm @@ -39,7 +39,7 @@ __END__ =head1 NAME -System::Introspector::Groups - Gather group information +System::Introspector::Probe::Groups - Gather group information =head1 DESCRIPTION @@ -53,5 +53,16 @@ Uses C to gather information about groups. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Host.pm b/lib/System/Introspector/Probe/Host.pm index 530875f..6fc2528 100644 --- a/lib/System/Introspector/Probe/Host.pm +++ b/lib/System/Introspector/Probe/Host.pm @@ -57,7 +57,7 @@ __END__ =head1 NAME -System::Introspector::Host - Gather generic host information +System::Introspector::Probe::Host - Gather generic host information =head1 DESCRIPTION @@ -71,5 +71,16 @@ Gathers the hostname and information provided by C. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Hosts.pm b/lib/System/Introspector/Probe/Hosts.pm index bc2ab76..1ff7f73 100644 --- a/lib/System/Introspector/Probe/Hosts.pm +++ b/lib/System/Introspector/Probe/Hosts.pm @@ -30,7 +30,7 @@ __END__ =head1 NAME -System::Introspector::Hosts - Gather known hosts +System::Introspector::Probe::Hosts - Gather known hosts =head1 DESCRIPTION @@ -50,5 +50,16 @@ The path to the C file that should be read. Defaults to C. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/LibDirs/Perl.pm b/lib/System/Introspector/Probe/LibDirs/Perl.pm index 1e34ba9..015150b 100644 --- a/lib/System/Introspector/Probe/LibDirs/Perl.pm +++ b/lib/System/Introspector/Probe/LibDirs/Perl.pm @@ -74,7 +74,7 @@ __END__ =head1 NAME -System::Introspector::LibDirs::Perl - Gather perl lib directory data +System::Introspector::Probe::LibDirs::Perl - Gather perl lib directory data =head1 DESCRIPTION @@ -96,5 +96,16 @@ to C. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/MountPoints.pm b/lib/System/Introspector/Probe/MountPoints.pm index ae07947..2a68a30 100644 --- a/lib/System/Introspector/Probe/MountPoints.pm +++ b/lib/System/Introspector/Probe/MountPoints.pm @@ -64,7 +64,7 @@ __END__ =head1 NAME -System::Introspector::MountPoints - Gather moint point information +System::Introspector::Probe::MountPoints - Gather moint point information =head1 DESCRIPTION @@ -78,5 +78,16 @@ Reads C and C files to provide mount point information. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Nagios/CheckMkAgent.pm b/lib/System/Introspector/Probe/Nagios/CheckMkAgent.pm index 310b91b..9016b2c 100644 --- a/lib/System/Introspector/Probe/Nagios/CheckMkAgent.pm +++ b/lib/System/Introspector/Probe/Nagios/CheckMkAgent.pm @@ -35,7 +35,7 @@ __END__ =head1 NAME -System::Introspector::Nagios::CheckMkAgent - Gather check_mk_agent output +System::Introspector::Probe::Nagios::CheckMkAgent - Gather check_mk_agent output =head1 DESCRIPTION @@ -49,6 +49,16 @@ Parses the output of C to gather data available to Nagios. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Packages/Apt.pm b/lib/System/Introspector/Probe/Packages/Apt.pm index 615d7ae..5de5813 100644 --- a/lib/System/Introspector/Probe/Packages/Apt.pm +++ b/lib/System/Introspector/Probe/Packages/Apt.pm @@ -122,7 +122,7 @@ __END__ =head1 NAME -System::Introspector::Packages::Apt - Gather APT package status +System::Introspector::Probe::Packages::Apt - Gather APT package status =head1 DESCRIPTION @@ -136,4 +136,16 @@ Uses C to list all installed packages. =back +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + =cut diff --git a/lib/System/Introspector/Probe/Perls.pm b/lib/System/Introspector/Probe/Perls.pm index bb8af72..e898711 100644 --- a/lib/System/Introspector/Probe/Perls.pm +++ b/lib/System/Introspector/Probe/Perls.pm @@ -74,3 +74,36 @@ sub _find_possible_perl_configs { } 1; + +__END__ + +=head1 NAME + +System::Introspector::Probe::Perls - Locate perl installations + +=head1 DESCRIPTION + +Tries to locate perl installations on the system and collects +information about them. + +=head1 SEE ALSO + +=over + +=item L + +=back + +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Processes.pm b/lib/System/Introspector/Probe/Processes.pm index 3d1b962..8f711e4 100644 --- a/lib/System/Introspector/Probe/Processes.pm +++ b/lib/System/Introspector/Probe/Processes.pm @@ -79,7 +79,7 @@ __END__ =head1 NAME -System::Introspector::Processes - Gather running processes +System::Introspector::Probe::Processes - Gather running processes =head1 DESCRIPTION @@ -93,5 +93,16 @@ Uses C to gather a list of all running processes. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Puppet.pm b/lib/System/Introspector/Probe/Puppet.pm index 4c3fde5..5cd141f 100644 --- a/lib/System/Introspector/Probe/Puppet.pm +++ b/lib/System/Introspector/Probe/Puppet.pm @@ -52,7 +52,7 @@ __END__ =head1 NAME -System::Introspector::Puppet - Gather puppet agent information +System::Introspector::Probe::Puppet - Gather puppet agent information =head1 DESCRIPTION @@ -78,4 +78,16 @@ Defaults to C. =back +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + =cut diff --git a/lib/System/Introspector/Probe/Repositories/Git.pm b/lib/System/Introspector/Probe/Repositories/Git.pm index bd5ef23..1ac056e 100644 --- a/lib/System/Introspector/Probe/Repositories/Git.pm +++ b/lib/System/Introspector/Probe/Repositories/Git.pm @@ -125,7 +125,7 @@ __END__ =head1 NAME -System::Introspector::Repositories::Git - Gather Git repository info +System::Introspector::Probe::Repositories::Git - Gather Git repository info =head1 DESCRIPTION @@ -145,5 +145,16 @@ This is the root path for the search of git directories. Defaults to C. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/ResolvConf.pm b/lib/System/Introspector/Probe/ResolvConf.pm index 753085f..16b7a26 100644 --- a/lib/System/Introspector/Probe/ResolvConf.pm +++ b/lib/System/Introspector/Probe/ResolvConf.pm @@ -30,7 +30,7 @@ __END__ =head1 NAME -System::Introspector::ResolvConf - Gather name resolution configuration +System::Introspector::Probe::ResolvConf - Gather name resolution configuration =head1 DESCRIPTION @@ -51,5 +51,16 @@ C. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Sudoers.pm b/lib/System/Introspector/Probe/Sudoers.pm index 0850752..9db49ac 100644 --- a/lib/System/Introspector/Probe/Sudoers.pm +++ b/lib/System/Introspector/Probe/Sudoers.pm @@ -71,7 +71,7 @@ __END__ =head1 NAME -System::Introspector::Sudoers - Gather sudoer information +System::Introspector::Probe::Sudoers - Gather sudoer information =head1 DESCRIPTION @@ -97,5 +97,16 @@ The hostname used to resolve C<%h> hostname markers in inclusions. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/Probe/Users.pm b/lib/System/Introspector/Probe/Users.pm index e0baa5b..7e31df7 100644 --- a/lib/System/Introspector/Probe/Users.pm +++ b/lib/System/Introspector/Probe/Users.pm @@ -103,7 +103,7 @@ __END__ =head1 NAME -System::Introspector::Users - Gather user information +System::Introspector::Probe::Users - Gather user information =head1 DESCRIPTION @@ -118,5 +118,16 @@ installed SSH public keys. =back -=cut +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE +This library is free software and may be distributed under the same terms +as perl itself. + +=cut diff --git a/lib/System/Introspector/State.pm b/lib/System/Introspector/State.pm index 876ab3d..7d49312 100644 --- a/lib/System/Introspector/State.pm +++ b/lib/System/Introspector/State.pm @@ -142,15 +142,11 @@ System::Introspector::State - Gather system state =head1 SYNOPSIS my $state = System::Introspector::State->new( - host => 'foo.example.com', - storage => $storage_obj, - config => { - introspect => [qw( ProbeName )], - }, + root => '/root/path', + config => $config_object, ); - my $data = $state->fetch; - $state->fetch_and_store; + $state->gather; =head1 DESCRIPTION @@ -161,31 +157,38 @@ it with a L object. =head2 config -A hash reference containing a C key with an array reference -value containing a list of probe names without the -C prefix. This attribute is required. +A L -=head2 host +=head2 root -An optional hostname. If no hostname is supplied, the local configuration -data will be fetched. +Path to the storage root. -=head2 storage +=head1 METHODS -A L object. +=head2 gather -=head1 METHODS + $state->gather; + +Fetches all probe data and stores it in the tree below the L. + +=head1 SEE ALSO + +=over -=head2 fetch +=item L - my $data = $state->fetch; +=back -Fetches all probe data. +=head1 COPYRIGHT -=head2 fetch_and_store +Copyright (c) 2012 the L +L, +L and +L. - $state->fetch_and_store; +=head1 LICENSE -Fetches all probe data and stores it in the L. +This library is free software and may be distributed under the same terms +as perl itself. =cut diff --git a/lib/System/Introspector/Util.pm b/lib/System/Introspector/Util.pm index a953dc2..8681b28 100644 --- a/lib/System/Introspector/Util.pm +++ b/lib/System/Introspector/Util.pm @@ -123,3 +123,35 @@ sub output_from_file { } 1; + +__END__ + +=head1 NAME + +System::Introspector::Util - Utility functions + +=head1 DESCRIPTION + +Contains utility functions for L. + +=head1 SEE ALSO + +=over + +=item L + +=back + +=head1 COPYRIGHT + +Copyright (c) 2012 the L +L, +L and +L. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. + +=cut