From 62f59f85bbb7ab0f8fe3b736b7c93b2e30552ec7 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sat, 5 Jun 2010 22:50:26 +0200 Subject: Update documentation --- README | 2 +- bin/efa | 15 +++++++++------ prereqs | 1 + 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README b/README index 3d8eca0..c297654 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ efa - inofficial efa.vrr.de commandline client Requires: - perl version 5.10 or newer - - The perl module WWW::Mechanize + - The perl modules WWW::Mechanize and HTML::TreeBuilder::XPath Installation diff --git a/bin/efa b/bin/efa index e759ac6..513ce49 100755 --- a/bin/efa +++ b/bin/efa @@ -485,9 +485,9 @@ Print version information =head1 EXIT STATUS -Non-Zero on grave errors, otherwise zero. Note that there are cases where -B returns zero although it didn't work properly (i.e. displays an empty -result). +Zero if everything went well (or at least if B thinks so), one if you +gave ambiguous input and need to re-run B with different arguments. 255 +on any other kind of error. =head1 CONFIGURATION @@ -495,12 +495,15 @@ None. =head1 DEPENDENCIES -This script requires the WWW::Mechanize module and perl 5.10 (or higher). +This script requires perl 5.10 (or higher) with the modules +HTML::TreeBuilder::XPath and WWW::Mechanize. =head1 BUGS AND LIMITATIONS -The Unicode handling is slightly messed up. Therefore, arguments to B -should always be plain ASCII (ue instead of E etc). +B cannot handle Unicode in its arguments, so use plain ASCII. + +The Parser is quite new and may not yet cover all corner cases, use with +caution. =head1 AUTHOR diff --git a/prereqs b/prereqs index 3c836cf..6168f68 100644 --- a/prereqs +++ b/prereqs @@ -1,2 +1,3 @@ depend perlmodule Getopt::Long +depend perlmodule HTML::TreeBuilder::XPath depend perlmodule WWW::Mechanize -- cgit v1.2.3