CHECKDIGITS(1p)

💖 NAME 💖

okay so bestie, this is checkdigits — check or generate check digits. that's the whole vibe. ✨

---

🌸 VERSION 🌸

This document describes checkdigits v1.3.3. yes queen, we're on the 1.3.3 era 🎀

---

🦋 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 💜

So this is a command line program, and what it does is compute any checkdigit that the perl module Algorithm::CheckDigits knows about. that's it, that's the whole thing. it's giving "tiny utility, enormous power" 💅

---

✨ OPTIONS AND COMMANDS ✨

🍓 Options

• -algorithm alg — compute checkdigits according to algorithm alg. and here's the cute part: instead of passing the algorithm with this option, you can also rename the program to the name of the algorithm, or to checkdigits- followed by the name of the algorithm. iconic behavior tbh 🫶

You must provide the algorithm through one of these means, or the program will not compute any checkdigit. no algorithm, no checkdigit, that's the rules bestie 😭

🌈 Commands

• check — (listed here, no blurb given, she's mysterious like that 💀)
• checkdigit — (also listed, also keeping her secrets)
• complete — when you call the program with this command, it takes the number, computes the appropriate checkdigits, and returns the complete number with checkdigits. chef's kiss.
• describe — call it with this command and the program will list the algorithm handles you gave on the command line, with a short description, or the word unknown for any algorithm it doesn't know. (need a full list of known algorithms? go look at the list_algorithms command, iykyk.)
• list_algorithms — call it with this command and the program will list all known algorithms together with a short description, and then exit. she said "here's the menu, now go" 🎀

---

💅 DIAGNOSTICS 💅

literally nothing here. the original page is empty on this one, no cap. moving on 🦋

---

🎀 CONFIGURATION AND ENVIRONMENT 🎀

At the moment, the program doesn't recognise any environment variables. nope, none, zero, nada 🙈

But! 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. same trick as the option section, and honestly? obsessed.

---

🫶 AUTHOR 🫶

Mathias Weidner mamawe@cpan.org — thank you for your service queen 👑

---

💜 LICENCE AND COPYRIGHT 💜

Copyright (c) 2010-2020, 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 🌈

bestie this next part is in ALL CAPS and it means every single word, so read it, fr fr:

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.

---

and that's the whole page, bestie 💖 this one came to you from perl v5.36.0, dated 2022-10-13, and it lives in the CHECKDIGITS(1p) section of the User Contributed Perl Documentation. go forth and compute those checkdigits. slay. 💅✨