OSDN Git Service

* update documents.
[nkf/nkf.git] / nkf.1
diff --git a/nkf.1 b/nkf.1
index 4da8410..5b1dd21 100644 (file)
--- a/nkf.1
+++ b/nkf.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .\" ========================================================================
 .\"
 .IX Title "nkf 1"
-.TH nkf 1 "2006-03-15" "nkf 2.0.6" " "
+.TH nkf 1 "2008-11-10" "nkf 2.0.8" " "
 .SH "NAME"
 nkf \- Network Kanji Filter
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-nkf \fB\-[\fR\fIflags\fR\fB]\fR \fB[\fR\fIin_file\fR\fB]\fR .. \fB[\fR\fIout_file_for_\-O_flag\fR\fB]\fR
+nkf \fB[\-butjnesliohrTVvwWJESZxXFfmMBOcdILg]\fR \fB[\fR\fIfile ...\fR\fB]\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 \&\fBNkf\fR is a yet another kanji code converter among networks, hosts and terminals.
@@ -149,8 +149,8 @@ By default, X0201 kana is converted into X0208 kana.
 For X0201 kana, \s-1SO/SI\s0, \s-1SSO\s0 and \s-1ESC\-\s0(\-I methods are supported.
 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 "Flags"
-.IX Header "Flags"
+.SH "OPTIONS"
+.IX Header "OPTIONS"
 .IP "\fB\-b \-u\fR" 4
 .IX Item "-b -u"
 Output is buffered (\s-1DEFAULT\s0), Output is unbuffered.
@@ -166,17 +166,16 @@ Input assumption is \s-1JIS\s0 7 bit, Shift_JIS, \s-1EUC\-JP\s0,
 .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.
+Assume  \s-1JIS\s0 input.
+This is the default.
 .IP "\fB\-S\fR" 4
 .IX Item "-S"
-Assume Shift_JIS and X0201 kana input. It also accepts \s-1JIS\s0.
+Assume Shift_JIS and X0201 kana input.
 EUC-JP is recognized as X0201 kana. Without \fB\-x\fR flag,
 X0201 kana (halfwidth kana) is converted into X0208.
 .IP "\fB\-E\fR" 4
 .IX Item "-E"
-Assume EUC-JP input. It also accepts \s-1JIS\s0.
-Same as \-J.
+Assume EUC-JP input.
 .RE
 .RS 4
 .RE
@@ -231,13 +230,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"
-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"
-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"
-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
@@ -254,10 +253,10 @@ Useful when your site is using old B\-News Nihongo patch.
 .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"
-forces \s-1ASCII\s0 after \s-1NL\s0.
+force \s-1ASCII\s0 after \s-1NL\s0.
 .RE
 .RS 4
 .RE
@@ -265,9 +264,6 @@ forces \s-1ASCII\s0 after \s-1NL\s0.
 .IX Item "-I"
 Replacing non iso\-2022\-jp char into a geta character
 (substitute character in Japanese).
-.IP "\fB\-d \-c\fR" 4
-.IX Item "-d -c"
-Convert line breaks  \-d: \s-1LF\s0  \-c: \s-1CRLF\s0.
 .IP "\fB\-m[\s-1BQN0\s0]\fR" 4
 .IX Item "-m[BQN0]"
 \&\s-1MIME\s0 \s-1ISO\-2022\-JP/ISO8859\-1\s0 decode. (\s-1DEFAULT\s0)
@@ -300,7 +296,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"
-Perfome quoted encoding.
+Perform quoted encoding.
 .RE
 .RS 4
 .RE
@@ -308,15 +304,15 @@ Perfome quoted encoding.
 .IX Item "-l"
 Input and output code is \s-1ISO8859\-1\s0 (Latin\-1) and \s-1ISO\-2022\-JP\s0.
 \&\fB\-s\fR, \fB\-e\fR and \fB\-x\fR are not compatible with this option.
-.IP "\fB\-L[uwm]\fR" 4
-.IX Item "-L[uwm]"
-new line mode
+.IP "\fB\-L[uwm] \-d \-c\fR" 4
+.IX Item "-L[uwm] -d -c"
+Convert line breaks.
 .RS 4
-.IP "\fB\-Lu\fR" 4
-.IX Item "-Lu"
+.IP "\fB\-Lu \-d\fR" 4
+.IX Item "-Lu -d"
 unix (\s-1LF\s0)
-.IP "\fB\-Lw\fR" 4
-.IX Item "-Lw"
+.IP "\fB\-Lw \-c\fR" 4
+.IX Item "-Lw -c"
 windows (\s-1CRLF\s0)
 .IP "\fB\-Lm\fR" 4
 .IX Item "-Lm"
@@ -328,17 +324,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"
-convert for these system
+Convert for these systems.
 .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"
-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.
-\&\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"
@@ -358,9 +354,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 "\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
@@ -370,6 +366,9 @@ same as \s-1UTF\-8N\s0
 .IP "\s-1UTF\-8\-BOM\s0" 4
 .IX Item "UTF-8-BOM"
 \&\s-1UTF\-8\s0 with \s-1BOM\s0
+.IP "\s-1UTF8\-MAC\s0 (input only)" 4
+.IX Item "UTF8-MAC (input only)"
+decomposed \s-1UTF\-8\s0
 .IP "\s-1UTF\-16\s0" 4
 .IX Item "UTF-16"
 same as \s-1UTF\-16BE\s0
@@ -385,15 +384,11 @@ 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-1UTF8\-MAC\s0 (input only)" 4
-.IX Item "UTF8-MAC (input only)"
 .RE
 .RS 4
 .RE
-.PD 0
 .IP "\fB\-\-fb\-{skip, html, xml, perl, java, subchar}\fR" 4
 .IX Item "--fb-{skip, html, xml, perl, java, subchar}"
-.PD
 Specify the way that nkf handles unassigned characters.
 Without this option, \-\-fb\-skip is assumed.
 .IP "\fB\-\-prefix=\f(BIescape character\fB\f(BItarget character\fB..\fR" 4
@@ -412,7 +407,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
-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.
@@ -426,16 +421,20 @@ Decode character reference, such as \*(L"&#....;\*(R".
 .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\-\-version\fR" 4
+.IX Item "--version"
+Print nkf's version.
 .IP "\fB\-\-\fR" 4
 .IX Item "--"
 Ignore rest of \-option.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
-Network Kanji Filter Version 2.0.6
-.PP
 Copyright (C) 1987, \s-1FUJITSU\s0 \s-1LTD\s0. (I.Ichikawa),2000 S. Kono, \s-1COW\s0
-                     2002\-2006 Kono, Furukawa, Naruse, mastodon
+Copyright (C) 2002\-2007 Kono, Furukawa, Naruse, mastodon