GPINYIN(1)                 General Commands Manual                GPINYIN(1)

NAME         top

       gpinyin - Chinese European-like writing within groff

SYNOPSIS         top

       gpinyin [-] [--] [filespec ...]
       gpinyin -h|--help
       gpinyin -v|--version

DESCRIPTION         top

       This is a preprocessor for groff(1).  It allows use of the Chinese
       European-like language Pinyin into groff(7) files.

OPTIONS         top

   Breaking Options
       An option is breaking, when the program just writes the information
       that was asked for and then stops.  All other arguments will be
       ignored by that.  The breaking options are here

       -h | --help
              Print help information with a short explanation of options to
              standard output.

       -v | --version
              Print version information to standard output.

   Filespec Options
       So far, there are only filespec and breaking options.

       filespec arguments are file names or the minus sign - for standard
       input.  As usual, the argument -- can be used in order to let all
       following arguments mean file names, even if the names begin with a
       minus character -.

PINYIN PARTS         top

       Pinyin parts in groff files are enclosed by two .pinyin requests with
       different arguments.  The starting request is
              \.pinyin start
              \.pinyin begin
       and the ending request is
              \.pinyin stop
              \.pinyin end

PINYIN DETAILS         top

       Pinyin is used for writing the Chinese language in a European-like
       (romanization) way.  The Chinese language consists of more than 400
       syllables, each with one of 5 different tones.  In Pinyin, such toned
       syllables can be appended to word-like connections.

       The Chinese language is based on about 411 defined syllables, see 

       In Pinyin, each syllable consists of 1 to 6 European-like letters,
       the normal ASCII characters in upper and lower case, the only unusual
       characters are the U dieresis (umlaut) in both cases, i.e.

       In the groff gpinyin input, all ASCII letters are written as usual.
       But the u/U dieresis can be written as either as \['u] or ue in lower
       case or \['U], Ue, UE in upper case.

       Each syllable has exactly one of 5 defined tones.  The 5th tone is
       not written at all, but each tone 1 to 4 is written as an accent
       above a defined vowel within the syllable.

       In the source file, these tones are written by adding a number 0 to 5
       after the syllable name.

       In each writing, the tone numbers 1 to 4 are transformed into accents
       above vowels.

       The 1st tone is the horizontal macron \[a-] ¯ , similar to a minus or
       sub character, but on top of the vowel.  In each source file, write
       the 1st tone as syllable1.

       The 2nd tone is the accute accent \[aa] ´.  In each source file,
       write the 2nd tone as syllable2.

       The 3rd tone is the caron sign, \[ah] ˇ , which looks a bit like a
       small v above the vowel.  In each source file, write the 3rd tone as

       The 4th tone is the grave accent \[ga] `.  In each source file, write
       the 4th tone as syllable4.

       The 5th tone is the no-tone.  The numbers 0 and 5 can be used for the
       (no-tone).  The no-tone number can be omitted, when the syllable is
       the end of some word.  But within a word of syllables, one of the no-
       tone numbers 0 or 5 must be written.

AUTHORS         top

       gpinyin was written by Bernd Warken ⟨<>⟩.

SEE ALSO         top

       groff(1), grog(1), and groffer(1) explain how to view roff documents.

       groff(7) and groff_char(7) are comprehensive references covering the
       language elements of GNU roff and the available glyph repetoire,

       Internet documents related to pinyin are
              Wikipedia pinyin⟩,
              Pinyin Table⟩,
              Unicode vowels for Pinyin⟩,
              pinyin to Unicode⟩,
              Online Chinese Tools⟩,
              Main pinyin website⟩,
              Where do the tone marks go?⟩,
              Pinyin for TeX 1 
              Pinyin for TeX 2 

COLOPHON         top

       This page is part of the groff (GNU troff) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a bug report for
       this manual page, see ⟨⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨⟩ on 2018-10-29.  (At
       that time, the date of the most recent commit that was found in the
       repository was 2018-10-25.)  If you discover any rendering problems
       in this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to

Groff Version 1.22.3          24 November 2017                    GPINYIN(1)