From f3f7dcd79ce4270799c77932829276dc9ffb2a10 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Fri, 8 May 2020 19:33:32 +0200 Subject: Documentation updates --- bin/hafas-m | 25 +++++++++++++------------ lib/Travel/Status/DE/HAFAS.pm | 2 +- lib/Travel/Status/DE/HAFAS/Result.pm | 16 ++++++++++++++-- 3 files changed, 28 insertions(+), 15 deletions(-) diff --git a/bin/hafas-m b/bin/hafas-m index 7a379f0..aff469c 100755 --- a/bin/hafas-m +++ b/bin/hafas-m @@ -216,12 +216,11 @@ version 2.05 =head1 DESCRIPTION -hafas-m is an interface to HAFAS-based departure monitors, for instance the -one available at L. +hafas-m is an interface to HAFAS-based departure monitors such as the one +available at L. It requests all departures at I (optionally filtered by date, time, -route and means of transport) and lists them on stdout, similar to the big -departure screens installed at most main stations. +route and means of transport) and lists them on stdout. =head1 OPTIONS @@ -248,7 +247,9 @@ Do not display delayed trains. =item B<--list> -List known HAFAS installations. See also B<--service> and B<--url>. +List known HAFAS installations. A HAFAS service from this list can be querie +using B<--service>. Use B<--url> for HAFAS entrypoints not included in the +list (and consider notifying me so I can include them in the next release). =item B<-m>, B<--mot> I @@ -262,6 +263,9 @@ To show them exclusively, set I to I,I,... The I types depend on the used service. Use C<< -m help >> to list them. +This option is not available when the HAFAS entrypoint has been specified via +B<--url>. + =item B<-s>, B<--service> I Request arrivals/departures using the API provided by I, defaults @@ -273,12 +277,9 @@ Time to list departures for. Default: now. =item B<-u>, B<--url> I -Request arrivals/departures using the API entry point at I, defaults to -C<< http://reiseauskunft.bahn.de/bin/bhftafel.exe >>. Note that the language -and output selection suffix (e.g. "/dn") must not be included here. - -Again, see B<--list> for a list of known URLs. Unknown URLs are also -supported, though note that B<--mot> will not work when using this opton. +Request arrivals/departures using the API entry point at I. Note that the +language and output selection suffix (e.g. "/dn") must not be included here. +Note that B<--mot> will not work when using this opton. =item B<-V>, B<--version> @@ -312,7 +313,7 @@ The non-default services (anything other than DB) are not well tested. =head1 AUTHOR -Copyright (C) 2015-2017 by Daniel Friesel Ederf@finalrewind.orgE +Copyright (C) 2015-2020 by Daniel Friesel Ederf@finalrewind.orgE =head1 LICENSE diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm index 16c879e..2e29814 100644 --- a/lib/Travel/Status/DE/HAFAS.pm +++ b/lib/Travel/Status/DE/HAFAS.pm @@ -594,7 +594,7 @@ Travel::Status::DE::HAFAS::Result(3pm), Travel::Status::DE::HAFAS::StopFinder(3p =head1 AUTHOR -Copyright (C) 2015-2017 by Daniel Friesel Ederf@finalrewind.orgE +Copyright (C) 2015-2020 by Daniel Friesel Ederf@finalrewind.orgE =head1 LICENSE diff --git a/lib/Travel/Status/DE/HAFAS/Result.pm b/lib/Travel/Status/DE/HAFAS/Result.pm index e5c81c0..f1cff2c 100644 --- a/lib/Travel/Status/DE/HAFAS/Result.pm +++ b/lib/Travel/Status/DE/HAFAS/Result.pm @@ -294,9 +294,21 @@ Returns the last element of the route. Depending on how you set up Travel::Status::DE::HAFAS (arrival or departure listing), this is either the result's destination or its origin station. +=item $result->sched_date + +Scheduled arrival/departure date in "dd.mm.yyyy" format. + +=item $result->sched_datetime + +DateTime object holding the scheduled arrival/departure date and time. + +=item $result->sched_time + +Scheduled arrival/departure time in "hh:mm" format. + =item $result->time -Returns the arrival/departure time as string in "hh:mm" format. +Arrival/Departure time in "hh:mm" format. =item $result->type @@ -327,7 +339,7 @@ Travel::Status::DE::HAFAS(3pm). =head1 AUTHOR -Copyright (C) 2015-2017 by Daniel Friesel Ederf@finalrewind.orgE +Copyright (C) 2015-2020 by Daniel Friesel Ederf@finalrewind.orgE =head1 LICENSE -- cgit v1.2.3