OSDN Git Service

Update document for nkf 2.0.7
[nkf/nkf.git] / nkf.1
diff --git a/nkf.1 b/nkf.1
index 27a210b..7e3c115 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.32
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
-.IX Title "NKF(1)"
-.TH NKF 1 "2006-03-05" "nkf 2.0.6"
+.IX Title "nkf 1"
+.TH nkf 1 "2006-06-13" "nkf 2.0.7" " "
 .SH "NAME"
-NKF \- Network Kanji Filter 
+nkf \- Network Kanji Filter
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\&  nkf B<[-butjnesliohrTVvwWJESZxXFfmMBOcdILg]> B<[>I<file ...>B<]>
+.Ve
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 \&\fBNkf\fR is a yet another kanji code converter among networks, hosts and terminals.
@@ -146,8 +151,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.
@@ -180,12 +185,12 @@ Same as \-J.
 .IP "\fB\-t\fR" 4
 .IX Item "-t"
 No conversion.
-.IP "\fB\-i_\fR" 4
-.IX Item "-i_"
-Output sequence to designate JIS\-kanji. (\s-1DEFAULT\s0 B)
-.IP "\fB\-o_\fR" 4
-.IX Item "-o_"
-Output sequence to designate \s-1ASCII\s0. (\s-1DEFAULT\s0 B)
+.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)
 .IP "\fB\-r\fR" 4
 .IX Item "-r"
 {de/en}crypt \s-1ROT13/47\s0
@@ -262,9 +267,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"
-Delete \er in line feed, Add \er in line feed.
 .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)
@@ -305,15 +307,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"
@@ -419,24 +421,24 @@ Unescape percent escaped characters.
 .IP "\fB\-\-numchar\-input\fR" 4
 .IX Item "--numchar-input"
 Decode character reference, such as \*(L"&#....;\*(R".
-.IP "\fB\-\-overwrite\fR" 4
-.IX Item "--overwrite"
-Overwrite original file by converted result.
-
-.PD 0
+.IP "\fB\-\-in\-place[=\fR\fI\s-1SUFFIX\s0\fR\fB]\fR  \fB\-\-overwrite[=\fR\fI\s-1SUFFIX\s0\fR\fB]\fR" 4
+.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.
-
+.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 "--"
-.PD
 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
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-\&\fInkf\fR\|(1)
+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