From: Robert 'phaylon' Sedlacek <r.sedlacek@shadowcat.co.uk>
Date: Wed, 9 May 2012 15:36:06 +0000 (+0000)
Subject: added base pod to all probes
X-Git-Tag: v0.001_001~109
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=535e84b638c44a870dff749dfbd80fc8d4b2ec50;p=scpubgit%2FSystem-Introspector.git

added base pod to all probes
---

diff --git a/lib/System/Introspector/DiskUsage.pm b/lib/System/Introspector/DiskUsage.pm
index 061a6da..ef7e6d9 100644
--- a/lib/System/Introspector/DiskUsage.pm
+++ b/lib/System/Introspector/DiskUsage.pm
@@ -23,3 +23,24 @@ sub gather {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::DiskUsage - Gather disk space usage data
+
+=head1 DESCRIPTION
+
+Uses C<df> to get data about current disk usage.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/FileHandles.pm b/lib/System/Introspector/FileHandles.pm
index 2e3851d..b185948 100644
--- a/lib/System/Introspector/FileHandles.pm
+++ b/lib/System/Introspector/FileHandles.pm
@@ -25,3 +25,24 @@ sub _open_lsof_pipe {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::FileHandles - Gather opened filehandles
+
+=head1 DESCRIPTION
+
+Uses C<lsof> to build a list of open filehandles.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Groups.pm b/lib/System/Introspector/Groups.pm
index b456a5f..8b93e32 100644
--- a/lib/System/Introspector/Groups.pm
+++ b/lib/System/Introspector/Groups.pm
@@ -28,3 +28,24 @@ sub _open_group_file {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Groups - Gather group information
+
+=head1 DESCRIPTION
+
+Uses C</etc/group> to gather information about groups.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Host.pm b/lib/System/Introspector/Host.pm
index 9b69646..680df55 100644
--- a/lib/System/Introspector/Host.pm
+++ b/lib/System/Introspector/Host.pm
@@ -42,3 +42,24 @@ sub _gather_hostname {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Host - Gather generic host information
+
+=head1 DESCRIPTION
+
+Gathers the hostname and information provided by C<uname>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Hosts.pm b/lib/System/Introspector/Hosts.pm
index 4f74d2d..ed8a1bf 100644
--- a/lib/System/Introspector/Hosts.pm
+++ b/lib/System/Introspector/Hosts.pm
@@ -28,3 +28,30 @@ sub _open_hosts_file {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Hosts - Gather known hosts
+
+=head1 DESCRIPTION
+
+Reads a C<hosts> file to produce a list of known hosts
+
+=head1 ATTRIBUTES
+
+=head2 hosts_file
+
+The path to the C<hosts> file that should be read. Defaults to C</etc/hosts>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/LibDirs/Perl.pm b/lib/System/Introspector/LibDirs/Perl.pm
index a8f7d21..ed70e32 100644
--- a/lib/System/Introspector/LibDirs/Perl.pm
+++ b/lib/System/Introspector/LibDirs/Perl.pm
@@ -63,3 +63,32 @@ sub _open_locate_libdirs_pipe {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::LibDirs::Perl - Gather perl lib directory data
+
+=head1 DESCRIPTION
+
+Finds locations that look like L<local::lib> or comparable Perl library
+directories, and extracts module information from them.
+
+=head1 ATTRIBUTES
+
+=head2 root
+
+This is the root path to be searched for library directories. Defaults
+to C</>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/MountPoints.pm b/lib/System/Introspector/MountPoints.pm
index 0a34d6f..f6fdf15 100644
--- a/lib/System/Introspector/MountPoints.pm
+++ b/lib/System/Introspector/MountPoints.pm
@@ -45,3 +45,24 @@ sub _parse_tab_fh {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::MountPoints - Gather moint point information
+
+=head1 DESCRIPTION
+
+Reads C<fstab> and C<mtab> files to provide mount point information.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Packages/Apt.pm b/lib/System/Introspector/Packages/Apt.pm
index 0e222a9..07e17a8 100644
--- a/lib/System/Introspector/Packages/Apt.pm
+++ b/lib/System/Introspector/Packages/Apt.pm
@@ -31,3 +31,23 @@ sub _gather_installed {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Packages::Apt - Gather APT package status
+
+=head1 DESCRIPTION
+
+Uses C<dpkg-query> to list all installed packages.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
diff --git a/lib/System/Introspector/Processes.pm b/lib/System/Introspector/Processes.pm
index 0c08b72..a4a67b1 100644
--- a/lib/System/Introspector/Processes.pm
+++ b/lib/System/Introspector/Processes.pm
@@ -63,3 +63,24 @@ sub _open_ps_pipe {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Processes - Gather running processes
+
+=head1 DESCRIPTION
+
+Uses C<ps> to gather a list of all running processes.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Repositories/Git.pm b/lib/System/Introspector/Repositories/Git.pm
index ab8ccc3..72af8ed 100644
--- a/lib/System/Introspector/Repositories/Git.pm
+++ b/lib/System/Introspector/Repositories/Git.pm
@@ -115,3 +115,30 @@ sub _open_locate_git_config_pipe {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Repositories::Git - Gather Git repository info
+
+=head1 DESCRIPTION
+
+Find Git repositories and gathers their information.
+
+=head1 ATTRIBUTES
+
+=head2 root
+
+This is the root path for the search of git directories. Defaults to C</>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/ResolvConf.pm b/lib/System/Introspector/ResolvConf.pm
index 7def573..a33bd97 100644
--- a/lib/System/Introspector/ResolvConf.pm
+++ b/lib/System/Introspector/ResolvConf.pm
@@ -28,3 +28,31 @@ sub _open_resolv_conf_file {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::ResolvConf - Gather name resolution configuration
+
+=head1 DESCRIPTION
+
+Reads a C<resolv.conf> file to gather information about name resolution.
+
+=head1 ATTRIBUTES
+
+=head2 resolv_conf_file
+
+The path to the C<resolv.conf> file that should be read. Defaults to
+C</etc/resolv.conf>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Sudoers.pm b/lib/System/Introspector/Sudoers.pm
index d6bfca6..56afd04 100644
--- a/lib/System/Introspector/Sudoers.pm
+++ b/lib/System/Introspector/Sudoers.pm
@@ -58,3 +58,36 @@ sub _insert_hostname {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Sudoers - Gather sudoer information
+
+=head1 DESCRIPTION
+
+Reads C<sudoers> files to gather information about sudo abilities. This
+probe will also read all included files.
+
+=head1 ATTRIBUTES
+
+=head2 sudoers_file
+
+The path to the original C<sudoers> file that should be read. Includes from this
+file will be followed and provided as well.
+
+=head2 hostname
+
+The hostname used to resolve C<%h> hostname markers in inclusions.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+
diff --git a/lib/System/Introspector/Users.pm b/lib/System/Introspector/Users.pm
index 938f4a4..b9c477b 100644
--- a/lib/System/Introspector/Users.pm
+++ b/lib/System/Introspector/Users.pm
@@ -75,3 +75,25 @@ sub _open_passwd_fh {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Users - Gather user information
+
+=head1 DESCRIPTION
+
+Gathers information for all users in C</etc/passwd>, including cronjobs and
+installed SSH public keys.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=cut
+