Debian Codegraph @

doc/gauche-cesconv.1.in

raw
1 .\" -*-nroff-*-
2 .TH "GAUCHE\-CESCONV" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands"
3 .\" disable hyphenation
4 .nh
5 .\" disable justification (adjust text to left margin only)
6 .ad l
7 .SH "NAME"
8 gauche-cesconv \- convert text from one character encoding scheme to another
9 .SH "SYNOPSIS"
10 .HP 15
11 \fBgauche\-cesconv\fR [\fB\-h\fR] [\fB\-f\fR\ \fIencoding\fR] [\fB\-t\fR\ \fIencoding\fR] [\fB\-o\fR\ \fIoutfile\fR] [\fIinfile\fR]
12 .SH "DESCRIPTION"
13 .PP
14 The
15 \fBgauche\-cesconv\fR
16 command is a program to convert text from one character encoding scheme (CES)
17 to another\&, using Gauche's character conversion module.
18 Hence the supported character sets are the same as Gauche's.
19 See the info document of Gauche for more details.
20 .PP
21 There are other commands that provide the same functionality and more,
22 such as iconv(1) or nkf(1), but they are not universally available
23 by default.
24 This command is provided for Gauche's external packages to ease
25 the installation and configuration process; for those packages,
26 it is certain that gauche-cesconv is available, so they don't
27 need to check availability of iconv etc.
28 .PP
29 When
30 \fIinfile\fR
31 is omitted, the text is read from standard input\&.
32 .SH "OPTIONS"
33 .PP
34 \fB\-f\fR, \fB\-\-from\-code=\fR\fB\fIencoding\fR\fR
35 .RS 4
36 Selects input encoding\&. Can be \'*JP\' to guess the
37 character encoding from japanese text,
38 among either ISO2022\-JP(\-1,2,3), EUCJP, SHIFT_JIS or UTF\-8\&.
39 If omitted, gauche\'s native CES is used\&.
40 .RE
41 .PP
42 \fB\-h\fR, \fB\-\-help\fR
43 .RS 4
44 Show summary of options\&.
45 .RE
46 .PP
47 \fB\-o\fR, \fB\-\-output=\fR\fB\fIoutfile\fR\fR
48 .RS 4
49 Place output in file
50 \fIoutfile\fR\&. If omitted the converted text is written to standard output\&.
51 .RE
52 .PP
53 \fB\-t\fR, \fB\-\-to\-code=\fR\fB\fIencoding\fR\fR
54 .RS 4
55 Selects output encoding\&. (see also
56 \fB\-\-from\-code\fR)
57 .RE
58 .SH "DIAGNOSTICS"
59 .PP
60 \fBgauche\-cesconv\fR
61 exits with status 0 on success\&.
62 .SH "SEE ALSO"
63 .PP
64 \fBgauche-package\fR(1),
65 \fBiconv\fR(1)
66 .PP
67 The program will be documented fully by the
68 Gauche Developers\' Reference
69 available via the
70 \fBinfo\fR(1)
71 system\&.
72 .SH "AUTHORS"
73 .PP
74 \fBShiro Kawai\fR <\&shiro@acm\&.org\&>
75 .sp -1n
76 .IP "" 4
77 Author.
78 .PP
79 \fBJens Thiele\fR <\&karme@karme\&.de\&>
80 .sp -1n
81 .IP "" 4
82 Wrote this manpage for the Debian system\&.
83 .SH "COPYRIGHT"
84 Copyright \(co 2010 Jens Thiele
85 .br
86 .PP
87 Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved\&. This file is offered as\-is, without any warranty\&.
88 .sp