Commit f3f7dcd7 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Documentation updates

parent 67727c4d
Loading
Loading
Loading
Loading
+13 −12
Original line number Diff line number Diff line
@@ -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<http://reiseauskunft.bahn.de/bin/bhftafel.exe/dn>.
hafas-m is an interface to HAFAS-based departure monitors such as the one
available at L<https://reiseauskunft.bahn.de//bin/bhftafel.exe/dn>.

It requests all departures at I<station> (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<motlist>

@@ -262,6 +263,9 @@ To show them exclusively, set I<motlist> to I<mot1>,I<mot2>,...

The I<mot> 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<service>

Request arrivals/departures using the API provided by I<service>, defaults
@@ -273,12 +277,9 @@ Time to list departures for. Default: now.

=item B<-u>, B<--url> I<url>

Request arrivals/departures using the API entry point at I<url>, 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<url>. 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 E<lt>derf@finalrewind.orgE<gt>
Copyright (C) 2015-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

=head1 LICENSE

+1 −1
Original line number Diff line number Diff line
@@ -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 E<lt>derf@finalrewind.orgE<gt>
Copyright (C) 2015-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

=head1 LICENSE

+14 −2
Original line number Diff line number Diff line
@@ -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 E<lt>derf@finalrewind.orgE<gt>
Copyright (C) 2015-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

=head1 LICENSE