1. Manuals
  2. Tumbleweed
  3. nkf
  4. nkf(1)

Scroll to navigation

nkf(1) nkf(1)

NAME

nkf - Network Kanji Filter

SYNOPSIS

nkf [-butjnesliohrTVvwWJESZxXFfmMBOcdILg] [file ...]

DESCRIPTION

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 Shift_JIS. To accept X0201 in Shift_JIS, use -X, -x or -S.

multiple options are specifed as seprate strings, such as

  print nkf('--ic=UTF8-MAC', '-w', $string), "\n";

except the last arguments.

OPTIONS

Specify input and output encodings. Upper case is input. cf. --ic and --oc.
ISO-2022-JP (JIS code).
Shift_JIS and JIS X 0201 kana. EUC-JP is recognized as X0201 kana. Without -x flag, JIS X 0201 Katakana (a.k.a.halfwidth kana) is converted into JIS X 0208. If you use Windows, see Windows-31J (CP932).
EUC-JP.
UTF-8N.
UTF-16. B or L gives whether Big Endian or Little Endian. 0 gives whther put BOM or not.
UTF-32. B or L gives whether Big Endian or Little Endian. 0 gives whther put BOM or not.
Output is buffered (DEFAULT), Output is unbuffered.
No conversion.
Specify the escape sequence for JIS X 0208.
Use ESC ( @. (JIS X 0208-1978)
Use ESC ( B. (JIS X 0208-1983/1990 DEFAULT)
Specify the escape sequence for US-ASCII/JIS X 0201 Roman. (DEFAULT B)
{de/en}crypt ROT13/47
Katakana to Hiragana conversion.
Hiragana to Katakana conversion.
Katakana to Hiragana and Hiragana to Katakana conversion.
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.
Convert X0208 alphabet to ASCII.
Convert X0208 kankaku to single ASCII space.
Convert X0208 kankaku to double ASCII spaces.
Replacing fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as in HTML.
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.
allows any chars after ESC-( or ESC-$.
force ASCII after NL.
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.
Decode MIME base64 encoded stream. Remove header or other part before conversion.
Decode MIME quoted stream. '_' in quoted stream is converted to space.
Non-strict decoding. It allows line break in the middle of the base64 encoding.
No MIME decode.
MIME encode. Header style. All ASCII code and control characters are intact.
MIME encode Base64 stream. Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.
Perform quoted encoding.
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.
unix (LF)
windows (CRLF)
mac (CR)

Without this option, nkf doesn't 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.
a.k.a. RFC1468, 7bit JIS, JUNET
a.k.a. AT&T JIS, Japanese EUC, UJIS
Microsoft Version of EUC-JP.
a.k.a. SJIS, MS_Kanji
a.k.a. CP932
same as UTF-8N
UTF-8 without BOM
UTF-8 with BOM
decomposed UTF-8
same as UTF-16BE
UTF-16 Big Endian without BOM
UTF-16 Big Endian with BOM
UTF-16 Little Endian without BOM
UTF-16 Little Endian with BOM
same as UTF-32BE
UTF-32 Big Endian without BOM
UTF-32 Big Endian with BOM
UTF-32 Little Endian without BOM
UTF-32 Little Endian with BOM
Specify the way that nkf handles unassigned characters. Without this option, --fb-skip is assumed.
When nkf converts to Shift_JIS, nkf adds a specified escape character to specified 2nd byte of Shift_JIS 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 opion.

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.

AUTHOR

Copyright (c) 1987, Fujitsu LTD. (Itaru ICHIKAWA).

Copyright (c) 1996-2018, The nkf Project.

2018-12-15 nkf 2.1.5