1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
132 .TH nkf 1 "2018-12-15" "nkf 2.1.5" " "
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 nkf \- Network Kanji Filter
140 .IX Header "SYNOPSIS"
141 nkf \fB[\-butjnesliohrTVvwWJESZxXFfmMBOcdILg]\fR \fB[\fR\fIfile ...\fR\fB]\fR
143 .IX Header "DESCRIPTION"
144 \&\fBNkf\fR is a yet another kanji code converter among networks, hosts and terminals.
145 It converts input kanji code to designated kanji code
146 such as \s-1ISO\-2022\-JP,\s0 Shift_JIS, EUC-JP, \s-1UTF\-8, UTF\-16\s0 or \s-1UTF\-32.\s0
148 One of the most unique faculty of \fBnkf\fR is the guess of the input kanji encodings.
149 It currently recognizes \s-1ISO\-2022\-JP,\s0 Shift_JIS, EUC-JP, \s-1UTF\-8, UTF\-16\s0 and \s-1UTF\-32.\s0
150 So users needn't set the input kanji code explicitly.
152 By default, X0201 kana is converted into X0208 kana.
153 For X0201 kana, \s-1SO/SI, SSO\s0 and \s-1ESC\-\s0(\-I methods are supported.
154 For automatic code detection, nkf assumes no X0201 kana in Shift_JIS.
155 To accept X0201 in Shift_JIS, use \fB\-X\fR, \fB\-x\fR or \fB\-S\fR.
157 multiple options are specifed as seprate strings, such as
160 \& print nkf(\*(Aq\-\-ic=UTF8\-MAC\*(Aq, \*(Aq\-w\*(Aq, $string), "\en";
163 except the last arguments.
166 .IP "\fB\-J \-S \-E \-W \-W16 \-W32 \-j \-s \-e \-w \-w16 \-w32\fR" 4
167 .IX Item "-J -S -E -W -W16 -W32 -j -s -e -w -w16 -w32"
168 Specify input and output encodings. Upper case is input.
169 cf. \-\-ic and \-\-oc.
173 \&\s-1ISO\-2022\-JP\s0 (\s-1JIS\s0 code).
176 Shift_JIS and \s-1JIS X 0201\s0 kana.
177 EUC-JP is recognized as X0201 kana. Without \fB\-x\fR flag,
178 \&\s-1JIS X 0201\s0 Katakana (a.k.a.halfwidth kana) is converted into \s-1JIS X 0208.\s0
179 If you use Windows, see Windows\-31J (\s-1CP932\s0).
186 .IP "\fB\-W16[\s-1BL\s0][0]\fR" 4
187 .IX Item "-W16[BL][0]"
189 B\s0 or L gives whether Big Endian or Little Endian.
190 0 gives whther put \s-1BOM\s0 or not.
191 .IP "\fB\-W32[\s-1BL\s0][0]\fR" 4
192 .IX Item "-W32[BL][0]"
194 B\s0 or L gives whether Big Endian or Little Endian.
195 0 gives whther put \s-1BOM\s0 or not.
199 .IP "\fB\-b \-u\fR" 4
201 Output is buffered (\s-1DEFAULT\s0), Output is unbuffered.
205 .IP "\fB\-i[@B]\fR" 4
207 Specify the escape sequence for \s-1JIS X 0208.\s0
211 Use \s-1ESC\s0 ( @. (\s-1JIS X 0208\-1978\s0)
214 Use \s-1ESC\s0 ( B. (\s-1JIS X 0208\-1983/1990 DEFAULT\s0)
218 .IP "\fB\-o[\s-1BJ\s0]\fR" 4
220 Specify the escape sequence for \s-1US\-ASCII/JIS X 0201\s0 Roman. (\s-1DEFAULT B\s0)
223 {de/en}crypt \s-1ROT13/47\s0
224 .IP "\fB\-h[123] \-\-hiragana \-\-katakana \-\-katakana\-hiragana\fR" 4
225 .IX Item "-h[123] --hiragana --katakana --katakana-hiragana"
228 .IP "\fB\-h1 \-\-hiragana\fR" 4
229 .IX Item "-h1 --hiragana"
231 Katakana to Hiragana conversion.
232 .IP "\fB\-h2 \-\-katakana\fR" 4
233 .IX Item "-h2 --katakana"
234 Hiragana to Katakana conversion.
235 .IP "\fB\-h3 \-\-katakana\-hiragana\fR" 4
236 .IX Item "-h3 --katakana-hiragana"
237 Katakana to Hiragana and Hiragana to Katakana conversion.
243 Text mode output (MS-DOS)
244 .IP "\fB\-f[\f(BIm\fB [\- \f(BIn\fB]]\fR" 4
245 .IX Item "-f[m [- n]]"
246 Folding on \fIm\fR length with \fIn\fR margin in a line.
247 Without this option, fold length is 60 and fold margin is 10.
250 New line preserving line folding.
251 .IP "\fB\-Z[0\-3]\fR" 4
253 Convert X0208 alphabet (Fullwidth Alphabets) to \s-1ASCII.\s0
255 .IP "\fB\-Z \-Z0\fR" 4
257 Convert X0208 alphabet to \s-1ASCII.\s0
260 Convert X0208 kankaku to single \s-1ASCII\s0 space.
263 Convert X0208 kankaku to double \s-1ASCII\s0 spaces.
266 Replacing fullwidth >, <, ", & into '>', '<', '"', '&' as in \s-1HTML.\s0
270 .IP "\fB\-X \-x\fR" 4
272 With \fB\-X\fR or without this option, X0201 is converted into X0208 Kana.
273 With \fB\-x\fR, try to preserve X0208 kana and do not convert X0201 kana to X0208.
274 In \s-1JIS\s0 output, \s-1ESC\-\s0(\-I is used. In \s-1EUC\s0 output, \s-1SS2\s0 is used.
275 .IP "\fB\-B[0\-2]\fR" 4
277 Assume broken JIS-Kanji input, which lost \s-1ESC.\s0
278 Useful when your site is using old B\-News Nihongo patch.
282 allows any chars after \s-1ESC\-\s0( or \s-1ESC\-$.\s0
285 force \s-1ASCII\s0 after \s-1NL.\s0
291 Replacing non iso\-2022\-jp char into a geta character
292 (substitute character in Japanese).
293 .IP "\fB\-m[\s-1BQN0\s0]\fR" 4
295 \&\s-1MIME ISO\-2022\-JP/ISO8859\-1\s0 decode. (\s-1DEFAULT\s0)
296 To see \s-1ISO8859\-1\s0 (Latin\-1) \-l is necessary.
300 Decode \s-1MIME\s0 base64 encoded stream. Remove header or other part before
304 Decode \s-1MIME\s0 quoted stream. '_' in quoted stream is converted to space.
308 It allows line break in the middle of the base64 encoding.
311 No \s-1MIME\s0 decode.
317 \&\s-1MIME\s0 encode. Header style. All \s-1ASCII\s0 code and control characters are intact.
321 \&\s-1MIME\s0 encode Base64 stream.
322 Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.
325 Perform quoted encoding.
331 Input and output code is \s-1ISO8859\-1\s0 (Latin\-1) and \s-1ISO\-2022\-JP.\s0
332 \&\fB\-s\fR, \fB\-e\fR and \fB\-x\fR are not compatible with this option.
333 .IP "\fB\-L[uwm] \-d \-c\fR" 4
334 .IX Item "-L[uwm] -d -c"
337 .IP "\fB\-Lu \-d\fR" 4
340 .IP "\fB\-Lw \-c\fR" 4
342 windows (\s-1CRLF\s0)
347 Without this option, nkf doesn't convert line breaks.
351 .IP "\fB\-\-fj \-\-unix \-\-mac \-\-msdos \-\-windows\fR" 4
352 .IX Item "--fj --unix --mac --msdos --windows"
353 Convert for these systems.
354 .IP "\fB\-\-jis \-\-euc \-\-sjis \-\-mime \-\-base64\fR" 4
355 .IX Item "--jis --euc --sjis --mime --base64"
356 Convert to named code.
357 .IP "\fB\-\-jis\-input \-\-euc\-input \-\-sjis\-input \-\-mime\-input \-\-base64\-input\fR" 4
358 .IX Item "--jis-input --euc-input --sjis-input --mime-input --base64-input"
360 .IP "\fB\-\-ic=\f(BIinput codeset\fB \-\-oc=\f(BIoutput codeset\fB\fR" 4
361 .IX Item "--ic=input codeset --oc=output codeset"
362 Set the input or output codeset.
363 \&\s-1NKF\s0 supports following codesets and those codeset names are case insensitive.
365 .IP "\s-1ISO\-2022\-JP\s0" 4
366 .IX Item "ISO-2022-JP"
367 a.k.a. \s-1RFC1468,\s0 7bit \s-1JIS, JUNET\s0
368 .IP "EUC-JP (eucJP-nkf)" 4
369 .IX Item "EUC-JP (eucJP-nkf)"
370 a.k.a. \s-1AT&T JIS,\s0 Japanese \s-1EUC, UJIS\s0
372 .IX Item "eucJP-ascii"
376 .IP "\s-1CP51932\s0" 4
379 Microsoft Version of EUC-JP.
382 a.k.a. \s-1SJIS,\s0 MS_Kanji
384 .IX Item "Windows-31J"
386 .IP "\s-1UTF\-8\s0" 4
388 same as \s-1UTF\-8N\s0
389 .IP "\s-1UTF\-8N\s0" 4
391 \&\s-1UTF\-8\s0 without \s-1BOM\s0
392 .IP "\s-1UTF\-8\-BOM\s0" 4
394 \&\s-1UTF\-8\s0 with \s-1BOM\s0
395 .IP "\s-1UTF8\-MAC\s0 (input only)" 4
396 .IX Item "UTF8-MAC (input only)"
397 decomposed \s-1UTF\-8\s0
398 .IP "\s-1UTF\-16\s0" 4
400 same as \s-1UTF\-16BE\s0
401 .IP "\s-1UTF\-16BE\s0" 4
403 \&\s-1UTF\-16\s0 Big Endian without \s-1BOM\s0
404 .IP "\s-1UTF\-16BE\-BOM\s0" 4
405 .IX Item "UTF-16BE-BOM"
406 \&\s-1UTF\-16\s0 Big Endian with \s-1BOM\s0
407 .IP "\s-1UTF\-16LE\s0" 4
409 \&\s-1UTF\-16\s0 Little Endian without \s-1BOM\s0
410 .IP "\s-1UTF\-16LE\-BOM\s0" 4
411 .IX Item "UTF-16LE-BOM"
412 \&\s-1UTF\-16\s0 Little Endian with \s-1BOM\s0
413 .IP "\s-1UTF\-32\s0" 4
415 same as \s-1UTF\-32BE\s0
416 .IP "\s-1UTF\-32BE\s0" 4
418 \&\s-1UTF\-32\s0 Big Endian without \s-1BOM\s0
419 .IP "\s-1UTF\-32BE\-BOM\s0" 4
420 .IX Item "UTF-32BE-BOM"
421 \&\s-1UTF\-32\s0 Big Endian with \s-1BOM\s0
422 .IP "\s-1UTF\-32LE\s0" 4
424 \&\s-1UTF\-32\s0 Little Endian without \s-1BOM\s0
425 .IP "\s-1UTF\-32LE\-BOM\s0" 4
426 .IX Item "UTF-32LE-BOM"
427 \&\s-1UTF\-32\s0 Little Endian with \s-1BOM\s0
431 .IP "\fB\-\-fb\-{skip, html, xml, perl, java, subchar}\fR" 4
432 .IX Item "--fb-{skip, html, xml, perl, java, subchar}"
433 Specify the way that nkf handles unassigned characters.
434 Without this option, \-\-fb\-skip is assumed.
435 .IP "\fB\-\-prefix=\f(BIescape character\fB\f(BItarget character\fB..\fR" 4
436 .IX Item "--prefix=escape charactertarget character.."
437 When nkf converts to Shift_JIS,
438 nkf adds a specified escape character to specified 2nd byte of Shift_JIS characters.
439 1st byte of argument is the escape character and following bytes are target characters.
440 .IP "\fB\-\-no\-cp932ext\fR" 4
441 .IX Item "--no-cp932ext"
442 Handle the characters extended in \s-1CP932\s0 as unassigned characters.
443 .IP "\fB\-\-no\-best\-fit\-chars\fR" 4
444 .IX Item "--no-best-fit-chars"
445 When Unicode to Encoded byte conversion,
446 don't convert characters which is not round trip safe.
447 When Unicode to Unicode conversion,
448 with this and \-x option, nkf can be used as \s-1UTF\s0 converter.
449 (In other words, without this and \-x option, nkf doesn't save some characters)
451 When nkf converts strings that related to path, you should use this opion.
452 .IP "\fB\-\-cap\-input\fR" 4
453 .IX Item "--cap-input"
454 Decode hex encoded characters.
455 .IP "\fB\-\-url\-input\fR" 4
456 .IX Item "--url-input"
457 Unescape percent escaped characters.
458 .IP "\fB\-\-numchar\-input\fR" 4
459 .IX Item "--numchar-input"
460 Decode character reference, such as \*(L"&#....;\*(R".
461 .IP "\fB\-\-in\-place[=\fR\fI\s-1SUFFIX\s0\fR\fB]\fR \fB\-\-overwrite[=\fR\fI\s-1SUFFIX\s0\fR\fB]\fR" 4
462 .IX Item "--in-place[=SUFFIX] --overwrite[=SUFFIX]"
463 Overwrite \fBoriginal\fR listed files by filtered result.
465 \&\fBNote\fR \-\-overwrite preserves timestamps of original files.
466 .IP "\fB\-\-guess=[12]\fR" 4
467 .IX Item "--guess=[12]"
468 Print guessed encoding and newline. (2 is default, 1 is only encoding)
469 .IP "\fB\-\-help\fR" 4
472 .IP "\fB\-\-version\fR" 4
477 Ignore rest of \-option.
480 Copyright (c) 1987, Fujitsu \s-1LTD.\s0 (Itaru \s-1ICHIKAWA\s0).
482 Copyright (c) 1996\-2018, The nkf Project.