U:RDoc::NormalModule[iI"NKF:ET@0o:RDoc::Markup::Document: @parts[o;;[¦o: RDoc::Markup::Paragraph;[I"2NKF - Ruby extension for Network Kanji Filter;To: RDoc::Markup::BlankLine S:RDoc::Markup::Heading:
leveli: textI"Description;T@o; ;[I"EThis is a Ruby Extension version of nkf (Network Kanji Filter). ;TI"MIt converts the first argument and returns converted result. Conversion ;TI":details are specified by flags as the first argument.;T@o; ;[I"V*Nkf* is a yet another kanji code converter among networks, hosts and terminals. ;TI";It converts input kanji code to designated kanji code ;TI"=such as ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8 or UTF-16.;T@o; ;[I"XOne of the most unique faculty of *nkf* is the guess of the input kanji encodings. ;TI"OIt currently recognizes ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8 and UTF-16. ;TI":So users needn't set the input kanji code explicitly.;T@o; ;[ I":By default, X0201 kana is converted into X0208 kana. ;TI"CFor X0201 kana, SO/SI, SSO and ESC-(-I methods are supported. ;TI"KFor automatic code detection, nkf assumes no X0201 kana in Shift_JIS. ;TI"ITo accept X0201 in Shift_JIS, use -X, -x or -S.;T@S; ; i;
I"
Flags;T@S; ; i;
I"
-b -u;T@o; ;[I"8Output is buffered (DEFAULT), Output is unbuffered.;T@S; ; i;
I"-j -s -e -w -w16 -w32;T@o; ;[I"?Output code is ISO-2022-JP (7bit JIS), Shift_JIS, EUC-JP, ;TI"!UTF-8N, UTF-16BE, UTF-32BE. ;TI"DWithout this option and compile option, ISO-2022-JP is assumed.;T@S; ; i;
I"-J -S -E -W -W16 -W32;T@o; ;[I"7Input assumption is JIS 7 bit, Shift_JIS, EUC-JP, ;TI"UTF-8, UTF-16, UTF-32.;T@S; ; i ;
I"-J;T@o; ;[I"0Assume JIS input. It also accepts EUC-JP. ;TI"?This is the default. This flag does not exclude Shift_JIS.;T@S; ; i ;
I"-S;T@o; ;[I"AAssume Shift_JIS and X0201 kana input. It also accepts JIS. ;TI"AEUC-JP is recognized as X0201 kana. Without -x flag, ;TI"9X0201 kana (halfwidth kana) is converted into X0208.;T@S; ; i ;
I"-E;T@o; ;[I"/Assume EUC-JP input. It also accepts JIS. ;TI"Same as -J.;T@S; ; i;
I"-t;T@o; ;[I"No conversion.;T@S; ; i;
I"-i_;T@o; ;[I"8Output sequence to designate JIS-kanji. (DEFAULT B);T@S; ; i;
I"-o_;T@o; ;[I"4Output sequence to designate ASCII. (DEFAULT B);T@S; ; i;
I"-r;T@o; ;[I"{de/en}crypt ROT13/47;T@S; ; i;
I"6-h[123] --hiragana --katakana --katakana-hiragana;T@o:RDoc::Markup::List:
@type:
LABEL: @items[o:RDoc::Markup::ListItem: @label[I"-h1 --hiragana;T;[o; ;[I"%Katakana to Hiragana conversion.;T@o;;[I"-h2 --katakana;T;[o; ;[I"%Hiragana to Katakana conversion.;T@o;;[I" -h3 --katakana-hiragana;T;[o; ;[I">Katakana to Hiragana and Hiragana to Katakana conversion.;T@S; ; i;
I"-T;T@o; ;[I" Text mode output (MS-DOS);T@S; ; i;
I"-l;T@o; ;[I" ISO8859-1 (Latin-1) support;T@S; ; i;
I"*-f[m [- n]];T@o; ;[I"LFolding on m length with n margin in a line. ;TI"BWithout this option, fold length is 60 and fold margin is 10.;T@S; ; i;
I"-F;T@o; ;[I"&New line preserving line folding.;T@S; ; i;
I" -Z[0-3];T@o; ;[I";Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.;T@o;;;;[ o;;[I" -Z -Z0;T;[o; ;[I"%Convert X0208 alphabet to ASCII.;T@o;;[I"-Z1;T;[o; ;[I"2Converts X0208 kankaku to single ASCII space.;T@o;;[I"-Z2;T;[o; ;[I"3Converts X0208 kankaku to double ASCII spaces.;T@o;;[I"-Z3;T;[o; ;[I"VReplacing Fullwidth >, <, ", & into '>', '<', '"', '&' as in HTML.;T@S; ; i;
I"
-X -x;T@o; ;[ I"$Assume X0201 kana in MS-Kanji. ;TI"PWith -X or without this option, X0201 is converted into X0208 Kana. ;TI"XWith -x, try to preserve X0208 kana and do not convert X0201 kana to X0208. ;TI"@In JIS output, ESC-(-I is used. In EUC output, SSO is used.;T@S; ; i;
I" -B[0-2];T@o; ;[I"4Assume broken JIS-Kanji input, which lost ESC. ;TI"=Useful when your site is using old B-News Nihongo patch.;T@o;;;;[o;;[I"-B1;T;[o; ;[I"*allows any char after ESC-( or ESC-$.;T@o;;[I"-B2;T;[o; ;[I"forces ASCII after NL.;T@S; ; i;
I"-I;T@o; ;[I":Replacing non iso-2022-jp char into a geta character ;TI"((substitute character in Japanese).;T@S; ; i;
I"
-d -c;T@o; ;[I"1Delete \r in line feed, Add \r in line feed.;T@S; ; i;
I"
-m[BQN0];T@o; ;[I"2MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT) ;TI"0To see ISO8859-1 (Latin-1) -l is necessary.;T@o;;;;[o;;[I"-mB;T;[o; ;[I"JDecode MIME base64 encoded stream. Remove header or other part before;To; ;[I"conversion.;T@o;;;;[o;;[I"-mQ;T;[o; ;[I"KDecode MIME quoted stream. '_' in quoted stream is converted to space.;T@o;;[I"-mN;T;[o; ;[I"Non-strict decoding.;To; ;[I"?It allows line break in the middle of the base64 encoding.;T@o;;;;[o;;[I"-m0;T;[o; ;[I"No MIME decode.;T@S; ; i;
I"-M;T@o; ;[I"RMIME encode. Header style. All ASCII code and control characters are intact. ;TI"`Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.;T@o;;;;[o;;[I"-MB;T;[o; ;[I" MIME encode Base64 stream.;T@o;;[I"-MQ;T;[o; ;[I" Perfome quoted encoding.;T@S; ; i;
I"-l;T@o; ;[I"CInput and output code is ISO8859-1 (Latin-1) and ISO-2022-JP. ;TI"L-s, -e and -x are not compatible with this option.;T@S; ; i;
I" -L[uwm];T@o; ;[I"new line mode ;TI":Without this option, nkf doesn't convert line breaks.;T@o;;;;[o;;[I"-Lu;T;[o; ;[I"unix (LF);T@o;;[I"-Lw;T;[o; ;[I"windows (CRLF);T@o;;[I"-Lm;T;[o; ;[I"
mac (CR);T@S; ; i;
I"(--fj --unix --mac --msdos --windows;T@o; ;[I" convert for these system;T@S; ; i;
I"'--jis --euc --sjis --mime --base64;T@o; ;[I"convert for named code;T@S; ; i;
I"E--jis-input --euc-input --sjis-input --mime-input --base64-input;T@o; ;[I"assume input system;T@S; ; i;
I"E--ic=input codeset --oc=output codeset;T@o; ;[I"&Set the input or output codeset. ;TI"QNKF supports following codesets and those codeset name are case insensitive.;T@o;;;;[o;;[I"ISO-2022-JP;T;[o; ;[I"$a.k.a. RFC1468, 7bit JIS, JUNET;T@o;;[I"EUC-JP (eucJP-nkf);T;[o; ;[I"(a.k.a. AT&T JIS, Japanese EUC, UJIS;T@o;;[I"eucJP-ascii;T;[o; ;[I"'a.k.a. x-eucjp-open-19970715-ascii;T@o;;[I"
eucJP-ms;T;[o; ;[I"$a.k.a. x-eucjp-open-19970715-ms;T@o;;[I" CP51932;T;[o; ;[I"!Microsoft Version of EUC-JP.;T@o;;[I"Shift_JIS;T;[o; ;[I"SJIS, MS-Kanji;T@o;;[I"Windows-31J;T;[o; ;[I"a.k.a. CP932;T@o;;[I"
UTF-8;T;[o; ;[I"same as UTF-8N;T@o;;[I" UTF-8N;T;[o; ;[I"UTF-8 without BOM;T@o;;[I"UTF-8-BOM;T;[o; ;[I"UTF-8 with BOM;T@o;;[I" UTF-16;T;[o; ;[I"same as UTF-16BE;T@o;;[I"
UTF-16BE;T;[o; ;[I""UTF-16 Big Endian without BOM;T@o;;[I"UTF-16BE-BOM;T;[o; ;[I" UTF-16 Big Endian with BOM;T@o;;[I"
UTF-16LE;T;[o; ;[I"%UTF-16 Little Endian without BOM;T@o;;[I"UTF-16LE-BOM;T;[o; ;[I""UTF-16 Little Endian with BOM;T@o;;[I" UTF-32;T;[o; ;[I"same as UTF-32BE;T@o;;[I"
UTF-32BE;T;[o; ;[I""UTF-32 Big Endian without BOM;T@o;;[I"UTF-32BE-BOM;T;[o; ;[I" UTF-32 Big Endian with BOM;T@o;;[I"
UTF-32LE;T;[o; ;[I"%UTF-32 Little Endian without BOM;T@o;;[I"UTF-32LE-BOM;T;[o; ;[I""UTF-32 Little Endian with BOM;T@o;;[I"
UTF8-MAC;T;[o; ;[I".NKDed UTF-8, a.k.a. UTF8-NFD (input only);T@S; ; i;
I"0--fb-{skip, html, xml, perl, java, subchar};T@o; ;[I"=Specify the way that nkf handles unassigned characters. ;TI"/Without this option, --fb-skip is assumed.;T@S; ; i;
I"M--prefix= escape character target character ..;T@o; ;[I"%When nkf converts to Shift_JIS, ;TI"Znkf adds a specified escape character to specified 2nd byte of Shift_JIS characters. ;TI"\1st byte of argument is the escape character and following bytes are target characters.;T@S; ; i;
I"--no-cp932ext;T@o; ;[I"FHandle the characters extended in CP932 as unassigned characters.;T@S; ; i;
I"--no-best-fit-chars;T@o; ;[
I".When Unicode to Encoded byte conversion, ;TI"