nkf - Network Kanji Filter
nkf [-butjnesliohrTVvwWJESZxXFfmMBOcdILg] [file ...]
Nkf is a yet another kanji code converter among networks, hosts and terminals. It converts input kanji code to designated kanji code such as ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8, UTF-16 or UTF-32.
One of the most unique faculty of nkf is the guess of the input kanji encodings. It currently recognizes ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8, UTF-16 and UTF-32. So users needn't set the input kanji code explicitly.
By default, X0201 kana is converted into X0208 kana. For X0201 kana, SO/SI, SSO and ESC-(-I methods are supported. For automatic code detection, nkf assumes no X0201 kana in ShiftJIS. To accept X0201 in ShiftJIS, use -X, -x or -S.
Specify input and output encodings. Upper case is input. cf. --ic and --oc.
Output is buffered (DEFAULT), Output is unbuffered.
Specify the escape sequence for JIS X 0208.
Specify the escape sequence for US-ASCII/JIS X 0201 Roman. (DEFAULT B)
Text mode output (MS-DOS)
Folding on m length with n margin in a line. Without this option, fold length is 60 and fold margin is 10.
New line preserving line folding.
Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.
With -X or without this option, X0201 is converted into X0208 Kana. With -x, try to preserve X0208 kana and do not convert X0201 kana to X0208. In JIS output, ESC-(-I is used. In EUC output, SS2 is used.
Assume broken JIS-Kanji input, which lost ESC. Useful when your site is using old B-News Nihongo patch.
Replacing non iso-2022-jp char into a geta character (substitute character in Japanese).
MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT) To see ISO8859-1 (Latin-1) -l is necessary.
MIME encode. Header style. All ASCII code and control characters are intact.
Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP. -s, -e and -x are not compatible with this option.
Convert line breaks.
Convert for these systems.
Convert to named code.
Assume input system
Set the input or output codeset. NKF supports following codesets and those codeset names are case insensitive.
Specify the way that nkf handles unassigned characters. Without this option, --fb-skip is assumed.
When nkf converts to ShiftJIS, nkf adds a specified escape character to specified 2nd byte of ShiftJIS characters. 1st byte of argument is the escape character and following bytes are target characters.
Handle the characters extended in CP932 as unassigned characters.
When Unicode to Encoded byte conversion, don't convert characters which is not round trip safe. When Unicode to Unicode conversion, with this and -x option, nkf can be used as UTF converter. (In other words, without this and -x option, nkf doesn't save some characters)
When nkf converts strings that related to path, you should use this option.
Decode hex encoded characters.
Unescape percent escaped characters.
Decode character reference, such as "&#....;".
Overwrite original listed files by filtered result.
Note --overwrite preserves timestamps of original files.
Print guessed encoding and newline. (2 is default, 1 is only encoding)
Print nkf's help.
Print nkf's version.
Ignore rest of -option.
Copyright (c) 1987, Fujitsu LTD. (Itaru ICHIKAWA).
Copyright (c) 1996-2012, The nkf Project.