Mercurial > hg > xemacs-beta

comparison etc/mule/mule.1 @ 70:131b0175ea99 r20-0b30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-0b30
author cvs
date Mon, 13 Aug 2007 09:02:59 +0200
parents
children
comparison
equal deleted inserted replaced
69:804d1389bcd6 70:131b0175ea99
1 .TH MULE 1 "1994 July 28"
2 .UC 4
3 .SH NAME
4 mule \- Multilingual Enhancement to GNU Emacs
5 .SH SYNOPSIS
6 .B mule
7 [
8 .I command-line switches
9 ] [
10 .I files ...
11 ]
12 .br
13 .SH DESCRIPTION
14 .I Mule
15 is a multilingual enhancement to GNU Emacs.
16 .I Mule
17 provides a facility to display, input, and edit multilingual
18 characters in addition to all GNU Emacs facilities.
19 .PP
20 .I GNU Emacs
21 is a new version of
22 .I Emacs,
23 written by the author of the original (PDP-10)
24 .I Emacs,
25 Richard Stallman.
26 Its user functionality encompasses
27 everything other
28 .I Emacs
29 editors do, and it is easily extensible since its
30 editing commands are written in Lisp.
31 .PP
32 .I Emacs
33 has an extensive interactive help facility,
34 but the facility assumes that you know how to manipulate
35 .I Emacs
36 windows and buffers.
37 CTRL-h (backspace
38 or CTRL-h) enters the Help facility. Help Tutorial (CTRL-h t)
39 requests an interactive tutorial which can teach beginners the fundamentals
40 of
41 .I Emacs
42 in a few minutes.
43 Help Apropos (CTRL-h a) helps you
44 find a command given its functionality, Help Character (CTRL-h c)
45 describes a given character's effect, and Help Function (CTRL-h f)
46 describes a given Lisp function specified by name.
47 .PP
48 .I Emacs's
49 Undo can undo several steps of modification to your buffers, so it is
50 easy to recover from editing mistakes.
51 .PP
52 .I GNU Emacs's
53 many special packages handle mail reading (RMail) and sending (Mail),
54 outline editing (Outline), compiling (Compile), running subshells
55 within
56 .I Emacs
57 windows (Shell), running a Lisp read-eval-print loop
58 (Lisp-Interaction-Mode), and automated psychotherapy (Doctor).
59 .PP
60 There is an extensive reference manual, but
61 users of other Emacses
62 should have little trouble adapting even
63 without a copy. Users new to
64 .I Emacs
65 will be able
66 to use basic features fairly rapidly by studying the tutorial and
67 using the self-documentation features.
68 .PP
69 .SM Emacs Options
70 .PP
71 The following options are of general interest:
72 .TP 8
73 .I file
74 Edit
75 .I file.
76 .TP
77 .BI \+ number
78 Go to the line specified by
79 .I number
80 (do not insert a space between the "+" sign and
81 the number).
82 .TP
83 .B \-q
84 Do not load an init file.
85 .TP
86 .BI \-u " user"
87 Load
88 .I user's
89 init file.
90 .TP
91 .BI \-t " file"
92 Use specified
93 .I file
94 as the terminal instead of using stdin/stdout.
95 This must be the first argument specified in the command line.
96 .PP
97 The following options are lisp-oriented
98 (these options are processed in the order encountered):
99 .TP 8
100 .BI \-f " function"
101 Execute the lisp function
102 .I function.
103 .TP
104 .BI \-l " file"
105 Load the lisp code in the file
106 .I file.
107 .PP
108 The following options are useful when running
109 .I Emacs
110 as a batch editor:
111 .TP 8
112 .BI \-batch " commandfile"
113 Edit in batch mode using the commands found in
114 .I commandfile.
115 The editor will send messages to stdout.
116 This option must be the first in the argument list.
117 .TP
118 .B \-kill
119 Exit
120 .I Emacs
121 while in batch mode.
122 .\" START DELETING HERE IF YOU'RE NOT USING X
123 .PP
124 .SM Using Emacs with X
125 .PP
126 .I Emacs
127 has been tailored to work well with the X window system.
128 If you run
129 .I Emacs
130 from under X windows, it will create its own X window to
131 display in. You will probably want to start the editor
132 as a background process
133 so that you can continue using your original window.
134 .PP
135 .I Emacs
136 can be started with the following X switches:
137 .TP 8
138 .BI \-rn " name"
139 Specifies the program name which should be used when looking up
140 defaults in the user's X resources. This must be the first option
141 specified in the command line.
142 .TP 8
143 .BI \-name " name"
144 Specifies the name which should be assigned to the
145 .I Emacs
146 window.
147 .TP 8
148 .B \-r
149 Display the
150 .I Emacs
151 window in reverse video.
152 .TP
153 .B \-i
154 Use the "kitchen sink" bitmap icon when iconifying the
155 .I Emacs
156 window.
157 .TP
158 .BI \-font " fontset, " \-fn " fontset"
159 Set the
160 .I Emacs
161 window's fontset to that specified by
162 .I fontset.
163 You can specify a fontset just by the name or a comma separated list of fonts.
164 In the former case, the actual contents of the fontset should be defined by
165 X's resource or Emacslisp function
166 .I new-fontset.
167 In the latter case, a fontset of no name is created from the list.
168 .br
169 You will find the various
170 .I X
171 fonts in the
172 .I /usr/lib/X11/fonts
173 directory.
174 Note that
175 .I Emacs
176 will only accept fixed width fonts.
177 Under the X11 Release 4 font-naming conventions, any font with the
178 value "m" or "c" in the eleventh field of the font name is a fixed
179 width font. Furthermore, fonts whose name are of the form
180 .IR width x height
181 are generally fixed width, as is the font
182 .IR fixed .
183 See
184 .IR xlsfonts (1)
185 for more information.
186
187 When you specify a fontset, be sure to put a space between the
188 switch and the fontset name.
189 .TP
190 .BI \-lsp " linespace"
191 Set the dot size of u(pper) and l(ower)
192 .I linespace
193 in the form
194 .I u+l.
195 You can omit
196 .I u
197 and/or
198 .I l.
199 The default value is
200 .I 1+1.
201 .TP
202 .BI \-b " pixels"
203 Set the
204 .I Emacs
205 window's border width to the number of pixels specified by
206 .I pixels.
207 Defaults to one pixel on each side of the window.
208 .TP
209 .BI \-ib " pixels"
210 Set the window's internal border width to the number of pixels specified
211 by
212 .I pixels.
213 Defaults to one pixel of padding on each side of the window.
214 .PP
215 .TP 8
216 .BI \-geometry " geometry"
217 Set the
218 .I Emacs
219 window's width, height, and position as specified. The geometry
220 specification is in the standard X format; see
221 .IR X (1)
222 for more information.
223 The width and height are specified in characters; the default is 80 by
224 24.
225 .PP
226 .TP 8
227 .BI \-fg " color"
228 On color displays, sets the color of the text.
229
230 See the file
231 .I /usr/lib/X11/rgb.txt
232 for a list of valid
233 color names.
234 .TP
235 .BI \-bg " color"
236 On color displays,
237 sets the color of the window's background.
238 .TP
239 .BI \-bd " color"
240 On color displays,
241 sets the color of the window's border.
242 .TP
243 .BI \-cr " color"
244 On color displays,
245 sets the color of the window's text cursor.
246 .TP
247 .BI \-ms " color"
248 On color displays,
249 sets the color of the window's mouse cursor.
250 .TP
251 .BI \-d " displayname, " \-display " displayname"
252 Create the
253 .I Emacs
254 window on the display specified by
255 .IR displayname .
256 Must be the first option specified in the command line.
257 .TP
258 .B \-nw
259 Tells
260 .I Emacs
261 not to use its special interface to X. If you use this
262 switch when invoking
263 .I Emacs
264 from an
265 .IR xterm (1)
266 window, display is done in that window.
267 This must be the first option specified in the command line.
268 .PP
269 You can set
270 .I X
271 default values for your
272 .I Emacs
273 windows in your
274 .I \.Xresources
275 file (see
276 .IR xrdb (1)).
277 Use the following format:
278 .IP
279 emacs.keyword:value
280 .PP
281 where
282 .I value
283 specifies the default value of
284 .I keyword.
285 .I Emacs
286 lets you set default values for the following keywords:
287 .TP 8
288 .B font (\fPclass\fB Font)
289 Sets the window's text font.
290 .TP
291 .B fontSetList (\fPclass\fB FontSetList)
292 List of names of fontsets. The first fontset in the list is used by default.
293 .TP
294 .B fontSet-XXX (\fPclass\fB FontSet-XXX)
295 Definition of fontset XXX. It should be a comma separated
296 list of font names. Each name should contain at least CHARSET-REGISTRY.
297 .TP
298 .B reverseVideo (\fPclass\fB ReverseVideo)
299 If
300 .I reverseVideo's
301 value is set to
302 .I on,
303 the window will be displayed in reverse video.
304 .TP
305 .B bitmapIcon (\fPclass\fB BitmapIcon)
306 If
307 .I bitmapIcon's
308 value is set to
309 .I on,
310 the window will iconify into the "kitchen sink."
311 .TP
312 .B borderWidth (\fPclass\fB BorderWidth)
313 Sets the window's border width in pixels.
314 .TP
315 .B internalBorder (\fPclass\fB BorderWidth)
316 Sets the window's internal border width in pixels.
317 .TP
318 .B foreground (\fPclass\fB Foreground)
319 For color displays,
320 sets the window's text color.
321 .TP
322 .B background (\fPclass\fB Background)
323 For color displays,
324 sets the window's background color.
325 .TP
326 .B borderColor (\fPclass\fB BorderColor)
327 For color displays,
328 sets the color of the window's border.
329 .TP
330 .B cursorColor (\fPclass\fB Foreground)
331 For color displays,
332 sets the color of the window's text cursor.
333 .TP
334 .B pointerColor (\fPclass\fB Foreground)
335 For color displays,
336 sets the color of the window's mouse cursor.
337 .TP
338 .B geometry (\fPclass\fB Geometry)
339 Sets the geometry of the
340 .I Emacs
341 window (as described above).
342 .TP
343 .B title (\fPclass\fB Title)
344 Sets the title of the
345 .I Emacs
346 window.
347 .TP
348 .B iconName (\fPclass\fB Title)
349 Sets the icon name for the
350 .I Emacs
351 window icon.
352 .PP
353 If you try to set color values while using a black and white display,
354 the window's characteristics will default as follows:
355 the foreground color will be set to black,
356 the background color will be set to white,
357 the border color will be set to grey,
358 and the text and mouse cursors will be set to black.
359 .PP
360 .SM Using the Mouse
361 .PP
362 The following lists the mouse button bindings for the
363 .I Emacs
364 window under X11.
365
366 .in +\w'CTRL-SHIFT-middle'u+4n
367 .ta \w'CTRL-SHIFT-middle'u+4n
368 .ti -\w'CTRL-SHIFT-middle'u+4n
369 MOUSE BUTTON FUNCTION
370 .br
371 .ti -\w'CTRL-SHIFT-middle'u+4n
372 left Set point.
373 .br
374 .ti -\w'CTRL-SHIFT-middle'u+4n
375 middle Paste text.
376 .br
377 .ti -\w'CTRL-SHIFT-middle'u+4n
378 right Cut text into X cut buffer.
379 .br
380 .ti -\w'CTRL-SHIFT-middle'u+4n
381 SHIFT-middle Cut text into X cut buffer.
382 .br
383 .ti -\w'CTRL-SHIFT-middle'u+4n
384 SHIFT-right Paste text.
385 .br
386 .ti -\w'CTRL-SHIFT-middle'u+4n
387 CTRL-middle Cut text into X cut buffer and kill it.
388 .br
389 .ti -\w'CTRL-SHIFT-middle'u+4n
390 CTRL-right Select this window, then split it into
391 two windows. Same as typing CTRL-x 2.
392 .\" START DELETING HERE IF YOU'RE NOT USING X MENUS
393 .br
394 .ti -\w'CTRL-SHIFT-middle'u+4n
395 CTRL-SHIFT-left X buffer menu--hold the buttons and keys
396 down, wait for menu to appear, select
397 buffer, and release. Move mouse out of
398 menu and release to cancel.
399 .br
400 .ti -\w'CTRL-SHIFT-middle'u+4n
401 CTRL-SHIFT-middle X help menu--pop up index card menu for
402 Emacs help.
403 .\" STOP DELETING HERE IF YOU'RE NOT USING X MENUS
404 .br
405 .ti -\w'CTRL-SHIFT-middle'u+4n
406 CTRL-SHIFT-right Select window with mouse, and delete all
407 other windows. Same as typing CTRL-x 1.
408 .\" STOP DELETING HERE IF YOU'RE NOT USING X
409 .PP
410 .SH MANUALS
411 You can order printed copies of the GNU Emacs Manual for $20.00/copy
412 postpaid from the Free Software Foundation, which develops GNU software
413 (contact them for quantity prices on the manual). Their address is:
414 .nf
415 Free Software Foundation
416 675 Mass Ave.
417 Cambridge, MA 02139
418 .fi
419 Your local Emacs maintainer might also have copies available. As
420 with all software and publications from FSF, everyone is permitted to
421 make and distribute copies of the Emacs manual. The TeX source to the
422 manual is also included in the Emacs source distribution.
423 .PP
424 .SH FILES
425 /usr/local/info - files for the Info documentation browser
426 (a subsystem of Emacs) to refer to. Currently not much of Unix
427 is documented here, but the complete text of the Emacs reference
428 manual is included in a convenient tree structured form.
429
430 /usr/local/lib/emacs/$VERSION/src - C source files and object files
431
432 /usr/local/lib/emacs/$VERSION/lisp - Lisp source files and compiled files
433 that define most editing commands. Some are preloaded;
434 others are autoloaded from this directory when used.
435
436 /usr/local/lib/emacs/$VERSION/etc - various programs that are used with
437 GNU Emacs, and some files of information.
438
439 /usr/local/lib/emacs/$VERSION/etc/DOC.* - contains the documentation
440 strings for the Lisp primitives and preloaded Lisp functions
441 of GNU Emacs. They are stored here to reduce the size of
442 Emacs proper.
443
444 /usr/local/lib/emacs/$VERSION/etc/DIFF discusses GNU Emacs vs. Twenex
445 Emacs;
446 .br
447 /usr/local/lib/emacs/$VERSION/etc/CCADIFF discusses GNU Emacs vs. CCA
448 Emacs;
449 .br
450 /usr/local/lib/emacs/$VERSION/etc/GOSDIFF discusses GNU Emacs
451 vs. Gosling Emacs.
452 .br
453 /usr/local/lib/emacs/$VERSION/etc/SERVICE lists people offering
454 various services to assist users of GNU Emacs, including education,
455 troubleshooting, porting and customization.
456 .br
457 These files also have information useful to anyone wishing to write
458 programs in the Emacs Lisp extension language, which has not yet been fully
459 documented.
460
461 /usr/local/lib/emacs/lock - holds lock files that are made for all
462 files being modified in Emacs, to prevent simultaneous modification
463 of one file by two users.
464
465 /usr/local/lib/emacs/$VERSION/$ARCHITECTURE/cpp - the GNU cpp, needed
466 for building Emacs on certain versions of Unix where the standard cpp
467 cannot handle long names for macros.
468
469 .\" START DELETING HERE IF YOU'RE NOT USING X
470 /usr/lib/X11/rgb.txt - list of valid X color names.
471 .\" STOP DELETING HERE IF YOU'RE NOT USING X
472 .PP
473 .SH BUGS
474 There is a mailing list, bug-gnu-emacs@prep.ai.mit.edu on the internet
475 (ucbvax!prep.ai.mit.edu!bug-gnu-emacs on UUCPnet), for reporting Emacs
476 bugs and fixes. But before reporting something as a bug, please try
477 to be sure that it really is a bug, not a misunderstanding or a
478 deliberate feature. We ask you to read the section ``Reporting Emacs
479 Bugs'' near the end of the reference manual (or Info system) for hints
480 on how and when to report bugs. Also, include the version number of
481 the Emacs you are running in \fIevery\fR bug report that you send in.
482
483 Do not expect a personal answer to a bug report. The purpose of reporting
484 bugs is to get them fixed for everyone in the next release, if possible.
485 For personal assistance, look in the SERVICE file (see above) for
486 a list of people who offer it.
487
488 Please do not send anything but bug reports to this mailing list.
489 Send requests to be added to mailing lists to the special list
490 info-gnu-emacs-request@prep.ai.mit.edu (or the corresponding UUCP
491 address). For more information about Emacs mailing lists, see the
492 file /usr/local/emacs/etc/MAILINGLISTS. Bugs tend actually to be
493 fixed if they can be isolated, so it is in your interest to report
494 them in such a way that they can be easily reproduced.
495 .PP
496 Bugs that I know about are: shell will not work with programs
497 running in Raw mode on some Unix versions.
498 .PP
499 There is a mailing list, mule@etl.go.jp on the internet, for reporting
500 Mule bugs and fixes. But before reporting something as a bug, please
501 try to check if the bug is Mule oriented or original GNU Emacs oriented.
502 The mailing list above is to discuss Mule oriented matters.
503 .SH UNRESTRICTIONS
504 .PP
505 .I Emacs
506 is free; anyone may redistribute copies of
507 .I Emacs
508 to
509 anyone under the terms stated in the
510 .I Emacs
511 General Public License,
512 a copy of which accompanies each copy of
513 .I Emacs
514 and which also
515 appears in the reference manual.
516 .PP
517 Copies of
518 .I Emacs
519 may sometimes be received packaged with distributions of Unix systems,
520 but it is never included in the scope of any license covering those
521 systems. Such inclusion violates the terms on which distribution
522 is permitted. In fact, the primary purpose of the General Public
523 License is to prohibit anyone from attaching any other restrictions
524 to redistribution of
525 .I Emacs.
526 .PP
527 Richard Stallman encourages you to improve and extend
528 .I Emacs,
529 and urges that
530 you contribute your extensions to the GNU library. Eventually GNU
531 (Gnu's Not Unix) will be a complete replacement for Berkeley
532 Unix.
533 Everyone will be able to use the GNU system for free.
534 .PP
535 .I Mule
536 is also free; anyone may redistribute copies of
537 .I Mule
538 to
539 anyone under the terms stated in the
540 .I GNU
541 General Public License,
542 a copy of which accompanies each copy of
543 .I Mule.
544 .SH SEE ALSO
545 X(1), xlsfonts(1), xterm(1), xrdb(1), m2ps(1)
546 .SH AUTHORS
547 .PP
548 .I Emacs
549 was written by Richard Stallman and the Free Software Foundation.
550 Joachim Martillo and Robert Krawitz added the X features.
551 .PP
552 .I Mule
553 was written by Ken'ichi HANDA, Satoru TOMURA, and Mikiko NISHIKIMI
554 of Electrotechnical Laboratory, JAPAN, with a great help by
555 members Mule mailing list.