Add more documentation bits
[scpubgit/System-Introspector.git] / lib / System / Introspector.pm
1 use strictures 1;
2
3 package System::Introspector;
4
5 our $VERSION = '0.000001';
6 $VERSION = eval $VERSION;
7
8 1;
9
10 =head1 NAME
11
12 System::Introspector - framework for remote system introspection
13
14 =head1 SYNOPSIS
15
16   $ system-introspector --storage <path> --config <path> [OPTIONS]
17
18 See L<system-introspector(1)> for detailed information about which OPTIONS
19 can be used.
20
21 =head1 DESCRIPTION
22
23 System::Introspector is a framework for remotely executing system wide
24 introspection. The introspection is done executing a set of probes
25 on the remote system that gather specific information. Gathered results
26 are stored in JSON format.
27
28 =head1 CONTRIBUTORS
29
30 phaylon - Robert Sedlacek (cpan:PHAYLON) <rs@474.at>
31
32 =head1 AUTHOR
33
34 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
35
36 =head1 SPONSORED
37
38 Lots of this stuff sponsored by L<http://socialflow.com>.
39
40 =head1 COPYRIGHT
41
42 Copyright (c) 2012 the System::Introspector L</AUTHOR> and L</CONTRIBUTORS>
43 as listed above.
44
45 =head1 LICENSE
46
47 This library is free software and may be distributed under the same terms
48 as perl itself.