summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2014-01-03 10:48:00 +0100
committerDaniel Friesel <derf@finalrewind.org>2014-01-03 10:48:00 +0100
commit8502e801d50f66244a20f6a3561d4cf943d3bb77 (patch)
tree41dec7af06f469f079b24edfc36f68379dc84f2b
parenta201b41bbfffaf32407afe522829654e2dd93674 (diff)
efa-m documentation updates, add previously undocumented -L option
-rwxr-xr-xbin/efa-m25
1 files changed, 21 insertions, 4 deletions
diff --git a/bin/efa-m b/bin/efa-m
index 03a4b80..a789058 100755
--- a/bin/efa-m
+++ b/bin/efa-m
@@ -182,7 +182,9 @@ efa-m - Unofficial interface to the efa.vrr.de departure monitor
=head1 SYNOPSIS
-B<efa-m> [B<-d> I<date>] [B<-t> I<time>] I<city> [I<type>B<:>]I<name>
+B<efa-m> [B<-Lr>] [B<-d> I<dd.mm.yyyy>] [B<-t> I<hh:mm>]
+[B<-l> I<lines>] [B<-p> I<platforms>] [B<-u> I<url>]
+I<city> [I<type>B<:>]I<name>
=head1 VERSION
@@ -202,7 +204,15 @@ I<type>. Supported types are B<address> and B<poi> (point of interest).
=item B<-d>, B<--date> I<dd.mm.yyyy>
-Show departures for I<date> instead of today
+Show departures for I<date> instead of today.
+May also be specified as I<dd.mm.>
+
+=item B<-L>, B<--linelist>
+
+Do not show departures. Instead, list all lines serving the specified place.
+Note that this information may be incomplete -- only lines which are in
+service either at the time of the B<efa-m> call or at the time specifed
+using B<--date> and B<--time> are guaranteed to be included.
=item B<-l>, B<--line> I<lines>
@@ -236,7 +246,8 @@ Show version information.
=head1 EXIT STATUS
-Zero.
+Normally zero. B<1> means B<efa-m> was called with invalid options,
+B<2> indicates a request error from Travel::Status::DE::EFA(3pm).
=head1 CONFIGURATION
@@ -250,13 +261,19 @@ None.
=item * LWP::UserAgent(3pm)
+=item * Travel::Status::DE::EFA(3pm)
+
=item * XML::LibXML(3pm)
=back
=head1 BUGS AND LIMITATIONS
-Unknown.
+B<efa-m> uses the VRR EFA service by default, which seems to contain the
+greatest available set of information. However, some cities (e.g. Berlin
+or parts of Hamburg) are incomplete. B<efa-m> is not yet able to choose the
+appropriate EFA URL for these by itself, it needs to be done manually with
+the B<-u>, B<--efa-url> option.
=head1 AUTHOR