diff options
author | Daniel Friesel <derf@finalrewind.org> | 2015-10-07 11:31:08 +0200 |
---|---|---|
committer | Daniel Friesel <derf@finalrewind.org> | 2015-10-07 11:31:08 +0200 |
commit | d35b36d0b81c12fbb828a59f2305e491306b9840 (patch) | |
tree | 213627a06351d21ca0425d7c4f0b5ab39498f0d5 | |
parent | 5d09685108518eb23917168059ca0aa6a2126e3b (diff) |
update documentation
-rwxr-xr-x | bin/aseag-m | 43 |
1 files changed, 29 insertions, 14 deletions
diff --git a/bin/aseag-m b/bin/aseag-m index 4fc4c9b..22303a6 100755 --- a/bin/aseag-m +++ b/bin/aseag-m @@ -60,7 +60,8 @@ my $status = Travel::Status::DE::ASEAG->new; sub show_help { my ($code) = @_; - print "Usage: aseag-m [-abfprV] [-l <lines>] [-v <stopname>] <stopname>\n" + print 'Usage: aseag-m [-pV] [-o <output>] [-l <lines>] [-v <stopname>] ' + . "<stopname>\n" . "See also: man aseag-m\n"; exit $code; @@ -230,7 +231,8 @@ aseag-m - Unofficial interface to the ASEAG departure monitor =head1 SYNOPSIS -B<aseag-m> [B<-abfprV>] [B<-l> I<lines>] [B<-s> I<timefmt> | B<-S> I<timefmt>] +B<aseag-m> [B<-pV>] [B<-l> I<lines>] [B<-o> I<outputtypes>] +[B<-s> I<timefmt> | B<-S> I<timefmt>] [B<-v> I<stopname>] I<stopname> =head1 VERSION @@ -245,34 +247,47 @@ B<aseag-m> lists upcoming bus departures at the ASEAG stop I<name>. =over -=item B<-a>, B<--route-after> +=item B<-l>, B<--line> I<lines> -For each departure, include the route leading to I<name>. Both stop names and -departure times are shown. +Limit output to departures of I<lines> (comma-separated list of line +names, may be used multiple times). + +=item B<-o>, B<--output> I<outputtypes> -=item B<-b>, B<--route-before> +Format output according to I<outputtypes>. I<outputtypes> is a +comma-separated list and the B<--output> option may be repeated. Each +output type has both a short and a long form, so for instance both +C<< -or,T >> and C<< --output=route_interesting,relative_times >> are valid. + +Valid output types are: + +=over + +=item a / route_after For each departure, include the route after I<name>. Both stop names and departure times are shown. -=item B<-f>, B<--full-route> +=item b / route_before + +For each departure, include the route leading to I<name>. Both stop names and +departure times are shown. + +=item f / route_full For each departure, include the entire route (stop names and departure times). -=item B<-l>, B<--line> I<lines> +=item T / relative_times -Limit output to departures of I<lines> (comma-separated list of line -names, may be used multiple times). +Show relative times. Applies to departure and route output. + +=back =item B<-p>, B<--with-past> Include past departures. Applies both to the departure output and to the route output of B<-a>, B<-b>, B<-f>. -=item B<-r>, B<--relative> - -Show relative times. Appleas both to departure and route output. - =item B<-s>, B<--strftime> I<format> Format absolute times in I<format>, applies both to departure and route |