Change default compile option to -g -O2.

[nkf/nkf.git] / nkf.1

diff --git a/nkf.1 b/nkf.1
index a8f5faa..e5b4a86 100644 (file)
--- a/nkf.1
+++ b/nkf.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35

 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .\"
 .\" Standard preamble:
 .\" ========================================================================


@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "nkf 1"
 .\" ========================================================================
 .\"
 .IX Title "nkf 1"

-.TH nkf 1 "2006-08-22" "nkf 2.0.8" " "
+.TH nkf 1 "2009-01-20" "nkf 2.0.9" " "

 .SH "NAME"
 nkf \- Network Kanji Filter
 .SH "SYNOPSIS"
 .SH "NAME"
 nkf \- Network Kanji Filter
 .SH "SYNOPSIS"


@@ -139,10 +139,10 @@ nkf \fB[\-butjnesliohrTVvwWJESZxXFfmMBOcdILg]\fR \fB[\fR\fIfile ...\fR\fB]\fR
 .IX Header "DESCRIPTION"
 \&\fBNkf\fR is a yet another kanji code converter among networks, hosts and terminals.
 It converts input kanji code to designated kanji code
 .IX Header "DESCRIPTION"
 \&\fBNkf\fR is a yet another kanji code converter among networks, hosts and terminals.
 It converts input kanji code to designated kanji code

-such as \s-1ISO\-2022\-JP\s0, Shift_JIS, \s-1EUC\-JP\s0, \s-1UTF\-8\s0 or \s-1UTF\-16\s0.
+such as \s-1ISO\-2022\-JP\s0, Shift_JIS, \s-1EUC\-JP\s0, \s-1UTF\-8\s0, \s-1UTF\-16\s0 or \s-1UTF\-32\s0.

 .PP
 One of the most unique faculty of \fBnkf\fR is the guess of the input kanji encodings.
 .PP
 One of the most unique faculty of \fBnkf\fR is the guess of the input kanji encodings.

-It currently recognizes \s-1ISO\-2022\-JP\s0, Shift_JIS, \s-1EUC\-JP\s0, \s-1UTF\-8\s0 and \s-1UTF\-16\s0.
+It currently recognizes \s-1ISO\-2022\-JP\s0, Shift_JIS, \s-1EUC\-JP\s0, \s-1UTF\-8\s0, \s-1UTF\-16\s0 and \s-1UTF\-32\s0.

 So users needn't set the input kanji code explicitly.
 .PP
 By default, X0201 kana is converted into X0208 kana.
 So users needn't set the input kanji code explicitly.
 .PP
 By default, X0201 kana is converted into X0208 kana.


@@ -151,44 +151,61 @@ For automatic code detection, nkf assumes no X0201 kana in Shift_JIS.
 To accept X0201 in Shift_JIS, use \fB\-X\fR, \fB\-x\fR or \fB\-S\fR.
 .SH "OPTIONS"
 .IX Header "OPTIONS"
 To accept X0201 in Shift_JIS, use \fB\-X\fR, \fB\-x\fR or \fB\-S\fR.
 .SH "OPTIONS"
 .IX Header "OPTIONS"

-.IP "\fB\-b \-u\fR" 4
-.IX Item "-b -u"
-Output is buffered (\s-1DEFAULT\s0), Output is unbuffered.
-.IP "\fB\-j \-s \-e \-w \-w16\fR" 4
-.IX Item "-j -s -e -w -w16"
-Output code is \s-1ISO\-2022\-JP\s0 (7bit \s-1JIS\s0), Shift_JIS, \s-1EUC\-JP\s0,
-\&\s-1UTF\-8N\s0, \s-1UTF\-16BE\s0.
-Without this option and compile option, \s-1ISO\-2022\-JP\s0 is assumed.
-.IP "\fB\-J \-S \-E \-W \-W16\fR" 4
-.IX Item "-J -S -E -W -W16"
-Input assumption is \s-1JIS\s0 7 bit, Shift_JIS, \s-1EUC\-JP\s0,
-\&\s-1UTF\-8\s0, \s-1UTF\-16LE\s0.
+.IP "\fB\-J \-S \-E \-W \-W16 \-W32 \-j \-s \-e \-w \-w16 \-w32\fR" 4
+.IX Item "-J -S -E -W -W16 -W32 -j -s -e -w -w16 -w32"
+Specify input and output encodings. Upper case is input.
+cf. \-\-ic and \-\-oc.

 .RS 4
 .IP "\fB\-J\fR" 4
 .IX Item "-J"
 .RS 4
 .IP "\fB\-J\fR" 4
 .IX Item "-J"

-Assume  \s-1JIS\s0 input. It also accepts \s-1EUC\-JP\s0.
-This is the default. This flag does not exclude Shift_JIS.
+\&\s-1ISO\-2022\-JP\s0 (\s-1JIS\s0 code).

 .IP "\fB\-S\fR" 4
 .IX Item "-S"
 .IP "\fB\-S\fR" 4
 .IX Item "-S"

-Assume Shift_JIS and X0201 kana input. It also accepts \s-1JIS\s0.
+Shift_JIS and \s-1JIS\s0 X 0201 kana.

 EUC-JP is recognized as X0201 kana. Without \fB\-x\fR flag,
 EUC-JP is recognized as X0201 kana. Without \fB\-x\fR flag,

-X0201 kana (halfwidth kana) is converted into X0208.
+\&\s-1JIS\s0 X 0201 Katakana (a.k.a.halfwidth kana) is converted into \s-1JIS\s0 X 0208.
+If you use Windows, see Windows\-31J (\s-1CP932\s0).

 .IP "\fB\-E\fR" 4
 .IX Item "-E"
 .IP "\fB\-E\fR" 4
 .IX Item "-E"

-Assume EUC-JP input. It also accepts \s-1JIS\s0.
-Same as \-J.
+\&\s-1EUC\-JP\s0.
+.IP "\fB\-W\fR" 4
+.IX Item "-W"
+\&\s-1UTF\-8N\s0.
+.IP "\fB\-W16[\s-1BL\s0][0]\fR" 4
+.IX Item "-W16[BL][0]"
+\&\s-1UTF\-16\s0.
+B or L gives whether Big Endian or Little Endian.
+0 gives whther put \s-1BOM\s0 or not.
+.IP "\fB\-W32[\s-1BL\s0][0]\fR" 4
+.IX Item "-W32[BL][0]"
+\&\s-1UTF\-32\s0.
+B or L gives whether Big Endian or Little Endian.
+0 gives whther put \s-1BOM\s0 or not.

 .RE
 .RS 4
 .RE
 .RE
 .RS 4
 .RE

+.IP "\fB\-b \-u\fR" 4
+.IX Item "-b -u"
+Output is buffered (\s-1DEFAULT\s0), Output is unbuffered.

 .IP "\fB\-t\fR" 4
 .IX Item "-t"
 No conversion.
 .IP "\fB\-i[@B]\fR" 4
 .IX Item "-i[@B]"
 .IP "\fB\-t\fR" 4
 .IX Item "-t"
 No conversion.
 .IP "\fB\-i[@B]\fR" 4
 .IX Item "-i[@B]"

-Specify the Esc Seq for \s-1JIS\s0 X 0208\-1978/83. (\s-1DEFAULT\s0 B)
-.IP "\fB\-o[\s-1BJH\s0]\fR" 4
-.IX Item "-o[BJH]"
-Specify the Esc Seq for ASCII/Roman. (\s-1DEFAULT\s0 B)
+Specify the escape sequence for \s-1JIS\s0 X 0208.
+.RS 4
+.IP "\fB\-i@\fR" 4
+.IX Item "-i@"
+Use \s-1ESC\s0 ( @. (\s-1JIS\s0 X 0208\-1978)
+.IP "\fB\-iB\fR" 4
+.IX Item "-iB"
+Use \s-1ESC\s0 ( B. (\s-1JIS\s0 X 0208\-1983/1990 \s-1DEFAULT\s0)
+.RE
+.RS 4
+.RE
+.IP "\fB\-o[\s-1BJ\s0]\fR" 4
+.IX Item "-o[BJ]"
+Specify the escape sequence for \s-1US\-ASCII/JIS\s0 X 0201 Roman. (\s-1DEFAULT\s0 B)

 .IP "\fB\-r\fR" 4
 .IX Item "-r"
 {de/en}crypt \s-1ROT13/47\s0
 .IP "\fB\-r\fR" 4
 .IX Item "-r"
 {de/en}crypt \s-1ROT13/47\s0


@@ -231,13 +248,13 @@ Convert X0208 alphabet (Fullwidth Alphabets) to \s-1ASCII\s0.
 Convert X0208 alphabet to \s-1ASCII\s0.
 .IP "\fB\-Z1\fR" 4
 .IX Item "-Z1"
 Convert X0208 alphabet to \s-1ASCII\s0.
 .IP "\fB\-Z1\fR" 4
 .IX Item "-Z1"

-Converts X0208 kankaku to single \s-1ASCII\s0 space.
+Convert X0208 kankaku to single \s-1ASCII\s0 space.

 .IP "\fB\-Z2\fR" 4
 .IX Item "-Z2"
 .IP "\fB\-Z2\fR" 4
 .IX Item "-Z2"

-Converts X0208 kankaku to double \s-1ASCII\s0 spaces.
+Convert X0208 kankaku to double \s-1ASCII\s0 spaces.

 .IP "\fB\-Z3\fR" 4
 .IX Item "-Z3"
 .IP "\fB\-Z3\fR" 4
 .IX Item "-Z3"

-Replacing Fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as in \s-1HTML\s0.
+Replacing fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as in \s-1HTML\s0.

 .RE
 .RS 4
 .RE
 .RE
 .RS 4
 .RE


@@ -254,10 +271,10 @@ Useful when your site is using old B\-News Nihongo patch.
 .RS 4
 .IP "\fB\-B1\fR" 4
 .IX Item "-B1"
 .RS 4
 .IP "\fB\-B1\fR" 4
 .IX Item "-B1"

-allows any char after \s-1ESC\-\s0( or \s-1ESC\-$\s0.
+allows any chars after \s-1ESC\-\s0( or \s-1ESC\-$\s0.

 .IP "\fB\-B2\fR" 4
 .IX Item "-B2"
 .IP "\fB\-B2\fR" 4
 .IX Item "-B2"

-forces \s-1ASCII\s0 after \s-1NL\s0.
+force \s-1ASCII\s0 after \s-1NL\s0.

 .RE
 .RS 4
 .RE
 .RE
 .RS 4
 .RE


@@ -297,7 +314,7 @@ No \s-1MIME\s0 decode.
 Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.
 .IP "\fB\-MQ\fR" 4
 .IX Item "-MQ"
 Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.
 .IP "\fB\-MQ\fR" 4
 .IX Item "-MQ"

-Perfome quoted encoding.
+Perform quoted encoding.

 .RE
 .RS 4
 .RE
 .RE
 .RS 4
 .RE


@@ -325,17 +342,17 @@ Without this option, nkf doesn't convert line breaks.
 .RE
 .IP "\fB\-\-fj \-\-unix \-\-mac \-\-msdos \-\-windows\fR" 4
 .IX Item "--fj --unix --mac --msdos --windows"
 .RE
 .IP "\fB\-\-fj \-\-unix \-\-mac \-\-msdos \-\-windows\fR" 4
 .IX Item "--fj --unix --mac --msdos --windows"

-convert for these system
+Convert for these systems.

 .IP "\fB\-\-jis \-\-euc \-\-sjis \-\-mime \-\-base64\fR" 4
 .IX Item "--jis --euc --sjis --mime --base64"
 .IP "\fB\-\-jis \-\-euc \-\-sjis \-\-mime \-\-base64\fR" 4
 .IX Item "--jis --euc --sjis --mime --base64"

-convert for named code
+Convert to named code.

 .IP "\fB\-\-jis\-input \-\-euc\-input \-\-sjis\-input \-\-mime\-input \-\-base64\-input\fR" 4
 .IX Item "--jis-input --euc-input --sjis-input --mime-input --base64-input"
 .IP "\fB\-\-jis\-input \-\-euc\-input \-\-sjis\-input \-\-mime\-input \-\-base64\-input\fR" 4
 .IX Item "--jis-input --euc-input --sjis-input --mime-input --base64-input"

-assume input system
+Assume input system

 .IP "\fB\-\-ic=\f(BIinput codeset\fB \-\-oc=\f(BIoutput codeset\fB\fR" 4
 .IX Item "--ic=input codeset --oc=output codeset"
 Set the input or output codeset.
 .IP "\fB\-\-ic=\f(BIinput codeset\fB \-\-oc=\f(BIoutput codeset\fB\fR" 4
 .IX Item "--ic=input codeset --oc=output codeset"
 Set the input or output codeset.

-\&\s-1NKF\s0 supports following codesets and those codeset name are case insensitive.
+\&\s-1NKF\s0 supports following codesets and those codeset names are case insensitive.

 .RS 4
 .IP "\s-1ISO\-2022\-JP\s0" 4
 .IX Item "ISO-2022-JP"
 .RS 4
 .IP "\s-1ISO\-2022\-JP\s0" 4
 .IX Item "ISO-2022-JP"


@@ -355,9 +372,9 @@ Microsoft Version of \s-1EUC\-JP\s0.
 .IP "Shift_JIS" 4
 .IX Item "Shift_JIS"
 a.k.a. \s-1SJIS\s0, MS-Kanji
 .IP "Shift_JIS" 4
 .IX Item "Shift_JIS"
 a.k.a. \s-1SJIS\s0, MS-Kanji

-.IP "\s-1CP932\s0" 4
-.IX Item "CP932"
-a.k.a. Windows\-31J
+.IP "Windows\-31J" 4
+.IX Item "Windows-31J"
+a.k.a. \s-1CP932\s0

 .IP "\s-1UTF\-8\s0" 4
 .IX Item "UTF-8"
 same as \s-1UTF\-8N\s0
 .IP "\s-1UTF\-8\s0" 4
 .IX Item "UTF-8"
 same as \s-1UTF\-8N\s0


@@ -385,6 +402,21 @@ same as \s-1UTF\-16BE\s0
 .IP "\s-1UTF\-16LE\-BOM\s0" 4
 .IX Item "UTF-16LE-BOM"
 \&\s-1UTF\-16\s0 Little Endian with \s-1BOM\s0
 .IP "\s-1UTF\-16LE\-BOM\s0" 4
 .IX Item "UTF-16LE-BOM"
 \&\s-1UTF\-16\s0 Little Endian with \s-1BOM\s0

+.IP "\s-1UTF\-32\s0" 4
+.IX Item "UTF-32"
+same as \s-1UTF\-32BE\s0
+.IP "\s-1UTF\-32BE\s0" 4
+.IX Item "UTF-32BE"
+\&\s-1UTF\-32\s0 Big Endian without \s-1BOM\s0
+.IP "\s-1UTF\-32BE\-BOM\s0" 4
+.IX Item "UTF-32BE-BOM"
+\&\s-1UTF\-32\s0 Big Endian with \s-1BOM\s0
+.IP "\s-1UTF\-32LE\s0" 4
+.IX Item "UTF-32LE"
+\&\s-1UTF\-32\s0 Little Endian without \s-1BOM\s0
+.IP "\s-1UTF\-32LE\-BOM\s0" 4
+.IX Item "UTF-32LE-BOM"
+\&\s-1UTF\-32\s0 Little Endian with \s-1BOM\s0

 .RE
 .RS 4
 .RE
 .RE
 .RS 4
 .RE


@@ -408,7 +440,7 @@ When Unicode to Unicode conversion,
 with this and \-x option, nkf can be used as \s-1UTF\s0 converter.
 (In other words, without this and \-x option, nkf doesn't save some characters)
 .Sp
 with this and \-x option, nkf can be used as \s-1UTF\s0 converter.
 (In other words, without this and \-x option, nkf doesn't save some characters)
 .Sp

-When nkf convert string which related to path, you should use this opion.
+When nkf converts strings that related to path, you should use this opion.

 .IP "\fB\-\-cap\-input\fR" 4
 .IX Item "--cap-input"
 Decode hex encoded characters.
 .IP "\fB\-\-cap\-input\fR" 4
 .IX Item "--cap-input"
 Decode hex encoded characters.


@@ -422,10 +454,10 @@ Decode character reference, such as \*(L"&#....;\*(R".
 .IX Item "--in-place[=SUFFIX]  --overwrite[=SUFFIX]"
 Overwrite \fBoriginal\fR listed files by filtered result.
 .Sp
 .IX Item "--in-place[=SUFFIX]  --overwrite[=SUFFIX]"
 Overwrite \fBoriginal\fR listed files by filtered result.
 .Sp

-\&\fBNote\fR \-\-overwrite preserves timestamp of original files.
-.IP "\fB\-\-guess\fR" 4
-.IX Item "--guess"
-Print guessed encoding.
+\&\fBNote\fR \-\-overwrite preserves timestamps of original files.
+.IP "\fB\-\-guess=[12]\fR" 4
+.IX Item "--guess=[12]"
+Print guessed encoding and newline. (2 is default, 1 is only encoding)

 .IP "\fB\-\-help\fR" 4
 .IX Item "--help"
 Print nkf's help.
 .IP "\fB\-\-help\fR" 4
 .IX Item "--help"
 Print nkf's help.


@@ -437,5 +469,6 @@ Print nkf's version.
 Ignore rest of \-option.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Ignore rest of \-option.
 .SH "AUTHOR"
 .IX Header "AUTHOR"

-Copyright (C) 1987, \s-1FUJITSU\s0 \s-1LTD\s0. (I.Ichikawa),2000 S. Kono, \s-1COW\s0
-Copyright (C) 2002\-2006 Kono, Furukawa, Naruse, mastodon
+Copyright (c) 1987, Fujitsu \s-1LTD\s0. (Itaru \s-1ICHIKAWA\s0).
+.PP
+Copyright (c) 1996\-2009, The nkf Project.