{
    "mode": "man",
    "parameter": "gpinyin",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/gpinyin/1/json",
    "generated": "2026-06-15T13:12:55Z",
    "synopsis": "gpinyin [input-file ...]",
    "sections": {
        "NAME": {
            "content": "gpinyin - use Hanyu Pinyin Chinese in roff\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "gpinyin [input-file ...]\n",
            "subsections": [
                {
                    "name": "gpinyin -h",
                    "content": ""
                },
                {
                    "name": "gpinyin --help",
                    "content": ""
                },
                {
                    "name": "gpinyin -v",
                    "content": ""
                },
                {
                    "name": "gpinyin --version",
                    "content": ""
                }
            ]
        },
        "DESCRIPTION": {
            "content": "gpinyin  is  a  preprocessor  for  groff(1) that facilitates use of the Hanyu Pinyin groff(7)\nfiles.  Pinyin is a method for writing the Chinese language with  the  Latin  alphabet.   The\nChinese  language consists of more than four hundred syllables, each with one of five differ‐\nent tones.  In Pinyin, a syllable is written in the Latin alphabet and a numeric tone indica‐\ntor can be appended to each syllable.\n\nEach  input-file  is  a file name or the hyphen-minus character “-” to indicate that standard\ninput should be read.  As usual, the argument “--” can be used in order to force  interpreta‐\ntion of all remaining arguments as file names, even if an input-file argument begins with the\nhyphen-minus character.\n",
            "subsections": [
                {
                    "name": "Pinyin Sections",
                    "content": "Pinyin sections in groff files are enclosed by two .pinyin requests with different arguments.\nThe starting request is\n.pinyin start\nor\n.pinyin begin\nand the ending request is\n.pinyin stop\nor\n.pinyin end\n.\n"
                },
                {
                    "name": "Syllables",
                    "content": "The  spoken  Chinese  language is based on about 411 syllables; see ⟨http://en.wikipedia.org/\nwiki/Pinyintable⟩.\n\nIn Pinyin, each syllable consists of one to six letters from the Latin alphabet;  these  let‐\nters  comprise  the fifty-two upper- and lowercase letters from the ASCII character set, plus\nthe letter “U” with dieresis (umlaut) in both cases—in other words, the members  of  the  set\n“[a–zA–ZüÜ]”.\n\nIn  groff  input,  all ASCII letters are written as themselves.  The “u with dieresis” can be\nwritten as “\\[:u]” in lowercase or “\\[:U]” in uppercase.  Within  .pinyin  sections,  gpinyin\nsupports the form “ue” for lowercase and the forms “Ue” and “UE” for uppercase.\n"
                },
                {
                    "name": "Tones",
                    "content": "Each  syllable  has  exactly  one of five tones.  The fifth tone is not explicitly written at\nall, but each of the first through fourth tones is indicated with a diacritic  above  a  spe‐\ncific vowel within the syllable.\n\nIn a gpinyin source file, these tones are written by adding a numeral in the range 0 to 5 af‐\nter the syllable.  The tone numbers 1 to 4 are transformed into accents above vowels  in  the\noutput.  The tone numbers 0 and 5 are synonymous.\n\nThe following table summarizes the tones.  Some output devices will not be able to render ev‐\nery output example.\n\nTone     Description      Diacritic   Example Input   Example Output\n─────────────────────────────────────────────────────────────────────\nfirst    flat             ¯           ma1             mā\nsecond   rising           ´           ma2             má\nthird    falling-rising   ˇ           ma3             mǎ\nfourth   falling          `           ma4             mà\nfifth    neutral          (none)      ma0             ma\nma5\n\nThe neutral tone number can be omitted from a word-final syllable, but not otherwise.\n"
                }
            ]
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-h",
                    "content": "--help Print usage information and exit.\n",
                    "flag": "-h"
                },
                {
                    "name": "-v",
                    "content": "",
                    "flag": "-v"
                },
                {
                    "name": "--version",
                    "content": "Print version information and exit.\n",
                    "long": "--version"
                }
            ]
        },
        "AUTHORS": {
            "content": "gpinyin was written by Bernd Warken ⟨<groff-bernd.warken-72@web.de>⟩.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Useful documents on the World Wide Web related to Pinyin include\n“Pinyin” (Wikipedia) ⟨http://en.wikipedia.org/wiki/Pinyin⟩,\n“Pinyin table” (Wikipedia) ⟨http://en.wikipedia.org/wiki/Pinyintable⟩,\nPinyin to Unicode ⟨http://www.foolsworkshop.com/ptou/index.html⟩,\nOn-line Chinese Tools ⟨http://www.mandarintools.com/⟩,\nPinyin.info: a guide  to  the  writing  of  Mandarin  Chinese  in  romanization  ⟨http://\nwww.pinyin.info/index.html⟩,\n“Where do the tone marks go?” (Pinyin.info) ⟨http://www.pinyin.info/rules/where.html⟩,\npinyin.txt  from  the  CJK  macro  package  for  TeX ⟨http://git.savannah.gnu.org/gitweb/\n?p=cjk.git;a=blobplain;f=doc/pinyin.txt;hb=HEAD⟩,\nand\npinyin.sty from  the  CJK  macro  package  for  TeX  ⟨http://git.savannah.gnu.org/gitweb/\n?p=cjk.git;a=blobplain;f=texinput/pinyin.sty;hb=HEAD⟩.\n\ngroff(1), grog(1), and groffer(1) explain how to view roff documents.\n\ngroff(7) and groffchar(7) are comprehensive references covering the language elements of GNU\nroff and the available glyph repertoire, respectively.\n\n\n\ngroff 1.22.4                                23 March 2022                                 GPINYIN(1)",
            "subsections": []
        }
    },
    "summary": "gpinyin - use Hanyu Pinyin Chinese in roff",
    "flags": [
        {
            "flag": "-h",
            "long": null,
            "arg": null,
            "description": "--help Print usage information and exit."
        },
        {
            "flag": "-v",
            "long": null,
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": "--version",
            "arg": null,
            "description": "Print version information and exit."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "groff",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/groff/1/json"
        },
        {
            "name": "grog",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/grog/1/json"
        },
        {
            "name": "groffer",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/groffer/1/json"
        },
        {
            "name": "groff",
            "section": "7",
            "url": "https://www.chedong.com/phpMan.php/man/groff/7/json"
        },
        {
            "name": "groffchar",
            "section": "7",
            "url": "https://www.chedong.com/phpMan.php/man/groffchar/7/json"
        }
    ]
}