contrib/gpinyin/gpinyin.man

   1 .TH GPINYIN @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
   2 .SH NAME
   3 gpinyin \- Chinese European-like writing within groff
   4 .
   5 .SH "SYNOPSIS"
   6 .\" The .SH was moved to this place in order to appease `apropos'.
   7 .
   8 .\" --------------------------------------------------------------------
   9 .\" Legalese
  10 .\" --------------------------------------------------------------------
  11 .
  12 .de co
  13 Copyright \[co] 2014 Free Software Foundation, Inc.
  14
  15 This file is part of gpinyin, which is part of groff, a free software
  16 project.
  17
  18 You can redistribute it and/or modify it under the terms of the GNU
  19 General Public License version 2 as published by the Free Software
  20 Foundation.
  21
  22 The license text is available in the internet at
  23 .UR http://www.gnu.org/licenses/gpl-2.0.html
  24 .UE .
  25 ..
  26 .
  27 .de au
  28 This file was written by Bernd Warken <groff-bernd.warken-72@web.de>.
  29 ..
  30 .
  31 .\" --------------------------------------------------------------------
  32 .\" Characters
  33 .\" --------------------------------------------------------------------
  34 .
  35 .ie t .ds EL \f[S]\N'188'\f[P]
  36 .el .ds EL \&.\|.\|.\&\
  37 .\" ie t .char \[Ellipsis] \f[S]\N'188'\f[P]
  38 .\" el .char \[Ellipsis] \&.\|.\|.\&\
  39 .\" called with \[Ellipsis]
  40 .
  41 .
  42 .\" --------------------------------------------------------------------
  43 .\" SH "SYNOPSIS"
  44 .\" --------------------------------------------------------------------
  45 .
  46 .SY gpinyin
  47 .OP \-
  48 .OP \-\-
  49 .OP \& "\%filespec \*(EL"
  50 .YS
  51 .
  52 .BR "gpinyin -h" | --help
  53 .br
  54 .BR "gpinyin -v" | --version
  55 .
  56 .
  57 .\" --------------------------------------------------------------------
  58 .SH DESCRIPTION
  59 .\" --------------------------------------------------------------------
  60 .
  61 This is a preprocesor for
  62 .BR \%groff (@MAN1EXT@).
  63 .
  64 It allows to add the Chinese European-like language
  65 .I Pinyin
  66 into
  67 .BR groff (7)
  68 files.
  69 .
  70 .
  71 .\" --------------------------------------------------------------------
  72 .SH "OPTIONS"
  73 .\" --------------------------------------------------------------------
  74 .
  75 .\" --------------------------------------------------------------------
  76 .SS "Breaking Options"
  77 .\" --------------------------------------------------------------------
  78 .
  79 An option is
  80 .IR breaking ,
  81 when the program just writes the information that was asked for and
  82 then stops.
  83 .
  84 All other arguments will be ignored by that.
  85 .
  86 The
  87 .I breaking
  88 options are here
  89 .
  90 .TP
  91 .B -h\~\fR|\fB\~--help
  92 Print help information with a short explanation of options to standard
  93 output.
  94 .
  95 .
  96 .TP
  97 .B -v\~\fR|\fB\~--version
  98 Print version information to standard output.
  99 .
 100 .
 101 .\" --------------------------------------------------------------------
 102 .SS "Filespec Options"
 103 .\" --------------------------------------------------------------------
 104 .
 105 So far, there are only
 106 .I filespec
 107 and
 108 .I breaking
 109 options.
 110 .
 111 .
 112 .P
 113 .I filespec
 114 arguments are file names or the minus sign
 115 .B \-
 116 for standard input.
 117 .
 118 As usual, the argument
 119 .B \-\-
 120 can be used in order to let all following arguments mean file names,
 121 even if the names begin with a minus character
 122 .BR \- .
 123 .
 124 .
 125 .\" --------------------------------------------------------------------
 126 .SH "PINYIN PARTS"
 127 .\" --------------------------------------------------------------------
 128 .
 129 .I Pinyin
 130 parts in
 131 .I groff files
 132 are enclosed by two
 133 .B .pinyin
 134 requests with different arguments.
 135 .
 136 The starting request is
 137 .RS
 138 .EX
 139 \e.pinyin start
 140 .EE
 141 .RE
 142 or
 143 .RS
 144 .EX
 145 \e.pinyin begin
 146 .EE
 147 .RE
 148 and the ending request is
 149 .RS
 150 .EX
 151 \e.pinyin stop
 152 .EE
 153 .RE
 154 or
 155 .RS
 156 .EX
 157 \e.pinyin end
 158 .EE
 159 .RE
 160 .
 161 .
 162 .\" --------------------------------------------------------------------
 163 .SH "PINYIN DETAILS"
 164 .\" --------------------------------------------------------------------
 165 .
 166 .I Pinyin
 167 is used for writing the Chinese language in a European-like
 168 (romanization) way.
 169 .
 170 The Chinese language consists of more than 400 syllables, each with
 171 one of 5 different tones.
 172 .
 173 In
 174 .IR Pinyin ,
 175 such toned syllables can be appended to word-like connections.
 176 .
 177 .
 178 .\" --------------------------------------------------------------------
 179 .SS "Syllables"
 180 .\" --------------------------------------------------------------------
 181 .
 182 The Chinese language is based on about 411 defined
 183 .IR syllables ,
 184 see
 185 .UR http://en.wikipedia.org/wiki/Pinyin_table
 186 .UE .
 187 .
 188 .
 189 .P
 190 In
 191 .IR Pinyin ,
 192 each syllable consists of 1 to 6 European-like letters, the normal
 193 ASCII characters in upper and lower case, the only unusual characters
 194 are the
 195 .BR "U dieresis " ( umlaut )
 196 in both cases, i.e.
 197 .BR [a-zA-ZüÜ] .
 198 .
 199 .
 200 .P
 201 In the
 202 .B groff gpinyin
 203 input,
 204 all ASCII letters are written as usual.
 205 .
 206 But the
 207 .BR u / U
 208 .B dieresis
 209 can be written as either as
 210 .B \e[\[aq]u] or
 211 .B ue
 212 in lower case or
 213 .BR \e[\[aq]U] ,
 214 .BR Ue ,
 215 .B UE
 216 in upper case.
 217 .
 218 .
 219 .\" --------------------------------------------------------------------
 220 .SS "Tones"
 221 .\" --------------------------------------------------------------------
 222 .
 223 Each syllable has exactly one of 5 defined
 224 .IR tones .
 225 .
 226 The 5th tone is not written at all, but each tone 1 to 4 is written
 227 as an accent above a defined vowel within the syllable.
 228 .
 229 .
 230 .P
 231 In the source file, these tones are written by adding a number 0 to 5
 232 after the syllable name.
 233 .
 234 .
 235 .P
 236 In each writing, the tone numbers 1 to 4 are transformed into accents
 237 above vowels.
 238 .
 239 .
 240 .P
 241 The 1st tone is the horizontal macron
 242 .BR \e[a\-]
 243 .B \[a-] ,
 244 similar to a minus or sub character, but on top of the vowel.
 245 .
 246 In each source file, write the 1st tone as
 247 .IB "syllable" 1\fR.
 248 .
 249 .
 250 .P
 251 The 2nd tone is the accute accent
 252 .B \e[aa]
 253 .BR \[aa] .
 254 .
 255 In each source file, write the 2nd tone as
 256 .IB "syllable" 2\fR.
 257 .
 258 .
 259 .P
 260 The 3rd tone is the caron sign,
 261 .BR \e[ah]
 262 .B \[ah] ,
 263 which looks a bit like a small
 264 .B v
 265 above the vowel.
 266 .
 267 In each source file, write the 3rd tone as
 268 .IB "syllable" 3\fR.
 269 .
 270 .
 271 .P
 272 The 4th tone is the grave accent
 273 .B \e[ga]
 274 .BR \[ga] .
 275 .
 276 In each source file, write the 4th tone as
 277 .IB "syllable" 4\fR.
 278 .
 279 .
 280 .P
 281 The 5th tone is the no-tone.
 282 .
 283 The numbers 0 and 5 can be used for the
 284 .BR ( no-tone ).
 285 .
 286 The
 287 .B no-tone
 288 number can be omitted, when the syllable is the end of some word.
 289 .
 290 But within a word of syllables, one of the
 291 .B no-tone
 292 numbers 0 or 5 must be written.
 293 .
 294 .
 295 .\" --------------------------------------------------------------------
 296 .SH "SEE ALSO"
 297 .\" --------------------------------------------------------------------
 298 .
 299 .TP
 300 .BR \%groff (@MAN1EXT@)
 301 .TQ
 302 .BR \%grog (@MAN1EXT@)
 303 .TQ
 304 .BR \%groffer (@MAN1EXT@)
 305 Man\-pages with section
 306 .B 1
 307 related to
 308 .IR groff .
 309 .
 310 They can be called with either
 311 .RS
 312 .RS
 313 .EX
 314 .BI man " name"
 315 .BI groffer "name"
 316 .EE
 317 .RE
 318 .RE
 319 .
 320 .
 321 .TP
 322 .BR \%groff (@MAN7EXT@)
 323 .TQ
 324 .BR \%groff_char (@MAN7EXT@)
 325 Man\-pages with section
 326 .B 7
 327 related to
 328 .IR groff .
 329 .
 330 They can be called with either
 331 .RS
 332 .RS
 333 .EX
 334 .BI "man 7" " name"
 335 .BI "groffer 7" " name"
 336 .EE
 337 .RE
 338 .RE
 339 .
 340 .
 341 .P
 342 Internet documents related to
 343 .I pinyin
 344 are
 345 .RS
 346 .br
 347 .UR http://\:en.wikipedia.org/\:wiki/\:Pinyin
 348 .I Wikipedia pinyin
 349 .UE ,
 350 .
 351 .br
 352 .UR http://\:en.wikipedia.org/\:wiki/\:Pinyin_table
 353 .I Pinyin Table
 354 .UE ,
 355 .
 356 .br
 357 .UR http://\;www.sino.uni-heidelberg.de/\:course_resources/\:s02/\:\
 358 py-vowels.htm
 359 .I Unicode vowels for Pinyin
 360 .UE ,
 361 .
 362 .br
 363 .UR http://\:www.foolsworkshop.com/\:ptou/\:index.html
 364 .IR pinyin to Unicode
 365 .UE ,
 366 .
 367 .br
 368 .UR http://\:www.mandarintools.com/
 369 .I Online Chinese Tools
 370 .UE ,
 371 .
 372 .br
 373 .UR http://\:www.pinyin.info/\:index.html
 374 .I Main pinyin website
 375 .UE ,
 376 .
 377 .br
 378 .UR http://\:www.pinyin.info/\:rules/\:where.html
 379 .I Where do the tone marks go?
 380 .UE ,
 381 .
 382 .br
 383 .UR http://\:git.savannah.gnu.org/\:gitweb/\:\
 384 ?p=cjk.git;a=blob_plain;f=doc/\:pinyin.txt;hb=HEAD
 385 .I Pinyin for TeX 1
 386 .UE ,
 387 .
 388 .br
 389 .UR http://\:git.savannah.gnu.org/\:gitweb/\:\
 390 ?p=cjk.git;a=blob_plain;f=texinput/p\:inyin.sty;hb=HEAD
 391 .I Pinyin for TeX 2
 392 .UE .
 393 .
 394 .RE
 395 .
 396 .
 397 .\" --------------------------------------------------------------------
 398 .SH "COPYING"
 399 .\" --------------------------------------------------------------------
 400 .co
 401 .\" --------------------------------------------------------------------
 402 .SH "AUTHORS"
 403 .\" --------------------------------------------------------------------
 404 .au
 405 .
 406 .
 407 .\" --------------------------------------------------------------------
 408 .\" Emacs settings
 409 .\" --------------------------------------------------------------------
 410 .
 411 .\" Local Variables:
 412 .\" mode: nroff
 413 .\" coding: latin-1
 414 .\" End: