Skip to content
Snippets Groups Projects
Commit 90404d94 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Documentation fixups

parent f81b605c
No related branches found
No related tags found
No related merge requests found
......@@ -162,7 +162,7 @@ available at L<http://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 on most main stations.
departure screens installed at most main stations.
=head1 OPTIONS
......@@ -174,7 +174,7 @@ Date to list departures for. Default: today
=item B<-m>, B<--mot> I<motlist>
Comma-separated list of modes of transport to show/hide. Accepts the following
Comma-separated list of modes of transport to show/hide. Accepts the following
argements:
ice InterCity Express trains
......@@ -187,14 +187,14 @@ argements:
u U-Bahn
tram
You can prefix an argument with "!" to hide it. The default is C<<
ice,ic_ec,d,nv,s >>. Note that B<-m> does not replace the default, so if you
You can prefix an argument with "!" to hide it. The default is C<<
ice,ic_ec,d,nv,s >>. Note that B<-m> does not replace the default, so if you
only want to see S-Bahn und U-Bahn departures, you'd have to use C<< -m
!ice,!ic_ec,!d,!nv,u >>.
=item B<-t>, B<--time> I<hh>:I<mm>
Time to list departures for. Default: now.
Time to list departures for. Default: now.
=item B<-v>, B<--via> I<regex>
......
......@@ -202,30 +202,30 @@ unspecified).
=item my $status = Travel::Status::DE::DeutscheBahn->new(I<%opts>)
Returns a new Travel::Status::DE::DeutscheBahn element. Supported I<opts> are:
Returns a new Travel::Status::DE::DeutscheBahn element. Supported I<opts> are:
=over
=item B<station> => I<station>
The train station to report for, e.g. "Essen HBf". Mandatory.
The train station to report for, e.g. "Essen HBf". Mandatory.
=item B<date> => I<dd>.I<mm>.I<yyyy>
Date to report for. Defaults to the current day.
Date to report for. Defaults to the current day.
=item B<time> => I<hh>:I<mm>
Time to report for. Defaults to now.
Time to report for. Defaults to now.
=item B<mode> => B<arr>|B<dep>
By default, Travel::Status::DE::DeutscheBahn reports train departures
(B<dep>). Set this to B<arr> to get arrivals instead.
(B<dep>). Set this to B<arr> to get arrivals instead.
=item B<mot> => I<\%hashref>
Modes of transport to show. Accepted keys are: B<ice> (ICE trains), B<ic_ec>
Modes of transport to show. Accepted keys are: B<ice> (ICE trains), B<ic_ec>
(IC and EC trains), B<d> (InterRegio and similarly fast trains), B<nv>
("Nahverkehr", mostly RegionalExpress trains), B<s> ("S-Bahn"), B<bus>,
B<ferry>, B<u> ("U-Bahn") and B<tram>.
......@@ -239,7 +239,7 @@ By default, the following are shown: ice, ic_ec, d, nv, s.
=item $status->results()
Returns a list of arrivals/departures. Each list element is a
Returns a list of arrivals/departures. Each list element is a
Travel::Status::DE::DeutscheBahn::Result(3pm) object.
=back
......@@ -266,7 +266,7 @@ Unknown.
=head1 SEE ALSO
mris(1), Travel::Status::DE::DeutscheBahn::Result(3pm).
Travel::Status::DE::DeutscheBahn::Result(3pm).
=head1 AUTHOR
......
......@@ -76,7 +76,7 @@ version 0.0
=head1 DESCRIPTION
Travel::Status::DE::DeutscheBahn::Result describes a single arrival/departure
as obtained by Travel::Status::DE::DeutscheBahn. It contains information about
as obtained by Travel::Status::DE::DeutscheBahn. It contains information about
the platform, time, route and more.
=head1 METHODS
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment