OSDN Git Service

e43807d62072a251e2d764bd4902a75ac72611d9
[nkf/nkf.git] / NKF.mod / NKF.pm
1 # Copyright (c) 1987, Fujitsu LTD. (Itaru ICHIKAWA).
2 # Copyright (c) 1996-2010, The nkf Project.
3 # All rights reserved.
4 #
5 # This software is provided 'as-is', without any express or implied
6 # warranty. In no event will the authors be held liable for any damages
7 # arising from the use of this software.
8 #
9 # Permission is granted to anyone to use this software for any purpose,
10 # including commercial applications, and to alter it and redistribute it
11 # freely, subject to the following restrictions:
12 #
13 # 1. The origin of this software must not be misrepresented; you must not
14 # claim that you wrote the original software. If you use this software
15 # in a product, an acknowledgment in the product documentation would be
16 # appreciated but is not required.
17 #
18 # 2. Altered source versions must be plainly marked as such, and must not be
19 # misrepresented as being the original software.
20 #
21 # 3. This notice may not be removed or altered from any source distribution.
22
23 package NKF;
24
25 use strict;
26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
27
28 require Exporter;
29 require DynaLoader;
30
31 @ISA = qw(Exporter DynaLoader);
32 # Items to export into callers namespace by default. Note: do not export
33 # names by default without a very good reason. Use EXPORT_OK instead.
34 # Do not simply export all your public functions/methods/constants.
35 @EXPORT = qw(
36         nkf     nkf_continue    inputcode
37 );
38 $VERSION = '2.11';
39
40 bootstrap NKF $VERSION;
41
42 # Preloaded methods go here.
43
44 # Autoload methods go after =cut, and are processed by the autosplit program.
45
46 1;
47 __END__
48
49 #
50 # =begin ¤«¤é =begin COMMAND ¤Þ¤Ç¤Ï Perl/NKF ¤Î¥É¥­¥å¥á¥ó¥È
51 # =begin COMMAND ¤«¤é =end ¤Þ¤Ç¤Ï nkf ¥³¥Þ¥ó¥É¤Î¥É¥­¥å¥á¥ó¥È
52
53
54 =head1 NAME
55
56 =begin
57
58 NKF - Perl extension for Network Kanji Filter
59
60 =begin COMMAND
61
62 nkf - Network Kanji Filter
63
64 =end
65
66 =head1 SYNOPSIS
67
68 =begin
69
70   use NKF;
71   $output = nkf("-s",$input);
72
73 =begin COMMAND
74
75 nkf B<[-butjnesliohrTVvwWJESZxXFfmMBOcdILg]> B<[>I<file ...>B<]>
76
77 =end
78
79 =head1 DESCRIPTION
80
81 =begin
82
83 This is a Perl Extension version of nkf (Network Kanji Filter).
84 It converts the last argument and return converted result. Conversion
85 details are specified by flags before the last argument.
86
87 =end
88
89 B<Nkf> is a yet another kanji code converter among networks, hosts and terminals.
90 It converts input kanji code to designated kanji code
91 such as ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8, UTF-16 or UTF-32.
92
93 One of the most unique faculty of B<nkf> is the guess of the input kanji encodings.
94 It currently recognizes ISO-2022-JP, Shift_JIS, EUC-JP, UTF-8, UTF-16 and UTF-32.
95 So users needn't set the input kanji code explicitly.
96
97 By default, X0201 kana is converted into X0208 kana.
98 For X0201 kana, SO/SI, SSO and ESC-(-I methods are supported.
99 For automatic code detection, nkf assumes no X0201 kana in Shift_JIS.
100 To accept X0201 in Shift_JIS, use B<-X>, B<-x> or B<-S>.
101
102 =head1 OPTIONS
103
104 =over
105
106 =item B<-J -S -E -W -W16 -W32 -j -s -e -w -w16 -w32>
107
108 Specify input and output encodings. Upper case is input.
109 cf. --ic and --oc.
110
111 =over
112
113 =item B<-J>
114
115 ISO-2022-JP (JIS code).
116
117 =item B<-S>
118
119 Shift_JIS and JIS X 0201 kana.
120 EUC-JP is recognized as X0201 kana. Without B<-x> flag,
121 JIS X 0201 Katakana (a.k.a.halfwidth kana) is converted into JIS X 0208.
122 If you use Windows, see Windows-31J (CP932).
123
124 =item B<-E>
125
126 EUC-JP.
127
128 =item B<-W>
129
130 UTF-8N.
131
132 =item B<-W16[BL][0]>
133
134 UTF-16.
135 B or L gives whether Big Endian or Little Endian.
136 0 gives whther put BOM or not.
137
138 =item B<-W32[BL][0]>
139
140 UTF-32.
141 B or L gives whether Big Endian or Little Endian.
142 0 gives whther put BOM or not.
143
144 =back
145
146 =item B<-b -u>
147
148 Output is buffered (DEFAULT), Output is unbuffered.
149
150 =item B<-t>
151
152 No conversion.
153
154 =item B<-i[@B]>
155
156 Specify the escape sequence for JIS X 0208.
157
158 =over
159
160 =item B<-i@>
161
162 Use ESC ( @. (JIS X 0208-1978)
163
164 =item B<-iB>
165
166 Use ESC ( B. (JIS X 0208-1983/1990 DEFAULT)
167
168 =back
169
170 =item B<-o[BJ]>
171
172 Specify the escape sequence for US-ASCII/JIS X 0201 Roman. (DEFAULT B)
173
174 =item B<-r>
175
176 {de/en}crypt ROT13/47
177
178 =item B<-h[123] --hiragana --katakana --katakana-hiragana>
179
180 =over
181
182 =item B<-h1 --hiragana>
183
184 Katakana to Hiragana conversion.
185
186 =item B<-h2 --katakana>
187
188 Hiragana to Katakana conversion.
189
190 =item B<-h3 --katakana-hiragana>
191
192 Katakana to Hiragana and Hiragana to Katakana conversion.
193
194 =back
195
196 =item B<-T>
197
198 Text mode output (MS-DOS)
199
200 =item B<-l>
201
202 ISO8859-1 (Latin-1) support
203
204 =item B<-f[I<m> [- I<n>]]>
205
206 Folding on I<m> length with I<n> margin in a line.
207 Without this option, fold length is 60 and fold margin is 10.
208
209 =item B<-F>
210
211 New line preserving line folding.
212
213 =item B<-Z[0-3]>
214
215 Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.
216
217 =over
218
219 =item B<-Z -Z0>
220
221 Convert X0208 alphabet to ASCII.
222
223 =item B<-Z1>
224
225 Convert X0208 kankaku to single ASCII space.
226
227 =item B<-Z2>
228
229 Convert X0208 kankaku to double ASCII spaces.
230
231 =item B<-Z3>
232
233 Replacing fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as in HTML.
234
235 =back
236
237 =item B<-X -x>
238
239 With B<-X> or without this option, X0201 is converted into X0208 Kana.
240 With B<-x>, try to preserve X0208 kana and do not convert X0201 kana to X0208.
241 In JIS output, ESC-(-I is used. In EUC output, SS2 is used.
242
243 =item B<-B[0-2]>
244
245 Assume broken JIS-Kanji input, which lost ESC.
246 Useful when your site is using old B-News Nihongo patch.
247
248 =over
249
250 =item B<-B1>
251
252 allows any chars after ESC-( or ESC-$.
253
254 =item B<-B2>
255
256 force ASCII after NL.
257
258 =back
259
260 =item B<-I>
261
262 Replacing non iso-2022-jp char into a geta character
263 (substitute character in Japanese).
264
265 =item B<-m[BQN0]>
266
267 MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT)
268 To see ISO8859-1 (Latin-1) -l is necessary.
269
270 =over
271
272 =item B<-mB>
273
274 Decode MIME base64 encoded stream. Remove header or other part before
275 conversion. 
276
277 =item B<-mQ>
278
279 Decode MIME quoted stream. '_' in quoted stream is converted to space.
280
281 =item B<-mN>
282
283 Non-strict decoding.
284 It allows line break in the middle of the base64 encoding.
285
286 =item B<-m0>
287
288 No MIME decode.
289
290 =back
291
292 =item B<-M>
293
294 MIME encode. Header style. All ASCII code and control characters are intact.
295
296 =over
297
298 =item B<-MB>
299
300 MIME encode Base64 stream.
301 Kanji conversion is performed before encoding, so this cannot be used as a picture encoder.
302
303 =item B<-MQ>
304
305 Perform quoted encoding.
306
307 =back
308
309 =item B<-l>
310
311 Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP.
312 B<-s>, B<-e> and B<-x> are not compatible with this option.
313
314 =item B<-L[uwm] -d -c>
315
316 Convert line breaks.
317
318 =over
319
320 =item B<-Lu -d>
321
322 unix (LF)
323
324 =item B<-Lw -c>
325
326 windows (CRLF)
327
328 =item B<-Lm>
329
330 mac (CR)
331
332 Without this option, nkf doesn't convert line breaks.
333
334 =back
335
336 =item B<--fj --unix --mac --msdos --windows>
337
338 Convert for these systems.
339
340 =item B<--jis --euc --sjis --mime --base64>
341
342 Convert to named code.
343
344 =item B<--jis-input --euc-input --sjis-input --mime-input --base64-input>
345
346 Assume input system
347
348 =item B<--ic=I<input codeset> --oc=I<output codeset>>
349
350 Set the input or output codeset.
351 NKF supports following codesets and those codeset names are case insensitive.
352
353 =over
354
355 =item ISO-2022-JP
356
357 a.k.a. RFC1468, 7bit JIS, JUNET
358
359 =item EUC-JP (eucJP-nkf)
360
361 a.k.a. AT&T JIS, Japanese EUC, UJIS
362
363 =item eucJP-ascii
364
365 =item eucJP-ms
366
367 =item CP51932
368
369 Microsoft Version of EUC-JP.
370
371 =item Shift_JIS
372
373 a.k.a. SJIS, MS_Kanji
374
375 =item Windows-31J
376
377 a.k.a. CP932
378
379 =item UTF-8
380
381 same as UTF-8N
382
383 =item UTF-8N
384
385 UTF-8 without BOM
386
387 =item UTF-8-BOM
388
389 UTF-8 with BOM
390
391 =item UTF8-MAC (input only)
392
393 decomposed UTF-8
394
395 =item UTF-16
396
397 same as UTF-16BE
398
399 =item UTF-16BE
400
401 UTF-16 Big Endian without BOM
402
403 =item UTF-16BE-BOM
404
405 UTF-16 Big Endian with BOM
406
407 =item UTF-16LE
408
409 UTF-16 Little Endian without BOM
410
411 =item UTF-16LE-BOM
412
413 UTF-16 Little Endian with BOM
414
415 =item UTF-32
416
417 same as UTF-32BE
418
419 =item UTF-32BE
420
421 UTF-32 Big Endian without BOM
422
423 =item UTF-32BE-BOM
424
425 UTF-32 Big Endian with BOM
426
427 =item UTF-32LE
428
429 UTF-32 Little Endian without BOM
430
431 =item UTF-32LE-BOM
432
433 UTF-32 Little Endian with BOM
434
435 =back
436
437 =item B<--fb-{skip, html, xml, perl, java, subchar}>
438
439 Specify the way that nkf handles unassigned characters.
440 Without this option, --fb-skip is assumed.
441
442 =item B<--prefix=I<escape character>I<target character>..>
443
444 When nkf converts to Shift_JIS,
445 nkf adds a specified escape character to specified 2nd byte of Shift_JIS characters.
446 1st byte of argument is the escape character and following bytes are target characters.
447
448 =item B<--no-cp932ext>
449
450 Handle the characters extended in CP932 as unassigned characters.
451
452 =item B<--no-best-fit-chars>
453
454 When Unicode to Encoded byte conversion,
455 don't convert characters which is not round trip safe.
456 When Unicode to Unicode conversion,
457 with this and -x option, nkf can be used as UTF converter.
458 (In other words, without this and -x option, nkf doesn't save some characters)
459
460 When nkf converts strings that related to path, you should use this opion.
461
462 =item B<--cap-input>
463
464 Decode hex encoded characters.
465
466 =item B<--url-input>
467
468 Unescape percent escaped characters.
469
470 =item B<--numchar-input>
471
472 Decode character reference, such as "&#....;".
473
474 =begin COMMAND
475
476 =item B<--in-place[=>I<SUFFIX>B<]>  B<--overwrite[=>I<SUFFIX>B<]>
477
478 Overwrite B<original> listed files by filtered result.
479
480 B<Note> --overwrite preserves timestamps of original files.
481
482 =item B<--guess=[12]>
483
484 Print guessed encoding and newline. (2 is default, 1 is only encoding)
485
486 =item B<--help>
487
488 Print nkf's help.
489
490 =item B<--version>
491
492 Print nkf's version.
493
494 =end
495
496 =item B<-->
497
498 Ignore rest of -option.
499
500 =back
501
502 =head1 AUTHOR
503
504 Copyright (c) 1987, Fujitsu LTD. (Itaru ICHIKAWA).
505
506 Copyright (c) 1996-2010, The nkf Project.
507
508 =begin
509
510 =head1 SEE ALSO
511
512 perl(1).   nkf(1)
513
514 =end
515
516 =cut