XOrg: POD the xorglog module

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

1 files changed, 26 insertions, 1 deletions

diff --git a/XOrg/xorglog.pm b/XOrg/xorglog.pm
index 66e2693..f26fdef 100755
--- a/XOrg/xorglog.pm
+++ b/XOrg/xorglog.pm
@@ -19,7 +19,32 @@
 # Authors: Peter Hutterer <peter.hutterer@redhat.com>
 
 
-# Xorg.log parser
+=head1 NAME
+
+XOrg::xorglog - simple Xorg.log parser module
+
+=head1 SYNOPSIS
+
+	use XOrg::xorglog;
+
+	my $xlog = xorglog->new(file => "/var/log/Xorg.0.log");
+	my $server = $xlog->server;
+
+=head1 DESCRIPTION
+This module parses a Xorg.log file an extracts some useful information from
+it. Use the XOrg::XServer module returned to get access to all the
+information extracted from the log.
+
+=head1 BUGS
+This module only extracts some stuff from the log. The Xorg.log is quite
+difficult to parse and guesswork is required in some instances. There's a
+high chance that exactly that bit of information you need won't be in there.
+
+=head1 SEE ALSO
+
+perl(1)
+
+=cut
 
 package XOrg::xorglog;