PYPINYIN(1)

💖 NAME 💖

pypinyin — it's the program to convert Chinese text to pinyin, bestie!! 🌸

And hi yes, this whole thing is the pypinyin User Manual (manual name drop, we're fancy now 👑), so sit down, grab a boba, and let's get you fluent in this little command. 🧋✨

---

🌸 SYNOPSIS 🌸

okay so this is the shape of it, copy-paste vibes only:

pypinyin [{-f | --func} {pinyin | slug}] [{-s | --style} STYLE]
         [{-p | --separator} SEPARATOR]
         [{-e | --errors} {default | ignore | replace}]
         [{-m | --heteronym}]

pypinyin [{-h | --help} | {-V | --version}]

---

🦋 DESCRIPTION 🦋

This manual page documents briefly the pypinyin command. 💅

Real talk: this manual page was written for the Debian distribution because the original program does not have a manual page. Not me being the one to step up and write the docs… main character energy fr fr. 😭

pypinyin is a program that converts a Chinese string to pinyin. That's it, that's the whole job, and it does it slayfully. 🔥

---

🎀 OPTIONS 🎀

The program follows the usual GNU command line syntax, with long options starting with two dashes (-). A summary of options is included below. For a complete description, see the info(1) files. 👀

• -f {pinyin | slug} , --func {pinyin | slug} — the function name, pick your fighter. 🥊
• -s STYLE, --style STYLE — the pinyin style. Default is "zh4ao" and yes that's the literal default, write it down. ✍️
• -p SEPERATOR, --separator SEPERATOR — the slug seperator (spelling is canon, don't @ me). Default is "-". 🍓
• -e {default | ignore | replace} , --errors {default | ignore | replace} — how to handle a non-pinyin string. Default is "default". Choose wisely bestie. 💀
• -m, --heteronym — Enable heteronym. 🫶
• -h, --help — Show summary of options. (That's me, I'm the summary. 🙈)
• -V, --version — Show version of program. ⭐

lowkey reminder: -h and -V live in their own little synopsis line up there, they're not chilling with the other flags. iykyk. 🌈

---

👑 AUTHOR 👑

Ying-Chun Liu <paulliu@debian.org> Wrote this manpage for the Debian system. Legend behavior, no cap. 💜

---

📜 COPYRIGHT 📜

Copyright © 2024 Ying-Chun Liu (PaulLiu)

This manual page was written for the Debian system (and may be used by others).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

k bye bestie!! 🫶✨ this was pypinyin from the pypinyin User Manual, version dated 08/13/2025 — go convert something gorgeous and drink some water, mwah 💖