view etc/xemacs.1 @ 5353:38e24b8be4ea

Improve the lexical scoping in #'block, #'return-from. lisp/ChangeLog addition: 2011-02-07 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el: * bytecomp.el (byte-compile-initial-macro-environment): Shadow `block', `return-from' here, we implement them differently when byte-compiling. * bytecomp.el (byte-compile-active-blocks): New. * bytecomp.el (byte-compile-block-1): New. * bytecomp.el (byte-compile-return-from-1): New. * bytecomp.el (return-from-1): New. * bytecomp.el (block-1): New. These are two aliases that exist to have their own associated byte-compile functions, which functions implement `block' and `return-from'. * cl-extra.el (cl-macroexpand-all): Fix a bug here when macros in the environment have been compiled. * cl-macs.el (block): * cl-macs.el (return): * cl-macs.el (return-from): Be more careful about lexical scope in these macros. * cl.el: * cl.el ('cl-block-wrapper): Removed. * cl.el ('cl-block-throw): Removed. These aren't needed in code generated by this XEmacs. They shouldn't be needed in code generated by XEmacs 21.4, but if it turns out the packages do need them, we can put them back. 2011-01-30 Mike Sperber <mike@xemacs.org> * font-lock.el (font-lock-fontify-pending-extents): Don't fail if `font-lock-mode' is unset, which can happen in the middle of `revert-buffer'. 2011-01-23 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (delete): * cl-macs.el (delq): * cl-macs.el (remove): * cl-macs.el (remq): Don't use the compiler macro if these functions were given the wrong number of arguments, as happens in lisp-tests.el. * cl-seq.el (remove, remq): Removed. I added these to subr.el, and forgot to remove them from here. 2011-01-22 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-setq, byte-compile-set): Remove kludge allowing keywords' values to be set, all the code that does that is gone. * cl-compat.el (elt-satisfies-test-p): * faces.el (set-face-parent): * faces.el (face-doc-string): * gtk-font-menu.el: * gtk-font-menu.el (gtk-reset-device-font-menus): * msw-font-menu.el: * msw-font-menu.el (mswindows-reset-device-font-menus): * package-get.el (package-get-installedp): * select.el (select-convert-from-image-data): * sound.el: * sound.el (load-sound-file): * x-font-menu.el (x-reset-device-font-menus-core): Don't quote keywords, they're self-quoting, and the win from backward-compatibility is sufficiently small now that the style problem overrides it. 2011-01-22 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (block, return-from): Require that NAME be a symbol in these macros, as always documented in the #'block docstring and as required by Common Lisp. * descr-text.el (unidata-initialize-unihan-database): Correct the use of non-symbols in #'block and #'return-from in this function. 2011-01-15 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (concatenate): Accept more complicated TYPEs in this function, handing the sequences over to #'coerce if we don't understand them here. * cl-macs.el (inline): Don't proclaim #'concatenate as inline, its compiler macro is more useful than doing that. 2011-01-11 Aidan Kehoe <kehoea@parhasard.net> * subr.el (delete, delq, remove, remq): Move #'remove, #'remq here, they don't belong in cl-seq.el; move #'delete, #'delq here from fns.c, implement them in terms of #'delete*, allowing support for sequences generally. * update-elc.el (do-autoload-commands): Use #'delete*, not #'delq here, now the latter's no longer dumped. * cl-macs.el (delete, delq): Add compiler macros transforming #'delete and #'delq to #'delete* calls. 2011-01-10 Aidan Kehoe <kehoea@parhasard.net> * dialog.el (make-dialog-box): Correct a misplaced parenthesis here, thank you Mats Lidell in 87zkr9gqrh.fsf@mail.contactor.se ! 2011-01-02 Aidan Kehoe <kehoea@parhasard.net> * dialog.el (make-dialog-box): * list-mode.el (display-completion-list): These functions used to use cl-parsing-keywords; change them to use defun* instead, fixing the build. (Not sure what led to me not including this change in d1b17a33450b!) 2011-01-02 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (define-star-compiler-macros): Make sure the form has ITEM and LIST specified before attempting to change to calls with explicit tests; necessary for some tests in lisp-tests.el to compile correctly. (stable-union, stable-intersection): Add compiler macros for these functions, in the same way we do for most of the other functions in cl-seq.el. 2011-01-01 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (dolist, dotimes, do-symbols, macrolet) (symbol-macrolet): Define these macros with defmacro* instead of parsing the argument list by hand, for the sake of style and readability; use backquote where appropriate, instead of calling #'list and and friends, for the same reason. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * x-misc.el (device-x-display): Provide this function, documented in the Lispref for years, but not existing previously. Thank you Julian Bradfield, thank you Jeff Mincy. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * cl-seq.el: Move the heavy lifting from this file to C. Dump the cl-parsing-keywords macro, but don't use defun* for the functions we define that do take keywords, dynamic scope lossage makes that not practical. * subr.el (sort, fillarray): Move these aliases here. (map-plist): #'nsublis is now built-in, but at this point #'eql isn't necessarily available as a test; use #'eq. * obsolete.el (cl-delete-duplicates): Make this available for old compiler macros and old code. (memql): Document that this is equivalent to #'member*, and worse. * cl.el (adjoin, subst): Removed. These are in C. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * simple.el (assoc-ignore-case): Remove a duplicate definition of this function (it's already in subr.el). * iso8859-1.el (char-width): On non-Mule, make this function equivalent to that produced by (constantly 1), but preserve its docstring. * subr.el (subst-char-in-string): Define this in terms of #'substitute, #'nsubstitute. (string-width): Define this using #'reduce and #'char-width. (char-width): Give this a simpler definition, it makes far more sense to check for mule at load time and redefine, as we do in iso8859-1.el. (store-substring): Implement this in terms of #'replace, now #'replace is cheap. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * update-elc.el (lisp-files-needed-for-byte-compilation) (lisp-files-needing-early-byte-compilation): cl-macs belongs in the former, not the latter, it is as fundamental as bytecomp.el. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * cl.el: Provde the Common Lisp program-error, type-error as error symbols. This doesn't nearly go far enough for anyone using the Common Lisp errors. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (delete-duplicates): If the form has an incorrect number of arguments, don't attempt a compiler macroexpansion. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (cl-safe-expr-p): Forms that start with the symbol lambda are also safe. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (= < > <= >=): For these functions' compiler macros, the optimisation is safe even if the first and the last arguments have side effects, since they're only used the once. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (inline-side-effect-free-compiler-macros): Unroll a loop here at macro-expansion time, so these compiler macros are compiled. Use #'eql instead of #'eq in a couple of places for better style. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (notany, notevery): Avoid some dynamic scope stupidity with local variable names in these functions, when they weren't prefixed with cl-; go into some more detail in the doc strings. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (side-effect-free-fns): #'remove, #'remq are free of side-effects. (side-effect-and-error-free-fns): Drop dot, dot-marker from the list. 2010-11-17 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (coerce): In the argument list, name the first argument OBJECT, not X; the former name was always used in the doc string and is clearer. Handle vector type specifications which include the length of the target sequence, error if there's a mismatch. * cl-macs.el (cl-make-type-test): Handle type specifications starting with the symbol 'eql. 2010-11-14 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (eql): Don't remove the byte-compile property of this symbol. That was necessary to override a bug in bytecomp.el where #'eql was confused with #'eq, which bug we no longer have. If neither expression is constant, don't attempt to handle the expression in this compiler macro, leave it to byte-compile-eql, which produces better code anyway. * bytecomp.el (eq): #'eql is not the function associated with the byte-eq byte code. (byte-compile-eql): Add an explicit compile method for this function, for cases where the cl-macs compiler macro hasn't reduced it to #'eq or #'equal. 2010-10-25 Aidan Kehoe <kehoea@parhasard.net> Add compiler macros and compilation sanity-checking for various functions that take keywords. * byte-optimize.el (side-effect-free-fns): #'symbol-value is side-effect free and not error free. * bytecomp.el (byte-compile-normal-call): Check keyword argument lists for sanity; store information about the positions where keyword arguments start using the new byte-compile-keyword-start property. * cl-macs.el (cl-const-expr-val): Take a new optional argument, cl-not-constant, defaulting to nil, in this function; return it if the expression is not constant. (cl-non-fixnum-number-p): Make this into a separate function, we want to pass it to #'every. (eql): Use it. (define-star-compiler-macros): Use the same code to generate the member*, assoc* and rassoc* compiler macros; special-case some code in #'add-to-list in subr.el. (remove, remq): Add compiler macros for these two functions, in preparation for #'remove being in C. (define-foo-if-compiler-macros): Transform (remove-if-not ...) calls to (remove ... :if-not) at compile time, which will be a real win once the latter is in C. (define-substitute-if-compiler-macros) (define-subst-if-compiler-macros): Similarly for these functions. (delete-duplicates): Change this compiler macro to use #'plists-equal; if we don't have information about the type of SEQUENCE at compile time, don't bother attempting to inline the call, the function will be in C soon enough. (equalp): Remove an old commented-out compiler macro for this, if we want to see it it's in version control. (subst-char-in-string): Transform this to a call to nsubstitute or nsubstitute, if that is appropriate. * cl.el (ldiff): Don't call setf here, this makes for a load-time dependency problem in cl-macs.el 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * term/vt100.el: Refer to XEmacs, not GNU Emacs, in permissions. * term/bg-mouse.el: * term/sup-mouse.el: Put copyright notice in canonical "Copyright DATE AUTHOR" form. Refer to XEmacs, not GNU Emacs, in permissions. * site-load.el: Add permission boilerplate. * mule/canna-leim.el: * alist.el: Refer to XEmacs, not APEL/this program, in permissions. * mule/canna-leim.el: Remove my copyright, I've assigned it to the FSF. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * gtk.el: * gtk-widget-accessors.el: * gtk-package.el: * gtk-marshal.el: * gtk-compose.el: * gnome.el: Add copyright notice based on internal evidence. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * easymenu.el: Add reference to COPYING to permission notice. * gutter.el: * gutter-items.el: * menubar-items.el: Fix typo "Xmacs" in permissions notice. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * auto-save.el: * font.el: * fontconfig.el: * mule/kinsoku.el: Add "part of XEmacs" text to permission notice. 2010-10-14 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (side-effect-free-fns): * cl-macs.el (remf, getf): * cl-extra.el (tailp, cl-set-getf, cl-do-remf): * cl.el (ldiff, endp): Tighten up Common Lisp compatibility for #'ldiff, #'endp, #'tailp; add circularity checking for the first two. #'cl-set-getf and #'cl-do-remf were Lisp implementations of #'plist-put and #'plist-remprop; change the names to aliases, changes the macros that use them to using #'plist-put and #'plist-remprop directly. 2010-10-12 Aidan Kehoe <kehoea@parhasard.net> * abbrev.el (fundamental-mode-abbrev-table, global-abbrev-table): Create both these abbrev tables using the usual #'define-abbrev-table calls, rather than attempting to special-case them. * cl-extra.el: Force cl-macs to be loaded here, if cl-extra.el is being loaded interpreted. Previously other, later files would redundantly call (load "cl-macs") when interpreted, it's more reasonable to do it here, once. * cmdloop.el (read-quoted-char-radix): Use defcustom here, we don't have any dump-order dependencies that would prevent that. * custom.el (eval-when-compile): Don't load cl-macs when interpreted or when byte-compiling, rely on cl-extra.el in the former case and the appropriate entry in bytecomp-load-hook in the latter. Get rid of custom-declare-variable-list, we have no dump-time dependencies that would require it. * faces.el (eval-when-compile): Don't load cl-macs when interpreted or when byte-compiling. * packages.el: Remove some inaccurate comments. * post-gc.el (cleanup-simple-finalizers): Use #'delete-if-not here, now the order of preloaded-file-list has been changed to make it available. * subr.el (custom-declare-variable-list): Remove. No need for it. Also remove a stub define-abbrev-table from this file, given the current order of preloaded-file-list there's no need for it. 2010-10-10 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-constp) Forms quoted with FUNCTION are also constant. (byte-compile-initial-macro-environment): In #'the, if FORM is constant and does not match TYPE, warn at byte-compile time. 2010-10-10 Aidan Kehoe <kehoea@parhasard.net> * backquote.el (bq-vector-contents, bq-list*): Remove; the former is equivalent to (append VECTOR nil), the latter to (list* ...). (bq-process-2): Use (append VECTOR nil) instead of using #'bq-vector-contents to convert to a list. (bq-process-1): Now we use list* instead of bq-list * subr.el (list*): Moved from cl.el, since it is now required to be available the first time a backquoted form is encountered. * cl.el (list*): Move to subr.el. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * test-harness.el (Check-Message): Add an omitted comma here, thank you the buildbot. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * hash-table.el (hash-table-key-list, hash-table-value-list) (hash-table-key-value-alist, hash-table-key-value-plist): Remove some useless #'nreverse calls in these files; our hash tables have no order, it's not helpful to pretend they do. * behavior.el (read-behavior): Do the same in this file, in some code evidently copied from hash-table.el. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * info.el (Info-insert-dir): * format.el (format-deannotate-region): * files.el (cd, save-buffers-kill-emacs): Use #'some, #'every and related functions for applying boolean operations to lists, instead of rolling our own ones that cons and don't short-circuit. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-initial-macro-environment): * cl-macs.el (the): Rephrase the docstring, make its implementation when compiling files a little nicer. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * descr-text.el (unidata-initialize-unicodedata-database) (unidata-initialize-unihan-database, describe-char-unicode-data) (describe-char-unicode-data): Wrap calls to the database functions with (with-fboundp ...), avoiding byte compile warnings on builds without support for the database functions. (describe-char): (reduce #'max ...), not (apply #'max ...), no need to cons needlessly. (describe-char): Remove a redundant lambda wrapping #'extent-properties. (describe-char-unicode-data): Call #'nsubst when replacing "" with nil in the result of #'split-string, instead of consing inside mapcar. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * x-faces.el (x-available-font-sizes): * specifier.el (let-specifier): * package-ui.el (pui-add-required-packages): * msw-faces.el (mswindows-available-font-sizes): * modeline.el (modeline-minor-mode-menu): * minibuf.el (minibuf-directory-files): Replace the O2N (delq nil (mapcar (lambda (W) (and X Y)) Z)) with the ON (mapcan (lambda (W) (and X (list Y))) Z) in these files. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (= < > <= >=): When these functions are handed more than two arguments, and those arguments have no side effects, transform to a series of two argument calls, avoiding funcall in the byte-compiled code. * mule/mule-cmds.el (finish-set-language-environment): Take advantage of this change in a function called 256 times at startup. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-function-form, byte-compile-quote) (byte-compile-quote-form): Warn at compile time, and error at runtime, if a (quote ...) or a (function ...) form attempts to quote more than one object. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (byte-optimize-apply): Transform (apply 'nconc (mapcar ...)) to (mapcan ...); warn about use of the first idiom. * update-elc.el (do-autoload-commands): * packages.el (packages-find-package-library-path): * frame.el (frame-list): * extents.el (extent-descendants): * etags.el (buffer-tag-table-files): * dumped-lisp.el (preloaded-file-list): * device.el (device-list): * bytecomp-runtime.el (proclaim-inline, proclaim-notinline) Use #'mapcan, not (apply #'nconc (mapcar ...) in all these files. * bytecomp-runtime.el (eval-when-compile, eval-and-compile): In passing, mention that these macros also evaluate the body when interpreted. tests/ChangeLog addition: 2011-02-07 Aidan Kehoe <kehoea@parhasard.net> * automated/lisp-tests.el: Test lexical scope for `block', `return-from'; add a Known-Bug-Expect-Failure for a contorted example that fails when byte-compiled.
author Aidan Kehoe <kehoea@parhasard.net>
date Mon, 07 Feb 2011 12:01:24 +0000
parents ea7a6c12df45
children 4b08f375e2fb
line wrap: on
line source

.TH XEMACS 1 "2000-09-20"
.UC 4
.SH NAME
xemacs \- Emacs: The Next Generation
.SH SYNOPSIS
.B xemacs
[
.I command-line switches
] [
.I files ...
]
.br
.SH DESCRIPTION
.I XEmacs
is a version of
.IR Emacs ,
compatible with and containing many improvements over
.I GNU
.IR Emacs ,
written by Richard Stallman of the Free Software Foundation.  It was
originally based on an early release of
.I GNU Emacs Version
.IR 19 ,
and has tracked subsequent releases of
.I GNU Emacs
as they have become available.
.PP
The primary documentation of
.I XEmacs
is in the
.I XEmacs Reference
.IR Manual ,
which you can read on-line using Info, a subsystem of
.IR XEmacs .
Please look there for complete and up-to-date documentation.
Complete documentation on using Emacs Lisp is available on-line
through the
.I XEmacs Lisp Programmer's
.IR Manual .
Both manuals also can be printed out nicely using the
.I TeX
formatting package.
.PP
The user functionality of
.I XEmacs
encompasses everything other
.I Emacs
editors do, and it is easily extensible since its
editing commands are written in Lisp.
.PP
.I XEmacs
has an extensive interactive help facility,
but the facility assumes that you know how to manipulate
.I XEmacs
windows and buffers.
CTRL-h enters the Help facility.  Help Tutorial (CTRL-h t)
requests an interactive tutorial which can teach beginners the fundamentals
of
.I XEmacs
in a few minutes.
Help Apropos (CTRL-h a) helps you
find a command given its functionality, Help Key Binding (CTRL-h k)
describes a given key sequence's effect, and Help Function (CTRL-h f)
describes a given Lisp function specified by name.  You can also
look up key sequences in the
.I XEmacs Reference Manual
using Lookup Key Binding (CTRL-h CTRL-k),
and look up Lisp functions in the
.I XEmacs Lisp Programmer's Manual
using Lookup Function (CTRL-h CTRL-f).  All of these help functions,
and more, are available on the Help menu if you are using a window
system.
.PP
.I XEmacs
has extensive GUI (graphical user interface) support when running under
a window system such as
.IR X ,
including multiple frames (top-level windows), a menubar, a toolbar,
horizontal and vertical scrollbars, dialog boxes, and extensive mouse
support.
.PP
.I XEmacs
has full support for multiple fonts and colors, variable-width fonts,
and variable-height lines, and allows for pixmaps to be inserted into
a buffer. (This is used in the W3 web-browsing package and in some
of the debugger and outlining interfaces, among other things.)
.PP
.IR XEmacs 's
Undo can undo several steps of modification to your buffers, so it is
easy to recover from editing mistakes.
.PP
.IR XEmacs 's
many special packages handle mail reading (VM, MH-E and RMail) and
sending (Mail), Usenet news reading and posting (GNUS), World Wide Web
browsing (W3), specialized modes for editing source code in all common
programming languages, syntax highlighting for many languages
(Font-Lock), compiling (Compile), running subshells within
.I XEmacs
windows (Shell), outline editing (Outline), running a Lisp read-eval-print
loop (Lisp-Interaction-Mode), and automated psychotherapy (Doctor).
.PP
There is an extensive reference manual, but users of other Emacsen
should have little trouble adapting even without a copy.  Users new to
Emacs will be able to use basic features fairly rapidly by studying
the tutorial and using the self-documentation features.
.PP
.SM XEmacs Options
.PP
XEmacs accepts all standard X Toolkit command line options when run in
an X Windows environment.  In addition, the following options are accepted
(when options imply a sequence of actions to perform, they are
performed in the order encountered):
.TP 8
.BI \-t " file"
Use specified
.I file
as the terminal instead of using stdin/stdout.  This implies
.BR \-nw \.
.TP
.BI \-batch
Edit in batch mode.  The editor will send messages to stdout.  You
must use the
.BR \-l ,
.BR \-f ,
and
.B \-eval
options to specify files to execute and functions to call.
.TP
.B \-nw
Inhibit the use of any window-system-specific display code: use the
current TTY.
.TP
.B \-debug\-init
Enter the debugger if an error occurs loading the init file.
.TP
.B \-unmapped
Do not map the initial frame.
.TP
.B \-no\-site\-file
Do not load the site-specific init file (site-start.el).
.TP
.B \-q, \-no\-init\-file
Do not load an init file.
.TP
.B \-no-early-packages
Do not process the early packages.
.TP
.B \-vanilla
Load no extra files at startup.  Equivalent to the combination of
.BR \-q ", " \-no-site-file ", and " \-no-early-packages .
.TP
.BI \-u " user, " \-user " user"
Load
.IR user 's
init file.
.TP 8
.I file
Edit
.IR file \.
.TP
.BI \+ number
Go to the line specified by
.I number
(do not insert a space between the "+" sign and the number).
.TP
.B \-help
Print a help message and exit.
.TP
.B \-V, \-version,
Print the version number and exit.
.TP
.BI \-f " function, " \-funcall " function"
Execute the lisp function
.IR function \.
.TP
.BI \-l " file, " \-load " file"
Load the Lisp code in the file
.IR file \.
.TP
.BI \-eval " form"
Evaluate the Lisp form
.IR form \.
.TP
.BI \-i " file, " \-insert " file"
Insert
.I file
into the current buffer.
.TP
.B \-kill
Exit
.I XEmacs
(useful with
.BR \-batch ).
.PP
.SM Using XEmacs with X Windows
.PP
.I XEmacs
has been tailored to work well with the X window system.
If you run
.I XEmacs
from under X windows, it will create its own X window to display in.
.PP
.I XEmacs
can be started with the following standard X options:
.TP
.BI \-visual " <visualname><bitdepth>"
Select the visual that XEmacs will attempt to use.
.I <visualname>
should be one of the strings "StaticColor", "TrueColor", "GrayScale",
"PseudoColor" or "DirectColor", and
.I <bitdepth>
should be the number of bits per pixel (example, "-visual TrueColor24"
for a 24bit TrueColor visual) See
.IR X (1)
for more information.
.TP
.B -privateColormap
Require XEmacs to create and use a private colormap for display.  This
will keep XEmacs from taking colors from the default colormap and
keeping them from other clients, at the cost of causing annoying
flicker when the focus changes.  Use this option only if your X server
does not support 24 bit visuals.
.TP
.BI \-geometry " ##x##+##+##"
Specify the geometry of the initial window.  The ##'s represent a number;
the four numbers are width (characters), height (characters), X offset
(pixels), and Y offset (pixels), respectively.  Partial specifications of
the form
.I ##x##
or
.I +##+##
are also allowed. (The geometry
specification is in the standard X format; see
.IR X (1)
for more information.)
.TP
.B \-iconic
Specifies that the initial window should initially appear iconified.
.TP 8
.BI \-name " name"
Specifies the program name which should be used when looking up
defaults in the user's X resources.
.TP
.BI \-title " title, " \-T " title, " \-wn " title"
Specifies the title which should be assigned to the
.I XEmacs
window.
.TP
.BI \-d " displayname, " \-display " displayname"
Create the
.I XEmacs
window on the display specified by
.IR displayname .
Must be the first option specified in the command line.
.TP
.BI \-font " font, " \-fn " font"
Set the
.I XEmacs
window's font to that specified by
.IR font \.
You will find the various
.I X
fonts in the
.I /usr/lib/X11/fonts
directory.
.I XEmacs
works with either fixed- or variable-width fonts, but will probably
look better with a fixed-width font.
.TP
.BI \-scrollbar\-width " pixels"
Specify the width of the vertical scrollbars.
.TP
.BI \-scrollbar\-height " pixels"
Specify the height of the horizontal scrollbars.
.TP
.BI \-bw " pixels, " \-borderwidth " pixels"
Set the
.I XEmacs
window's border width to the number of pixels specified by
.IR pixels \.
Defaults to one pixel on each side of the window.
.TP
.BI \-ib " pixels, " \-internal\-border\-width " pixels"
Specify the width between a frame's border and its text, in pixels.
Defaults to one pixel on each side of the window.
.TP
.BI \-fg " color, " \-foreground " color"
Sets the color of the text.

See the file
.I /usr/share/X11/rgb.txt
for a list of valid
color names.
.TP
.BI \-bg " color, " \-background " color"
Sets the color of the window's background.
.TP
.BI \-bd " color, " \-bordercolor " color"
Sets the color of the window's border.
.TP
.BI \-mc " color"
Sets the color of the mouse pointer.
.TP
.BI \-cr " color"
Sets the color of the text cursor.
.TP
.B \-rv, \-reverse
Reverses the foreground and background colors (reverse video).  Consider
explicitly setting the foreground and background colors instead of using
this option.
.TP
.BI \-xrm " argument"
This allows you to set an arbitrary resource on the command line.
.I argument
should be a resource specification, as might be found in your
.I \.Xresources
or
.I \.Xdefaults
file.
.PP
You can also set resources, i.e.
.I X
default values, for your
.I XEmacs
windows in your
.I \.Xresources
or
.I \.Xdefaults
file (see
.IR xrdb (1)).
Use the following format:
.IP
Emacs.keyword:value
.PP
or
.IP
Emacs*EmacsFrame.keyword:value
.PP
where
.I value
specifies the default value of
.IR keyword \.
(Some resources need the former format; some the latter.)
.PP
You can also set resources for a particular frame by using the
format
.IP
Emacs*framename.keyword:value
.PP
where
.I framename
is the resource name assigned to that particular frame.
(Certain packages, such as VM, give their frames unique resource
names, in this case "VM".)
.PP
.I XEmacs
lets you set default values for the following keywords:
.TP 8
.B default.attributeFont (\fPclass\fB Face.AttributeFont)
Sets the window's text font.
.TP
.B default.attributeForeground (\fPclass\fB Face.AttributeForeground)
Sets the window's text color.
.TP
.B default.attributeBackground (\fPclass\fB Face.AttributeBackground)
Sets the window's background color.
.TP
.B \fIface\fB.attributeFont (\fPclass\fB Face.AttributeFont)
Sets the font for
.IR face ,
which should be the name of a face.  Common face names are
.PP
.in +\w'right-margin'u+12n
.ta \w'right-margin'u+4n
.ti -\w'right-margin'u+4n
FACE		PURPOSE
.br
.ti -\w'right-margin'u+4n
default	Normal text.
.br
.ti -\w'right-margin'u+4n
bold	Bold text.
.br
.ti -\w'right-margin'u+4n
italic	Italicized text.
.br
.ti -\w'right-margin'u+4n
bold-italic	Bold and italicized text.
.br
.ti -\w'right-margin'u+4n
modeline	Modeline text.
.br
.ti -\w'right-margin'u+4n
zmacs-region	Text selected with the mouse.
.br
.ti -\w'right-margin'u+4n
highlight	Text highlighted when the mouse passes over.
.br
.ti -\w'right-margin'u+4n
left-margin	Text in the left margin.
.br
.ti -\w'right-margin'u+4n
right-margin	Text in the right margin.
.br
.ti -\w'right-margin'u+4n
isearch	Text highlighted during incremental search.
.br
.ti -\w'right-margin'u+4n
info-node	Text of Info menu items.
.br
.ti -\w'right-margin'u+4n
info-xref	Text of Info cross references.
.TP 8
.B \fIface\fB.attributeForeground (\fPclass\fB Face.AttributeForeground)
Sets the foreground color for
.IR face \.
.TP 8
.B \fIface\fB.attributeBackground (\fPclass\fB Face.AttributeBackground)
Sets the background color for
.IR face \.
.TP 8
.B \fIface\fB.attributeBackgroundPixmap (\fPclass\fB Face.AttributeBackgroundPixmap)
Sets the background pixmap (stipple) for
.IR face \.
.TP 8
.B \fIface\fB.attributeUnderline (\fPclass\fB Face.AttributeUnderline)
Whether
.I face
should be underlined.
.TP
.B reverseVideo (\fPclass\fB ReverseVideo)
If set to
.IR on ,
the window will be displayed in reverse video.  Consider
explicitly setting the foreground and background colors instead
of using this resource.
.TP
.B borderWidth (\fPclass\fB BorderWidth)
Sets the window's border width in pixels.
.TP
.B internalBorderWidth (\fPclass\fB InternalBorderWidth)
Sets the window's internal border width in pixels.
.TP
.B borderColor (\fPclass\fB BorderColor)
Sets the color of the window's border.
.TP
.B cursorColor (\fPclass\fB Foreground)
Sets the color of the window's text cursor.
.TP
.B pointerColor (\fPclass\fB Foreground)
Sets the color of the window's mouse cursor.
.TP
.B emacsVisual (\fPclass\fB EmacsVisual)
Sets the default visual
.I XEmacs
will try to use (as described above).
.TP
.B privateColormap (\fPclass\fB PrivateColormap)
If set,
.I XEmacs
will default to using a private colormap.
.TP
.B geometry (\fPclass\fB Geometry)
Sets the geometry of the
.I XEmacs
window (as described above).
.TP
.B iconic (\fPclass\fB Iconic)
If set to on, the
.I XEmacs
window will initially appear as an icon.
.TP
.B menubar (\fPclass\fB Menubar)
Whether the
.I XEmacs
window will have a menubar.  Defaults to true.
.TP
.B initiallyUnmapped (\fPclass\fB InitiallyUnmapped)
Whether
.I XEmacs
will leave the initial frame unmapped when it starts up.
.TP
.B barCursor (\fPclass\fB BarCursor)
Whether the cursor should be a bar instead of the traditional box.
.TP
.B title (\fPclass\fB Title)
Sets the title of the
.I XEmacs
window.
.TP
.B iconName (\fPclass\fB Title)
Sets the icon name for the
.I XEmacs
window icon.
.TP
.B scrollBarWidth (\fPclass\fB ScrollBarWidth)
Sets the width of the vertical scrollbars, in pixels.  A width of 0
means no vertical scrollbars.
.TP
.B scrollBarHeight (\fPclass\fB ScrollBarHeight)
Sets the height of the horizontal scrollbars, in pixels.  A height of 0
means no horizontal scrollbars.
.TP
.B scrollBarPlacement (\fPclass\fB ScrollBarPlacement)
Sets the position of vertical and horizontal scrollbars.   Should be one
of the strings "top-left", "bottom-left", "top-right", or "bottom-right".
The default is "bottom-right" for the Motif and Lucid scrollbars and
"bottom-left" for the Athena scrollbars.
.TP
.B topToolBarHeight (\fPclass\fB TopToolBarHeight)
Sets the height of the top toolbar, in pixels.  0 means no top toolbar.
.TP
.B bottomToolBarHeight (\fPclass\fB BottomToolBarHeight)
Sets the height of the bottom toolbar, in pixels.  0 means no
bottom toolbar.
.TP
.B leftToolBarWidth (\fPclass\fB LeftToolBarWidth)
Sets the width of the left toolbar, in pixels.  0 means no left toolbar.
.TP
.B rightToolBarWidth (\fPclass\fB RightToolBarWidth)
Sets the width of the right toolbar, in pixels.  0 means no right toolbar.
.TP
.B topToolBarShadowColor (\fPclass\fB TopToolBarShadowColor)
Sets the color of the top shadows for the toolbars. (For all toolbars,
\fBnot\fR just the toolbar at the top of the frame.)
.TP
.B bottomToolBarShadowColor (\fPclass\fB BottomToolBarShadowColor)
Sets the color of the bottom shadows for the toolbars. (For all toolbars,
\fBnot\fR just the toolbar at the bottom of the frame.)
.TP
.B topToolBarShadowPixmap (\fPclass\fB TopToolBarShadowPixmap)
Sets the pixmap of the top shadows for the toolbars. (For all toolbars,
\fBnot\fR just the toolbar at the top of the frame.) If set, this
resource overrides the corresponding color resource.
.TP
.B bottomToolBarShadowPixmap (\fPclass\fB BottomToolBarShadowPixmap)
Sets the pixmap of the bottom shadows for the toolbars. (For all toolbars,
\fBnot\fR just the toolbar at the bottom of the frame.) If set, this
resource overrides the corresponding color resource.
.TP
.B toolBarShadowThickness (\fPclass\fB ToolBarShadowThickness)
Thickness of the shadows around the toolbars, in pixels.
.TP
.B visualBell (\fPclass\fB VisualBell)
Whether XEmacs should flash the screen rather than making an audible beep.
.TP
.B bellVolume (\fPclass\fB BellVolume)
Volume of the audible beep.  Range is 0 through 100.
.TP
.B useBackingStore (\fPclass\fB UseBackingStore)
Whether
.I XEmacs
should set the backing-store attribute of the
.I X
windows it creates.  This increases the memory usage of the
.I X
server but decreases the amount of
.I X
traffic necessary to update the screen, and is useful when the
connection to the
.I X
server goes over a low-bandwidth line such as a modem connection.
.TP
.B textPointer (\fPclass\fB Cursor)
The cursor to use when the mouse is over text.
.TP
.B selectionPointer (\fPclass\fB Cursor)
The cursor to use when the mouse is over a mouse-highlighted
text region.
.TP
.B spacePointer (\fPclass\fB Cursor)
The cursor to use when the mouse is over a blank space in a buffer (that
is, after the end of a line or after the end-of-file).
.TP
.B modeLinePointer (\fPclass\fB Cursor)
The cursor to use when the mouse is over a mode line.
.TP
.B gcPointer (\fPclass\fB Cursor)
The cursor to display when a garbage-collection is in progress.
.TP
.B scrollbarPointer (\fPclass\fB Cursor)
The cursor to use when the mouse is over the scrollbar.
.TP
.B pointerColor (\fPclass\fB Foreground)
The foreground color of the mouse cursor.
.TP
.B pointerBackground (\fPclass\fB Background)
The background color of the mouse cursor.
.PP
.SM Using the Mouse
.PP
The following lists the mouse button bindings for the
.I XEmacs
window under X11.

.in +\w'CTRL-SHIFT-middle'u+4n
.ta \w'CTRL-SHIFT-middle'u+4n
.ti -\w'CTRL-SHIFT-middle'u+4n
MOUSE BUTTON	FUNCTION
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
left	Set point or make a text selection.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
middle	Paste text.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
right	Pop up a menu of options.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
SHIFT-left	Extend a selection.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
CTRL-left	Make a selection and insert it at point.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
CTRL-middle	Set point and move selected text there.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
CTRL-SHIFT-left	Make a selection, delete it, and insert it at point.
.br
.ti -\w'CTRL-SHIFT-middle'u+4n
META-left	Make a rectangular selection.
.SH FILES
Lisp code is read at startup from the user's init file,
\fB$HOME/.xemacs/init.el\fP. If this file does not exist then
\fB$HOME/.emacs\fP will be read if it is present.

/usr/local/info - files for the Info documentation browser
(a subsystem of
.IR XEmacs )
to refer to.  The complete text of the
.I XEmacs Reference Manual
and the
.I XEmacs Lisp Programmer's Manual
is included in a convenient tree structured form.

/usr/local/lib/xemacs-$VERSION/info - the Info files may be here instead.

/usr/local/lib/xemacs-$VERSION/lisp/* - Lisp source files and compiled files
that define most editing commands.  The files are contained in subdirectories,
categorized by function or individual package.  Some are preloaded;
others are autoloaded from these directories when used.

/usr/local/lib/xemacs-$VERSION/etc - some files of information, pixmap
files, other data files used by certain packages, etc.

/usr/local/lib/xemacs-$VERSION/$CONFIGURATION - various programs that are used
with XEmacs.

/usr/local/lib/xemacs-$VERSION/$CONFIGURATION/DOC -
contains the documentation strings for the Lisp primitives and
preloaded Lisp functions of \fIXEmacs\fP.
They are stored here to reduce the size of \fIXEmacs\fP proper.

/usr/local/lib/xemacs/site-lisp - locally-provided Lisp files.
.PP
.SH BUGS AND HELP
There is a newsgroup, comp.emacs.xemacs, for reporting
.I XEmacs
bugs and fixes and requesting help.  But before reporting something
as a bug, please try to be sure that it really is a bug, not a
misunderstanding or a deliberate feature.  We ask you to read the section
``Reporting XEmacs Bugs'' near the end of the reference manual (or Info
system) for hints on how and when to report bugs.  Also, include the version
number of the
.I XEmacs
you are running and the system you are running it on
in \fIevery\fR bug report that you send in.  Finally, the more you can
isolate the cause of a bug and the conditions it happens under, the more
likely it is to be fixed, so please take the time to do so.

The newsgroup is bidirectionally gatewayed to and from the mailing list
xemacs@xemacs.org.  You can read the list instead of the newsgroup if
you do not have convenient Usenet news access.  To request to be added
to the mailing list, send mail to xemacs-request@xemacs.org. (Do not
send mail to the list itself.)

The
.I XEmacs
maintainers read the newsgroup regularly and will attempt to
fix bugs reported in a timely fashion.  However, not every message will
get a response from one of the maintainers.  Note that there are many
people other than the maintainers who read the newsgroup, and will usually
be of assistance in helping with any problems encountered.

If you need more personal assistance than can be provided by the
newsgroup, look in the SERVICE file (see above) for a list of people
who offer it.

For more information about XEmacs mailing lists, see the
file /usr/local/lib/xemacs-$VERSION/etc/MAILINGLISTS.
.SH UNRESTRICTIONS
.PP
.I XEmacs
is free; anyone may redistribute copies of
.I XEmacs
to
anyone under the terms stated in the
.I XEmacs
General Public License,
a copy of which accompanies each copy of
.I XEmacs
and which also
appears in the reference manual.
.PP
Copies of
.I XEmacs
may sometimes be received packaged with distributions of Unix systems,
but it is never included in the scope of any license covering those
systems.  Such inclusion violates the terms on which distribution
is permitted.  In fact, the primary purpose of the General Public
License is to prohibit anyone from attaching any other restrictions
to redistribution of
.IR XEmacs \.
.SH SEE ALSO
X(1), xlsfonts(1), xterm(1), xrdb(1), emacs(1), vi(1)
.SH AUTHORS
.PP
.I XEmacs
was written by
Steve Baur <steve@xemacs.org>,
Martin Buchholz <martin@xemacs.org>,
Richard Mlynarik <mly@adoc.xerox.com>,
Hrvoje Niksic <hniksic@xemacs.org>,
Chuck Thompson <cthomp@xemacs.org>,
Ben Wing <ben@xemacs.org>,
Jamie Zawinski <jwz@jwz.org>,
and many others.
It was based on an early version of
.I GNU Emacs Version
.IR 19 ,
written by Richard Stallman <rms@gnu.org> of the Free Software
Foundation, and has tracked subsequent releases of
.I GNU Emacs
as they have become available.  It was originally written by Lucid, Inc.
(now defunct) and was called
.I Lucid
.IR Emacs \.
.PP
Chuck Thompson wrote the
.I XEmacs
redisplay engine, maintains the
.I XEmacs
FTP and WWW sites, and has put out all releases of
.I XEmacs
since 19.11 (the first release called
.IR XEmacs ).
Ben Wing wrote the Asian-language support, the on-line documentation
(including this man page and much of the FAQ), the external widget code,
and retooled or rewrote most of the basic, low-level
.I XEmacs
subsystems.  Jamie Zawinski put out all releases of
.I Lucid
.IR Emacs ,
from the first (19.0) through the last (19.10), and was the primary
code contributor for all of these releases.  Richard Mlynarik rewrote
the
.I XEmacs
Lisp-object allocation system, improved the keymap and minibuffer code,
and did the initial synching of
.I XEmacs
with
.I GNU Emacs Version
.IR 19 \.
.PP
Many others have also contributed significantly.  For more detailed
information, including a long history of \fIXEmacs\fP from multiple
viewpoints and pretty pictures and bios of the major \fIXEmacs\fP
contributors, see the
.I XEmacs About Page
(the About XEmacs option on the Help menu).
.SH MORE INFORMATION
For more information about \fIXEmacs\fP, see the
.I XEmacs About Page
(mentioned above),
look in the file /usr/local/lib/xemacs-$VERSION/etc/NEWS,
or point your Web browser at
.PP
http://www.xemacs.org/
.PP
for up-to-the-minute information about \fIXEmacs\fP.
.PP
The
.I XEmacs
FAQ (Frequently Asked Questions) can be found at the Web site just listed.
A possibly out-of-date version is also accessible through the Info system
inside of \fIXEmacs\fP.
.PP
The latest version of \fIXEmacs\fP can be downloaded using anonymous
FTP from
.PP
ftp://ftp.xemacs.org/pub/xemacs/
.PP
or from a mirror site near you.  Mirror sites are listed in the file
etc/FTP in the XEmacs distribution or see the Web site for an up-to-date
list of mirror sites.