.TH EMACSTOOL 1.SH NAME.I emacstool \- run emacs under Sun windows with function-key and mouse support..SH SYNOPSIS.I emacstool[{window_args} {-rc run_command_path} args ... ].SH TYPICAL USAGEIn ~/.suntools or ~/.rootmenu include a line like this:.br"Emacstool" emacstool -WI emacs.icon -f emacstool-init.SH DESCRIPTION.B Emacstoolcreates a SunView frame and a tty subwindow within which mouse eventsand function keys are translated to ASCII sequences which Emacs canparse. The translated input events are sent to the process running inthe tty subwindow, which is typically GNU Emacs. Emacstool therebyallows GNU Emacs users to make full use of the mouse and function keys.GNU Emacs can be loaded with functions to interpret the mouse andfunction-key events to make a truly fine screen oriented editor forthe Sun Workstation..PP(Note that GNU Emacs has a special interface to the X window system aswell. The X window system has many technical advantages, it is anindustry standard, and it is also free software. The Free SoftwareFoundation urges you to try X windows, and distributes a free copy ofX on Emacs distribution tapes.).PPFunction keys are translated to a sequence of the form`^X*[a-o][lrt]'. The last character is `l', `r', or `t' correspondingto whether the key is among the Left, Right, or Top function keys.The third character indicates which button of the groupwas pressed. Thus, the function key in the lower right corner willtransmit the sequence `^X*or'. In addition, the [lrt] is affected bythe Control, Meta, and Shift keys. Unshifted Control keys will benon-alphabetic: C-l is [,], C-r is [2], C-t is [4]..PP Mouse buttons are encoded as `^X^@([124] x y)\\n'. ^X^@ is thestandard GNU Emacs mouse event prefix, it is followed by a listindicating the button pressed and the character row and column of thepoint in the window where the mouse cursor is, and followed by anewline character. In GNU Emacs, the ^X^@ dispatches to amouse event handler which then reads the following list..SH OPTIONS.B Emacstoolsupports all the standard window arguments, including font and icon specifiers. .PPBy default, Emacstool runs the program .I emacsin the created subwindow. The value of the environment variable .I EMACSTOOLcan be used to override this if your version of .B Emacsis not accessible on your search path by the name .I Emacs.In addition, the run command can be set by the .I pathname following the last occurrence of the.I \-rcflag.This is convenient for using Emacstool to run on remote machines..PPAll other command line arguments not used by the window system are passedas arguments to the program that runs in the Emacstool window..PPFor example: .PPlocal% (emacstool -rc rlogin remote -8 &)&.PPwill create an Emacstool window logged in to a machine named.I remote.If Emacs is run from this window, Emacstool will encode mouse and function keys, and send them to rlogin.If Emacs is run from this shell on the remote machine, it will seethe mouse and function keys properly.However, since the remote host does not have access to the screen,the cursor cannot be changed, menus will not appear, and the selectionbuffer (STUFF) is limited..SH Using With GNU Emacs:The GNU Emacs fileslisp/term/sun.el,lisp/sun-mouse.el, lisp/sun-fns.el, and src/sunfns.cprovide emacs support for the Emacstool and function keys.Emacstool will automatically set the TERM environment variable to be "sun"and unset the environment variable TERMCAP. That is, these variables willnot be inherited from the shell that starts Emacstool.Since the terminal type is.I SUN(that is, the environment variable TERM is set to .I SUN), Emacs will automatically load the file lisp/term/sun.This, in turn, will ensure that sun-mouse.el is autoloaded when any mouseevents are detected. It is suggested that .I sun-mouse and.I sun-fnsbe loaded in your site-init.el file, so that they will always be loadedwhen running on a Sun workstation..PPIn addition, Emacstool sets the environment variable IN_EMACSTOOL = "t".Lisp code in your ~/.emacs can use (getenv "IN_EMACSTOOL")to determine whether to do Emacstool specific initialization.Sun.el uses this to automatically call emacstool-init (getenv "IN_EMACSTOOL")is defined..PPThe file src/sunfns.c defines several useful functions for emacs onthe Sun. Among these are procedures to pop-up SunView .I menus, put and get from the SunView.I STUFFbuffer, and a procedure for changing the cursor .I icon.If you want to define or edit cursor icons, there is a rudimentary mouse driven icon editor in the filelisp/sun-cursors.el. Try invoking (sc:edit-cursor).SH BUGSIt takes a few milliseconds to create a menu before it pops up..SH ENVIRONMENT VARIABLESEMACSTOOLIN_EMACSTOOLTERMTERMCAP.SH FILES.DTemacs.SH "SEE ALSO"emacs(1) .../etc/SUN-SUPPORT .../lisp/term/sun.el