* Update Copyright.

[nkf/nkf.git] / NKF.mod / NKF.pm

diff --git a/NKF.mod/NKF.pm b/NKF.mod/NKF.pm
index a0680ff..bce898e 100644 (file)
--- a/NKF.mod/NKF.pm
+++ b/NKF.mod/NKF.pm
@@ -36,7 +36,7 @@ require DynaLoader;
 @EXPORT = qw(
        nkf     nkf_continue    inputcode
 );
-$VERSION = '2.05';
+$VERSION = '2.08';
 
 bootstrap NKF $VERSION;
 
@@ -46,23 +46,46 @@ bootstrap NKF $VERSION;
 
 1;
 __END__
-# Below is the stub of documentation for your module. You better edit it!
+
+#
+# =begin ¤«¤é =begin COMMAND ¤Þ¤Ç¤Ï Perl/NKF ¤Î¥É¥­¥å¥á¥ó¥È
+# =begin COMMAND ¤«¤é =end ¤Þ¤Ç¤Ï nkf ¥³¥Þ¥ó¥É¤Î¥É¥­¥å¥á¥ó¥È
+# 
 
 =head1 NAME
 
-NKF - Perl extension for Network Kanji Filter 
+=begin
+
+NKF - Perl extension for Network Kanji Filter
+
+=begin COMMAND
+
+nkf - Network Kanji Filter
+
+=end
 
 =head1 SYNOPSIS
 
+=begin
+
   use NKF;
   $output = nkf("-s",$input);
 
+=begin COMMAND
+
+nkf B<[-butjnesliohrTVvwWJESZxXFfmMBOcdILg]> B<[>I<file ...>B<]>
+
+=end
+
 =head1 DESCRIPTION
 
+=begin
+
 This is a Perl Extension version of nkf (Netowrk Kanji Filter).
 It converts the last argument and return converted result. Conversion
 details are specified by flags before the last argument.
 
+=end
 
 B<Nkf> is a yet another kanji code converter among networks, hosts and terminals.
 It converts input kanji code to designated kanji code
@@ -77,7 +100,7 @@ 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 B<-X>, B<-x> or B<-S>.
 
-=head1 Flags
+=head1 OPTIONS
 
 =over
 
@@ -120,13 +143,13 @@ Same as -J.
 
 No conversion.
 
-=item B<-i_>
+=item B<-i[@B]>
 
-Output sequence to designate JIS-kanji. (DEFAULT B)
+Specify the Esc Seq for JIS X 0208-1978/83. (DEFAULT B)
 
-=item B<-o_>
+=item B<-o[BJH]>
 
-Output sequence to designate ASCII. (DEFAULT B)
+Specify the Esc Seq for ASCII/Roman. (DEFAULT B)
 
 =item B<-r>
 
@@ -220,10 +243,6 @@ forces ASCII after NL.
 Replacing non iso-2022-jp char into a geta character
 (substitute character in Japanese).
 
-=item B<-d -c>
-
-Delete \r in line feed, Add \r in line feed.
-
 =item B<-m[BQN0]>
 
 MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT)
@@ -273,17 +292,17 @@ Perfome quoted encoding.
 Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP.
 B<-s>, B<-e> and B<-x> are not compatible with this option.
 
-=item B<-L[uwm]>
+=item B<-L[uwm] -d -c>
 
-new line mode
+Convert line breaks.
 
 =over
 
-=item B<-Lu>
+=item B<-Lu -d>
 
 unix (LF)
 
-=item B<-Lw>
+=item B<-Lw -c>
 
 windows (CRLF)
 
@@ -350,6 +369,10 @@ UTF-8 without BOM
 
 UTF-8 with BOM
 
+=item UTF8-MAC (input only)
+
+decomposed UTF-8
+
 =item UTF-16
 
 same as UTF-16BE
@@ -370,8 +393,6 @@ UTF-16 Little Endian without BOM
 
 UTF-16 Little Endian with BOM
 
-=item UTF8-MAC (input only)
-
 =back
 
 =item B<--fb-{skip, html, xml, perl, java, subchar}>
@@ -411,17 +432,27 @@ Unescape percent escaped characters.
 
 Decode character reference, such as "&#....;".
 
-=begin man
+=begin COMMAND
+
+=item B<--in-place[=>I<SUFFIX>B<]>  B<--overwrite[=>I<SUFFIX>B<]>
 
-=item B<--overwrite>
+Overwrite B<original> listed files by filtered result.
 
-Overwrite original file by converted result.
+B<Note> --overwrite preserves timestamp of original files.
 
 =item B<--guess>
 
 Print guessed encoding.
 
-=end man
+=item B<--help>
+
+Print nkf's help.
+
+=item B<--version>
+
+Print nkf's version.
+
+=end
 
 =item B<-->
 
@@ -431,12 +462,15 @@ Ignore rest of -option.
 
 =head1 AUTHOR
 
-Network Kanji Filter Version 2.0.5
+Copyright (C) 1987, FUJITSU LTD. (I.Ichikawa),2000 S. Kono, COW
+Copyright (C) 2002-2007 Kono, Furukawa, Naruse, mastodon
 
-Copyright (C) 1987, FUJITSU LTD. (I.Ichikawa),2000 S. Kono, COW, 2002-2005 Kono, Furukawa, Naruse
+=begin
 
 =head1 SEE ALSO
 
 perl(1).   nkf(1)
 
+=end
+
 =cut