Mathias Weidner > Algorithm-CheckDigits-v1.3.0 > checkdigits

Download:
Algorithm-CheckDigits-v1.3.0.tar.gz

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

checkdigits - check or generate check digits

VERSION ^

This document describes checkdigits version 0.0.1

SYNOPSIS ^

  checkdigits [Options] command [[number] ...]

  options:

   -algorithm alg - use this algorithm

  commands:

   check           - check validity of number containing checkdigit
   checkdigit      - return checkdigit belonging to number
   complete        - return number completed with checkdigit
   list_algorithms - list all known algorithms
   describe        - describe the given algorithms

DESCRIPTION ^

This is a command line program that may be used to compute any checkdigit known by the perl module Algorithm::CheckDigits.

OPTIONS AND COMMANDS ^

Options

-algorithm alg

Compute checkdigits according to algorithm alg. Instead of providing the algorithm with this option, you may choose to rename the program to the name of the algorithm or to checkdigits- followed by the name of the algorithm.

You must provide the algorithm with any of these means or the program will not compute any checkdigit.

Commands

check

checkdigit

complete

When called with this command, the program will take the number compute the appropriate checkdigits and return the complete number with checkdigits.

describe

Called with this command, the program will list the algorithm handles given on the command line with a short description or the word "unknown" for any unknown algorithm. See command list_algorithms for a list of known algorithms.

list_algorithms

Called with this command, the program will list all known algorithms together with a short description and then exit.

DIAGNOSTICS ^

CONFIGURATION AND ENVIRONMENT ^

At the moment the program doesn't recognise any environment variables.

The algorithm to use may be predefined by renaming the program to the name of the algorithm or to checkdigits- followed by the name of the algorithm.

AUTHOR ^

Mathias Weidner mamawe@cpan.org

LICENCE AND COPYRIGHT ^

Copyright (c) 2010, Mathias Weidner mamawe@cpan.org. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: