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

minor documentation improvements

parent 08c27ae4

README

+2 −2
Original line number Diff line number Diff line 
Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors

-------------------------------------------------------------------------



* <http://finalrewind.org/projects/Travel-Status-DE-IRIS/>

<https://finalrewind.org/projects/Travel-Status-DE-IRIS/>





Dependencies
@@ -27,7 +27,7 @@ not wish to build it), the following drop-in replacements are available: 
* Text::Levenshtein::XS

* Text::Levenshtein (about 10 times slower than the XS modules)



To use them, simply run:

To use them, run:

> sed -i 's/Text::LevenshteinXS/Text::Levenshtein::XS/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm

or

> sed -i 's/Text::LevenshteinXS/Text::Levenshtein/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm

bin/db-iris

+20 −12
Original line number Diff line number Diff line
@@ -220,9 +220,8 @@ sub get_station { 
sub show_help {

	my ($code) = @_;



	print 'Usage: db-iris [-r] [-c <classlist>] [-d <date>] '

	  . '[-o <output-flags>] [-p <platforms>] [-t <time>] '

	  . '[-T <typelist>] [-v|-V <via>] <station>' . "\n"

	print 'Usage: db-iris [-rx] [-d <date>] [-o <output-flags>]'

	  . '[-t <time>] [-v|-V <via>] [other options ...] <station>' . "\n"

	  . "See also: man db-iris\n";



	exit $code;
@@ -529,9 +528,8 @@ db-iris - Interface to the DeutscheBahn online departure monitor 


=head1 SYNOPSIS



B<db-iris> [B<-r>] [B<-c> I<classlist>] [B<-d> I<date>] [B<-o> I<output-flags>]

[B<-p> I<platforms>] [B<-t> I<time>] [B<-T> I<typelist>] [B<-v>|B<-V> I<via>]

I<station>

B<db-iris> [B<-rx>] [B<-d> I<date>] [B<-o> I<output-flags>]

[B<-t> I<time>] [B<-v>|B<-V> I<via>] [I<other options ...>] I<station>



=head1 VERSION
@@ -544,7 +542,7 @@ available at L<https://iris.noncd.db.de/wbt/js/index.html>. 


It requests all departures at I<station> and lists them on stdout, similar to

the big departure screens installed at most main stations. I<station> can be

either a DS100 station code (such as "EE"), a normal station name

a DS100 station code (such as "EE"), a normal station name

(such as "Essen Hbf" or "Dortmund UniversitE<auml>t"), or an IBNR / european station

number (such as 8000098). If no exact match is found, B<db-iris> will try to

find station names similar to I<station>.
@@ -579,7 +577,7 @@ IRIS backend, larger ones will not return data. 


=item B<-l>, B<--lookahead> I<int>



Return only those results which are less than I<int> minutes in the future.

Do not return results which are more than I<int> minutes in the future.

Defaults to 240 (4 hours).



Note that this is only an upper limit, not a guarantee to get every train
@@ -729,7 +727,17 @@ Show version information. 


=head1 EXIT STATUS



Zero unless things went wrong.

=over



=item 0: Normal operation



=item 1: Invalid arguments or unknown station



=item 2: Cannot get departures from backend (network issues?)



=item 3: Invalid date/time specified



=back



=head1 CONFIGURATION
@@ -751,16 +759,16 @@ None. 


=head1 BUGS AND LIMITATIONS



Unknown.

There are no known bugs at the moment.



=head1 AUTHOR



Copyright (C) 2013-2018 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>



The station data used by this script is provided by DB

Station&Service AG, Europaplatz 1, 10557 Berlin, Germany and also available

Station&Service AG, Europaplatz 1, 10557 Berlin, Germany and available

under a CC-BY 4.0 license on

L<http://data.deutschebahn.com/dataset/data-haltestellen>.

L<https://data.deutschebahn.com/dataset/data-haltestellen>.



=head1 LICENSE