PNC(1)

🌸 NAME 🌸

okay so bestie, meet pnc 💖 — she's a command-line tool for phone number manipulation. And yes she lives in section 1 of the General Commands Manual, so she's a whole real one, no cap.

✨ SYNOPSIS ✨

pnc COMMAND [OPTIONS] INPUT

like, command first, then options, then the input. that's the whole vibe 💅

🎀 COMMANDS 🎀

pick one, bestie, she doesn't do "all of the above":

• valid — tests whether the phone number you passed as INPUT is a valid number or short number. Returns 0 (SUCCESS) if the number is valid, 1 (ERROR) otherwise. valid options here: -c, -v (verbose, default off). 👑
• info — displays information about the phone number given as INPUT. valid option: -c. 🦋
• format — formats a telephone number given as INPUT to the specified standard (E164 by default), result goes on stdout. valid options: -c, -f. ✨
• find — finds phone number in some text given as INPUT, result on stdout (one line per number found). valid options: -c, -f, -l. 🔍
• dialout — formats a phone number given as INPUT in e164 format for out-of-country dialing purposes. valid options: -c, -l. 🌍

🦋 OPTIONS 🦋

• -c COUNTRY-CODE — if you set this, the phone number(s) given in INPUT will be considered as being dialed from the country specified by the 2 uppercase letters COUNTRY-CODE (e.g. "FR", "US", ...). if you don't set it, pnc will look for numbers in the international format. 🌈
• -f FORMAT — sets the phone number output format. FORMAT must be one of e164, int (international), nat (national), or teluri (RFC3966 tel URI). the default value is e164. 💅
• -l LENIENCY — sets the phone number search leniency in INPUT. LENIENCY must be one of:
  • possible — phone numbers accepted are possible, but not necessarily valid. 🙈
  • valid (default value) — phone numbers accepted are possible and valid. numbers written in national format must have their national-prefix present if it is usually written for a number of this type.
  • strict — phone numbers accepted are valid and are grouped in a possible way for this locale. for example, a US number written as "65 02 53 00 00" and "650253 0000" are not accepted at this leniency level, whereas "650 253 0000", "650 2530000" or "6502530000" are. numbers with more than one / symbol in the national significant number are also dropped at this level. 😭
  • exact — phone numbers accepted are valid and are grouped in the same way that we would have formatted it, or as a single block. for example, a US number written as "650 2530000" is not accepted at this leniency level, whereas "650 253 0000" or "6502530000" are. numbers with more than one / symbol are also dropped at this level. 💀

(see https://javadoc.io/doc/com.googlecode.libphonenumber/libphonenumber/8.4.1 for more details)

💀 RETURN STATUS 💀

pnc returns 0 on successful operations, 1 if an error occurred (option error, parsing error). that's it, that's the whole mood. 🫶

👑 AUTHOR 👑

pnc is a fork of pn https://github.com/Orange-OpenSource/pn written by Camille Oudot <camille.oudot@orange.com> 💖

pnc is maintained by the Sxmo project: https://sxmo.org. you can find the source code at https://sxmo.org/source ✨

💜 COPYRIGHT 💜

original code (pn) used the Apache-2.0 license. Copyright (C) 2021 Camille Oudot <camille.oudot@orange.com> 🎀

pnc is licensed under the GPL-3.0-only license. Copyright (C) 2022 Sxmo Contributors 🌸

this program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation 🦋

this program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. ⚠️

you should have received a copy of the GNU General Public License along with this program. if not, see https://www.gnu.org/licenses/. 💅

and that's the whole page, bestie — straight from the PNC(1) page of the General Commands Manual. go forth and format some numbers, you absolute icon 👑💖