Encode::Tcl docs (was Re: UTF-16 and other missing(?) encodings)

Message-Id: <20020310170748.1F29.BQW10602@nifty.com>

p4raw-id: //depot/perl@15143

diff --git a/ext/Encode/lib/Encode/Tcl.pm b/ext/Encode/lib/Encode/Tcl.pm
index 812dcd1..95ed572 100644 (file)
--- a/ext/Encode/lib/Encode/Tcl.pm
+++ b/ext/Encode/lib/Encode/Tcl.pm
@@ -10,13 +10,7 @@ use Encode qw(find_encoding);
 use base 'Encode::Encoding';
 use Carp;
 
-=head1 NAME
-
-Encode::Tcl - Tcl encodings
-
-=cut
-
-    sub INC_search
+sub INC_search
 {
     foreach my $dir (@INC)
     {
@@ -134,3 +128,36 @@ require Encode::Tcl::Extended;
 
 1;
 __END__
+
+=head1 NAME
+
+Encode::Tcl - Tcl encodings
+
+=head1 SYNOPSIS
+
+    use Encode;
+    use Encode::Tcl;
+    $unicode  = decode('shiftjis', $shiftjis);
+    $shiftjis = encode('shiftjis', $unicode);
+
+=head1 DESCRIPTION
+
+This module provides the interface to encodings
+defined by the format of encoding tables borrowed from Tcl
+and not compiled in other Encode:: modules.
+
+See also F<Encode/EncodeFormat.pod> and F<Encode/*.enc> files.
+
+To find how to use this module in detail, see L<Encode>.
+
+=head1 SEE ALSO
+
+L<Encode>
+
+L<Encode::Tcl::Table>
+
+L<Encode::Tcl::Escape>
+
+L<Encode::Tcl::Extended>
+
+=cut

diff --git a/ext/Encode/lib/Encode/Tcl/Escape.pm b/ext/Encode/lib/Encode/Tcl/Escape.pm
index d3f55d7..5697c99 100644 (file)
--- a/ext/Encode/lib/Encode/Tcl/Escape.pm
+++ b/ext/Encode/lib/Encode/Tcl/Escape.pm
@@ -189,3 +189,40 @@ sub encode
 
 1;
 __END__
+
+=head1 NAME
+
+Encode::Tcl::Escape - Tcl Escape encodings
+
+=head1 SYNOPSIS
+
+none
+
+=head1 DESCRIPTION
+
+This module is used internally by Encode::Tcl
+and handles type E of Tcl encodings (7-bit code only).
+
+Control sequences supported by this module are
+ESCAPE SEQUENCEs to designate graphic character sets
+and the following:
+
+    name (abbr.)                   bit combination
+
+  ESCAPE (ESC)                       01/11
+  SHIFT-IN (SI)                      00/15
+  SHIFT-OUT (SO)                     00/14
+  SINGLE SHIFT TWO (SS2)             ESC 04/14
+  SINGLE SHIFT THREE (SS3)           ESC 04/15
+
+Designation of control character sets are not supported.
+
+=head1 SEE ALSO
+
+L<Encode>
+
+L<Encode::Tcl>
+
+L<http://www.itscj.ipsj.or.jp/ISO-IR/> [ISOREG]
+
+=cut

diff --git a/ext/Encode/lib/Encode/Tcl/Extended.pm b/ext/Encode/lib/Encode/Tcl/Extended.pm
index 4b471d8..0fa3035 100644 (file)
--- a/ext/Encode/lib/Encode/Tcl/Extended.pm
+++ b/ext/Encode/lib/Encode/Tcl/Extended.pm
@@ -140,3 +140,31 @@ sub encode
 }
 1;
 __END__
+
+=head1 NAME
+
+Encode::Tcl::Extended - Tcl EUC encodings
+
+=head1 SYNOPSIS
+
+none
+
+=head1 DESCRIPTION
+
+This module is used internally by Encode::Tcl
+and handles type X of Tcl encodings (a Perl extenstion).
+
+Only F<euc-jp-0212.enc> belongs to type X.
+This is a variant of EUC-JP with JIS X 0212 in G3.
+If another Encode:: module would support the above encoding,
+this module should be removed.
+
+=head1 SEE ALSO
+
+L<Encode>
+
+L<Encode::Tcl>
+
+L<Encode::JP>
+
+=cut

diff --git a/ext/Encode/lib/Encode/Tcl/Table.pm b/ext/Encode/lib/Encode/Tcl/Table.pm
index 1efedee..2e9a837 100644 (file)
--- a/ext/Encode/lib/Encode/Tcl/Table.pm
+++ b/ext/Encode/lib/Encode/Tcl/Table.pm
@@ -137,3 +137,27 @@ sub encode
 }
 1;
 __END__
+
+=head1 NAME
+
+Encode::Tcl::Table - Tcl Table encodings
+
+=head1 SYNOPSIS
+
+none
+
+=head1 DESCRIPTION
+
+This module is used internally by Encode::Tcl
+and handles types S, D, and M of Tcl encodings.
+
+Implementation for type M is restricted to encodings
+in which bytes per a character is up to 2.
+
+=head1 SEE ALSO
+
+L<Encode>
+
+L<Encode::Tcl>
+
+=cut