/ 
Map-Tube-CLI-0.78
River stage one • 1 direct dependent • 1 total dependent
/ Map::Tube::CLI

NAME

Map::Tube::CLI - Command Line Interface for Map::Tube::* map.

VERSION

Version 0.78

DESCRIPTION

It provides simple command line interface to the package consuming Map::Tube. The distribution contains a script map-tube, using package Map::Tube::CLI.

SYNOPSIS

You can list all command line options by giving -h flag.

$ map-tube -h
USAGE: map-tube [-h] [long options...]

    --map=String      Map name
    --start=String    Start station name
    --end=String      End station name
    --preferred       Show preferred route
    --generate_map    Generate map as image
    --line=String     Line name for map
    --bgcolor=String  Map background color
    --line_mappings   Generate line mappings
    --line_notes      Generate line notes
    --list_lines      List lines
    --force           Force unsupported map (map name becomes case
                      sensitive)
    --debug           Run in debug mode

    --usage           show a short help message
    -h                show a compact help message
    --help            show a long help message
    --man             show the manual

COMMON USAGES

Shortest Route

You can also ask for shortest route in London Tube Map as below:

$ map-tube --map London --start 'Baker Street' --end 'Wembley Park'

Baker Street (Bakerloo, Circle, Hammersmith & City, Jubilee, Metropolitan), Finchley Road (Jubilee, Metropolitan), Wembley Park (Jubilee, Metropolitan)

Preferred Shortest Route

Now request for preferred route as below:

$ map-tube --map London --start 'Baker Street' --end 'Euston Square' --preferred

Baker Street (Circle, Hammersmith & City, Metropolitan), Great Portland Street (Circle, Hammersmith & City, Metropolitan), Euston Square (Circle, Hammersmith & City, Metropolitan)

Generate Full Map

To generate entire map, follow the command below:

$ map-tube --map Delhi --generate_map

In case you want different background color to the map then you can try below:

$ map-tube --map Delhi --bgcolor gray --generate_map

Generate Just a Line Map

To generate just a particular line map, follow the command below:

$ map-tube --map London --line Bakerloo --generate_map

In case you want different background color to the map then you can try below:

$ map-tube --map London --line DLR --bgcolor yellow --generate_map

Generate Line Mappings

$ map-tube --map London --line Bakerloo --line_mappings

Generate Line Notes

$ map-tube --map London --line Bakerloo --line_notes

List lines for the given map

$ map-tube --map London --list_lines

General Error

If encountered invalid map or missing map i.e not installed, you get an error message like below:

$ map-tube --map xYz --start 'Baker Street' --end 'Euston Square'
ERROR: Unsupported Map [xYz].

$ map-tube --map Kazan --start 'Baker Street' --end 'Euston Square'
ERROR: Missing Map [Kazan].

SUPPORTED MAPS

The command line parameter map can take one of the following map names. It is case insensitive i.e. 'London' and 'lOndOn' are the same.

You could use Task::Map::Tube::Bundle to install the supported maps.Please make sure you have the latest maps when you install.

METHODS

run()

This is the only method provided by the package Map::Tube::CLI. It does not expect any parameter. Here is the code from the supplied map-tube script.

use strict; use warnings;
use Map::Tube::CLI;

Map::Tube::CLI->new_with_options->run;

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/Map-Tube-CLI

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/Map-Tube-CLI/issues. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Map::Tube::CLI

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2015 - 2024 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.