Debian Codegraph @

doc/xjove.nr

raw
1 .TH XJOVE 1 "8 July 1993"
2 .SH NAME
3 Xjove, Jovetool \- run JOVE under X-windows or Sunview with function-key and mouse support.
4 .SH SYNOPSIS
5 .B xjove
6 [
7 .I window_args
8 ] [
9 .B "\-f | \-nf"
10 ] [
11 .BI \-rc \ run_command_path
12 ]\&.\|.\|.
13 [
14 args
15 \&.\|.\|. ]
16 .br
17 .B jovetool
18 [
19 .I window_args
20 ] [
21 .B \-nf
22 ] [
23 .BI \-rc \ run_command_path
24 ]\&.\|.\|.
25 [
26 .I args
27 \&.\|.\|. ]
28 .SH DESCRIPTION
29 .I Xjove
30 (or
31 .IR Jovetool )
32 creates an XView or SunView frame and a tty subwindow within which mouse events
33 and function keys are translated to ASCII sequences which JOVE can
34 parse. The translated input events are sent to the process running in
35 the tty subwindow, which is typically JOVE.
36 .I Xjove
37 thereby allows JOVE users to make full use of the mouse and function keys.
38 JOVE has functions to interpret the mouse and function-key events to make a
39 truly fine screen oriented editor for any workstation supporting XView or SunView.
40 .SH OPTIONS
41 .I Xjove
42 supports all the standard window arguments, including font and icon
43 specifiers.
44 .PP
45 .I Xjove
46 has the ability to fork off a separate process to run the window that is
47 created, leaving the shell from which the
48 .I Xjove
49 command was issued free to accept other commands. This feature is enabled
50 by the
51 .B \-f
52 (for fork) flag and disabled by the
53 .B \-nf
54 (for no fork) flag. The default is set by the
55 .I xjove.forking
56 resource which can be set to True or False in your .Xdefaults file (default
57 False).
58 .PP
59 By default,
60 .I Xjove
61 runs the program
62 .I jove
63 in the created subwindow.
64 The value of the environment variable
65 .I JOVETOOL
66 can be used to override this if your version of JOVE
67 is not accessible on your search path by the name
68 .IR jove .
69 In addition, the run command can be set by the
70 .I pathname
71 following the last occurrence of the
72 .B \-rc
73 flag.
74 This is convenient for using
75 .I Xjove
76 to run on remote machines.
77 .PP
78 All other command line arguments not used by the window system are passed
79 as arguments to the program that runs in the Xjove window.
80 .PP
81 For example:
82 .PP
83 local% xjove \-rc rlogin remote
84 .PP
85 will create an Xjove window logged in to a machine named
86 .IR remote .
87 .I Xjove
88 will encode mouse and function keys, and send them to rlogin.
89 If JOVE is run from this shell on the remote machine, it will see
90 the mouse and function keys properly.
91 .SH "USING XJOVE"
92 The following assumes the use of the recommended bindings from the
93 mouse operations to the Jove mouse-commands. Note how, in general,
94 LEFT does things involving the
95 .IR point ,
96 whereas MIDDLE does things involving the
97 .IR mark .
98 .PP
99 Use of mouse buttons
100 .TP 5
101 LEFT
102 Sets the cursor at the character pointed to. Actually, it is the place you
103 are pointing at when you release the button that counts.
104 .TP 5
105 MIDDLE
106 Sets the
107 .I mark
108 at the character pointed to when you press it. You may then
109 move to another point before releasing it, thus delineating the
110 .I region
111 from where you pressed to where you released. The position of the mark always
112 remains underlined (not easy to see if the cursor is at the same place).
113 .TP 5
114 MIDDLE + CTRL
115 Sets the region as before, but then does a COPY (copy-region).
116 .TP 5
117 MIDDLE + CTRL + SHIFT
118 Sets the region as before, but then does a CUT (kill-region).
119 .TP 5
120 LEFT + CTRL
121 Sets the cursor as before, but then does a PASTE (yank). This can be used
122 in conjunction with the previous two commands so as to copy or move text from
123 one place to another. However, the following two commands do this job better.
124 .TP 5
125 MIDDLE + PASTE
126 Remembers the current position of the cursor, then does a COPY (copy-region)
127 on the region you select (possibly in another window), and finally
128 PASTEs (yanks) it at the remembered position.
129 .TP 5
130 MIDDLE + CUT
131 Remembers the current position of the cursor, then does a CUT (kill-region)
132 on the region you select (possibly in another window), and finally
133 PASTEs (yanks) it at the remembered position.
134 .TP 10
135 Multiple clicks on MIDDLE
136 In all the above usages of MIDDLE, a double click will set the
137 .I mark
138 at the start of the word pointed into and the
139 .I point
140 at the end of that word. Likewise, a triple click selects the whole of the
141 current line. This is similar to the effects of multiple
142 clicks in Open-Look windows and Sunview.
143 .PP
144 Note that the above commands only work if you point within the current
145 window. Except when in conjunction with PASTE or CUT, the first click into a
146 different window simply selects that other window. Click twice if you want
147 to set the cursor or the mark in the other window.
148 .TP 5
149 LEFT when in the Modeline
150 Assuming the variable scroll-bar is ON, the position of the window
151 within the overall buffer is shown by unhighlighting the corresponding
152 part of the Modeline. Pointing at a place in the Modeline and pressing
153 either of LEFT or MIDDLE causes the text to scroll to that place. You
154 may hold the button down and move the mouse left or right until you see
155 what you want in the window.
156 .TP 5
157 RIGHT
158 Brings up a menu with pull-right options enabling you to obey any JOVE
159 command, or set any JOVE variable. If the command requires a parameter (or
160 the variable requires a value other than ON/OFF), you still have to type it
161 in as usual.
162 .TP 5
163 SHIFT
164 Holding SHIFT down at the same time as any other key or mouse operation
165 (except with CTRL \(em see above) reverts to the normal behaviour of
166 .IR Shelltool(1) .
167 Thus you can make selections, and copy and paste them to/from the
168 clipboard using L6, L8 and L10.
169 .SH OPERATION
170 JOVE will automatically load the file
171 .IR jove.rc.$TERM .
172 It is therefore necessary that this file understands the code sequences that
173 are produced when function keys are pressed in Xjove (these are not
174 necessarily the same as might normally be produced by that $TERM). These
175 follow, more or less, the practice of Sun Workstations (with the addition,
176 except when SHIFT is down, of some keys such as L-1,6,8,9 and 10 which
177 Shelltool usually reserves for its own purposes, and of the KP-* keys around
178 the outside of the numeric keypad, such as KP_Add and KP_Enter).
179 .PP
180 In addition,
181 .I Xjove
182 sets the environment variable
183 .I IN_JOVETOOL
184 .B "= 't'" ,
185 so that applications running in an Xjove window can be aware of the fact.
186 .PP
187 Mouse buttons are encoded as `^Xm[0-9](c x y t)\\n'. ^Xm is the
188 JOVE mouse-command prefix, [0-9] indicate which key was pressed, and
189 whether it was a down, up, drag or multi-click event. These are
190 followed by a list indicating the state of CTRL, SHIFT, PASTE and CUT, the
191 character row and column of the point in the window where the mouse
192 cursor is, and the number of pixels in the width of a character. In
193 JOVE, these ^Xm* dispatch to appropriate mouse-command handlers which
194 then read the following list.
195 .SH BUGS
196 The normal Sunview "selection" facilities that enable text to be Cut and
197 Pasted between windows (as provided by Shelltool and Cmdtool) only work
198 when SHIFT is pressed.
199 .br
200 Because SHIFT and CTRL together have a special meaning, it is not possible
201 under SunView to make a selection "Pending Delete".
202 .br
203 Due to a bug in some versions of XView, the underlining of the mark may
204 not occur (but emboldening may be used as an alternative).
205 .br
206 Under SunView, the initial terminal settings for the tty window are
207 apparently taken from the controling tty. This can lead to
208 surprises.
209 .SH "ENVIRONMENT VARIABLES"
210 .I "JOVETOOL IN_JOVETOOL TERM"
211 .br
212 For Xjove, the XView shared library must be visible. It may therefore
213 be necessary to arrange for the Environment Variable LD_LIBRARY_PATH to
214 include $OPENWINHOME/lib, where $OPENWINHOME would usually be
215 /usr/openwin.
216 .SH "SEE ALSO"
217 .I jove(1)