2 '\" Copyright (c) 1998 by Scriptics Corporation.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" RCS: @(#) $Id: encoding.n,v 1.2 1999/04/16 00:46:34 stanton Exp $
9 '\" The definitions below are for supplemental macros used in Tcl/Tk
12 '\" .AP type name in/out ?indent?
13 '\" Start paragraph describing an argument to a library procedure.
14 '\" type is type of argument (int, etc.), in/out is either "in", "out",
15 '\" or "in/out" to describe whether procedure reads or modifies arg,
16 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 '\" needed; use .AS below instead)
20 '\" Give maximum sizes of arguments for setting tab stops. Type and
21 '\" name are examples of largest possible arguments that will be passed
22 '\" to .AP later. If args are omitted, default tab stops are used.
25 '\" Start box enclosure. From here until next .BE, everything will be
26 '\" enclosed in one large box.
29 '\" End of box enclosure.
32 '\" Begin code excerpt.
37 '\" .VS ?version? ?br?
38 '\" Begin vertical sidebar, for use in marking newly-changed parts
39 '\" of man pages. The first argument is ignored and used for recording
40 '\" the version when the .VS was added, so that the sidebars can be
41 '\" found and removed when they reach a certain age. If another argument
42 '\" is present, then a line break is forced before starting the sidebar.
45 '\" End of vertical sidebar.
48 '\" Begin an indented unfilled display.
51 '\" End of indented unfilled display.
54 '\" Start of list of standard options for a Tk widget. The
55 '\" options follow on successive lines, in four columns separated
59 '\" End of list of standard options for a Tk widget.
61 '\" .OP cmdName dbName dbClass
62 '\" Start of description of a specific option. cmdName gives the
63 '\" option's name as specified in the class command, dbName gives
64 '\" the option's name in the option database, and dbClass gives
65 '\" the option's class in the option database.
68 '\" Print arg1 underlined, then print arg2 normally.
70 '\" RCS: @(#) $Id: man.macros,v 1.3 1999/04/16 00:46:35 stanton Exp $
72 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
76 '\" # Start an argument description
80 . ie !"\\$2"" .TP \\n()Cu
85 \&\\$1 \\fI\\$2\\fP (\\$3)
98 '\" # define tabbing values for .AP
101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
107 .AS Tcl_Interp Tcl_CreateInterp in/out
108 '\" # BS - start boxed text
109 '\" # ^y = starting y location
117 .if n \l'\\n(.lu\(ul'
120 '\" # BE - end boxed text (draw box now)
125 .ie n \l'\\n(^lu\(ul'
127 .\" Draw four-sided box normally, but don't draw top of
128 .\" box if the box started on an earlier page.
130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
140 '\" # VS - start vertical sidebar
141 '\" # ^Y = starting y location
142 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
146 .ie n 'mc \s12\(br\s0
149 '\" # VE - end of vertical sidebar
157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
164 '\" # Special macro to handle page bottom: finish off current
165 '\" # box/sidebar if in box/sidebar mode, then invoked standard
166 '\" # page bottom macro.
173 .\" Draw three-sided box if this is the box's first page,
174 .\" draw two sides but no top otherwise.
175 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179 .nr ^x \\n(^tu+1v-\\n(^Yu
180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
193 '\" # DS - begin display
199 '\" # DE - end display
205 '\" # SO - start of list of standard options
207 .SH "STANDARD OPTIONS"
213 '\" # SE - end of list of standard options
218 See the \\fBoptions\\fR manual entry for details on the standard options.
220 '\" # OP - start of full description for a single option
225 Command-Line Name: \\fB\\$1\\fR
226 Database Name: \\fB\\$2\\fR
227 Database Class: \\fB\\$3\\fR
231 '\" # CS - begin code excerpt
237 '\" # CE - end code excerpt
245 .TH encoding n "8.1" Tcl "Tcl Built-In Commands"
248 encoding \- Manipulate encodings
250 \fBencoding \fIoption\fR ?\fIarg arg ...\fR?
255 Strings in Tcl are encoded using 16-bit Unicode characters. Different
256 operating system interfaces or applications may generate strings in
257 other encodings such as Shift-JIS. The \fBencoding\fR command helps
258 to bridge the gap between Unicode and these other formats.
262 Performs one of several encoding related operations, depending on
263 \fIoption\fR. The legal \fIoption\fRs are:
265 \fBencoding convertfrom ?\fIencoding\fR? \fIdata\fR
266 Convert \fIdata\fR to Unicode from the specified \fIencoding\fR. The
267 characters in \fIdata\fR are treated as binary data where the lower
268 8-bits of each character is taken as a single byte. The resulting
269 sequence of bytes is treated as a string in the specified
270 \fIencoding\fR. If \fIencoding\fR is not specified, the current
271 system encoding is used.
273 \fBencoding convertto ?\fIencoding\fR? \fIstring\fR
274 Convert \fIstring\fR from Unicode to the specified \fIencoding\fR.
275 The result is a sequence of bytes that represents the converted
276 string. Each byte is stored in the lower 8-bits of a Unicode
277 character. If \fIencoding\fR is not specified, the current
278 system encoding is used.
281 Returns a list containing the names of all of the encodings that are
284 \fBencoding system\fR ?\fIencoding\fR?
285 Set the system encoding to \fIencoding\fR. If \fIencoding\fR is
286 omitted then the command returns the current system encoding. The
287 system encoding is used whenever Tcl passes strings to system calls.
291 It is common practice to write script files using a text editor that
292 produces output in the euc-jp encoding, which represents the ASCII
293 characters as singe bytes and Japanese characters as two bytes. This
294 makes it easy to embed literal strings that correspond to non-ASCII
295 characters by simply typing the strings in place in the script.
296 However, because the \fBsource\fR command always reads files using the
297 ISO8859-1 encoding, Tcl will treat each byte in the file as a separate
298 character that maps to the 00 page in Unicode. The
299 resulting Tcl strings will not contain the expected Japanese
300 characters. Instead, they will contain a sequence of Latin-1
301 characters that correspond to the bytes of the original string. The
302 \fBencoding\fR command can be used to convert this string to the
303 expected Japanese Unicode characters. For example,
305 set s [encoding convertfrom euc-jp "\\xA4\\xCF"]
307 would return the Unicode string "\\u306F", which is the Hiragana