1\variable{BLINK}
2\synopsis{Set whether or not parentheses will be blinked}
3\usage{Int_Type BLINK}
4\description
5  The \var{BLINK} variable controls whether or not matching
6  parenthesis are blinked upon the insertion of a closing parenthesis.
7  If its value is non-zero, the matching parenthesis will be blinked;
8  otherwise, it will not.
9\done
10
11\variable{DISPLAY_EIGHT_BIT}
12\synopsis{Set the display mode for eight-bit characters}
13\usage{Int_Type DISPLAY_EIGHT_BIT}
14\description
15 This variable determines how characters with the high bit set are to
16 be displayed.  Specifically, any character whose value is greater than
17 or equal to the value of \var{DISPLAY_EIGHT_BIT} is output to the terminal
18 as is.  Characters with the high bit set but less than this value are
19 sent to the terminal in a multiple character representation. For Unix
20 and VMS systems the value should be set to 160.  This is because many
21 terminals use the characters with values between 128 and 160 as eight
22 bit control characters.  For other systems, it can be set to zero.
23\seealso{META_CHAR}
24\done
25
26\variable{DISPLAY_TIME}
27\synopsis{Control the display of the current time}
28\usage{Int_Type DISPLAY_TIME}
29\description
30 If this variable is non-zero, the current time will be displayed on the
31 status line if the format for the status line permits it.  If it is zero,
32 the time will not be displayed even if the \exmp{%t} format string is part
33 of the status line format.
34\seealso{set_status_line}
35\done
36
37\variable{DOLLAR_CHARACTER}
38\synopsis{The line continuation character}
39\usage{Int_Type DOLLAR_CHARACTER = '$'}
40\description
41  The character represented by \var{DOLLAR_CHARACTER} is used to
42  indicate that text extends beyond the borders of the window.  This
43  character is traditionally a dollar sign.  If the value of
44  \var{DOLLAR_CHARACTER} is 0, no character will be used for this
45  indicator.
46\seealso{set_color}
47\done
48
49\variable{HIGHLIGHT}
50\synopsis{Turn on/off region highlighting}
51\usage{Int_Type HIGHLIGHT}
52\description
53  If this variable is non-zero, marked regions will be highlighted.
54\seealso{WANT_SYNTAX_HIGHLIGHT, set_color}
55\done
56
57\variable{HORIZONTAL_PAN}
58\synopsis{Set the horizontal panning mode}
59\usage{Int_Type HORIZONTAL_PAN}
60\description
61  If the value of this variable is non-zero, the window wil pan when
62  the cursor goes outside the border of the window.  More precisely,
63  if the value is less than zero, the entire window will pan.  If the
64  value is positive, only the current line will pan.  The
65  absolute value of the number determines the panning increment.
66\seealso{SCREEN_WIDTH}
67\done
68
69\variable{LINENUMBERS}
70\synopsis{Enable the display of line or column numbers}
71\usage{Int_Type LINENUMBERS}
72\description
73  The \var{LINENUMBERS} variable determines whether or not line or
74  column numbers will be displayed on the status line.  If the value
75  of \var{LINENUMBERS} is \0, then neither the line nor column number
76  information will be displayed.  If \var{LINENUMBERS} is set to \1,
77  then the current line number will be displayed but column numbers
78  will not be.  If \var{LINENUMBERS} is \2, the both line a column
79  numbers will be displayed.
80\seealso{set_status_line}
81\done
82
83\variable{Simulate_Graphic_Chars}
84\synopsis{Specifies whether or not graphic characters are to be used}
85\usage{Int_Type Simulate_Graphic_Chars}
86\description
87  If the value of this variable is non-zero, graphic characters will
88  be simulated by simple ascii characters instead of trying to use the
89  terminal's alternate character set.
90\notes
91  This variable is not available on all platforms.
92\done
93
94\variable{Status_Line_String}
95\synopsis{The string used for the status line}
96\usage{String_Type Status_Line_String}
97\description
98 \var{Status_Line_String} is a read-only string variable that
99 specifies the format of the status line for newly created buffers.
100 To set the status line format, use the function \var{set_status_line}.
101\seealso{set_status_line}
102\done
103
104\variable{TAB}
105\synopsis{Set the current buffer TAB width}
106\usage{Int_Type TAB}
107\description
108 This variable controls the tab width associated with the current
109 buffer.  A value of zero means that tab characters are not expanded
110 and that tabs are never used to produce whitespace.
111\seealso{TAB_DEFAULT, USE_TABS}
112\done
113
114\variable{TAB_DEFAULT}
115\synopsis{Set the default tab width}
116\usage{Int_Type TAB_DEFAULT}
117\description
118 The value of \var{TAB_DEFAULT} is the default tab setting given to
119 all newly created buffers.  A value of zero means that tab characters
120 are not expanded and that tabs are never used to produce whitespace.
121\notes
122 A related variable \var{TAB} may be used to change the current
123 buffer's tab setting.
124\seealso{TAB, USE_TABS, TAB_DEFAULT}
125\done
126
127\variable{TOP_WINDOW_ROW}
128\synopsis{Top window's starting row}
129\usage{Int_Type}
130\description
131 This read-only variable gives the value of the starting row of the top
132 window.  If a menubar is present, the value will be \2, otherwise it
133 will be \1.
134\seealso{enable_top_status_line, window_info}
135\done
136
137\variable{WANT_EOB}
138\synopsis{Control the display of the end of buffer indicator}
139\usage{Int_Type}
140\description
141 If this value of this variable is non-zero, the end of buffer
142 indicator \exmp{"[EOB]"} will be displayed at the end of the buffer.  Such
143 an indicator is used for various editor emulations such as the
144 VAX/VMS EDT editor.
145\done
146
147\variable{WANT_SYNTAX_HIGHLIGHT}
148\synopsis{Enable or disable syntax highlighting}
149\usage{Int_Type WANT_SYNTAX_HIGHLIGHT}
150\description
151  If the value of this variable is non-zero, syntax highlighting will
152  be enabled.  Otherwise, syntax highlighting will be turned off.
153\seealso{HIGHLIGHT, set_color}
154\done
155
156\function{blink_match}
157\synopsis{Blink the matching delimiter}
158\usage{Void blink_match ();}
159\description
160  This function will attempt to blink the matching delimiter immediately
161  before the editing point.
162\seealso{find_matching_delimiter, define_syntax}
163\done
164
165\function{enlargewin}
166\synopsis{Increase the size of the current window}
167\usage{Void enlargewin ()}
168\description
169  This function increases the size of the current window by one line by
170  adjusting the size of the other windows accordingly.
171\seealso{window_info, onewindow}
172\done
173
174\function{nwindows}
175\synopsis{Return the number of windows currently visible}
176\usage{Integer nwindows ();}
177\description
178  The \var{nwindows} function returns the number of windows currently visible.
179  If the variable \var{MINIBUFFER_ACTIVE} is non-zero, the minibuffer is busy and
180  contributes to the number of windows.
181\seealso{splitwindow, onewindow, window_size}
182\seealso{MINIBUFFER_ACTIVE}
183\done
184
185\function{onewindow}
186\synopsis{Make current window the only one}
187\usage{Void onewindow ();}
188\description
189  This function deletes all other windows except the current window and
190  the mini-buffer window.
191\seealso{nwindows, splitwindow, enlargewin}
192\seealso{MINIBUFFER_ACTIVE}
193\done
194
195\function{otherwindow}
196\synopsis{Make the next window the default window}
197\usage{Void otherwindow ()}
198\description
199  This function will make the next window in the ring of windows as the
200  default window. For example,
201#v+
202        define zoom_next_window ()
203        {
204          otherwindow (); onewindow ();
205        }
206#v-
207  defines a function that moves to the next window and then makes it the
208  only window on the screen.
209\seealso{nwindows, onewindow}
210\seealso{MINIBUFFER_ACTIVE}
211\done
212
213\function{recenter}
214\synopsis{Scroll the window to make the "nth" line contain the current line}
215\usage{Void recenter (Integer nth);}
216\description
217  This function may be used to scroll the window such that the \var{nth} line
218  of the window contains the current line.  If \var{nth} is zero, the current
219  line will be placed at the center of the window and the screen will be
220  completely redrawn.
221\seealso{nwindows, window_info}
222\done
223
224\function{set_status_line}
225\synopsis{Customize the status line of the current window}
226\usage{set_status_line (String format, Integer flag)}
227\description
228  This function may be used to customize the status line of the current
229  window according to the string \var{format}.  If the second parameter
230  \var{flag} is non-zero, \var{format} will apply to the global format string;
231  otherwise it applies to current buffer only.  Newly created buffer
232  inherit the global format string when they appear in a window.
233  The format string may contain the following format specifiers:
234#v+
235        %b   buffer name
236        %f   file name (without the directory part)
237        %F   file name with directory
238        %v   JED version
239        %t   current time --- only used if variable DISPLAY_TIME is non-zero
240        %p   line number or percent string. If LINENUMBERS is 2, this
241              expands to "line number,column number"
242        %c   column number
243        %%   literal '%' character
244        %m   mode string
245        %a   If abbrev mode, expands to "abbrev"
246        %n   If buffer is narrowed, expands to "Narrow"
247        %o   If overwrite mode, expands to "Ovwrt"
248        %O   Overwrite/Insert flag - like %o, but shows INS/OVR
249        %l   Shows current line number
250        %L   Shows number of lines in the file
251#v-
252  For example, the default status line used by JED's EDT emulation uses
253  the format string:
254#v+
255        "(Jed %v) EDT: %b   (%m%a%n%o)  %p,%c   Advance   %t"
256#v-
257\seealso{set_mode, narrow, whatbuf, getbuf_info}
258\seealso{DISPLAY_TIME,LINENUMBERS, Global_Top_Status_Line, Status_Line_String}
259\done
260
261\function{splitwindow}
262\synopsis{Split the current window vertically}
263\usage{Void splitwindow ();}
264\description
265  This function splits the current window vertically creating another
266  window that carries the current window's buffer.
267\seealso{onewindow, enlargewin, window_info}
268\done
269
270\function{update}
271\synopsis{Update the display}
272\usage{Void update (Integer f);}
273\description
274  This function may be called to update the display.  If the parameter
275  \var{f} is non-zero, the display will be updated even if there is input
276  pending.  If \var{f} is zero, the display may only be partially updated if
277  input is pending.
278\seealso{input_pending, flush}
279\done
280
281\function{update_sans_update_hook}
282\synopsis{Update the display without running the update hooks}
283\usage{update_sans_update_hook (Int_Type force)}
284\description
285  The \var{update_sans_update_hook} function performs the same
286  function as \var{update}, except that the buffer's update hook will
287  not be run.  See \var{update} for more information.
288\seealso{update, set_buffer_hook, unset_buffer_hook}
289\done
290
291\function{w132}
292\synopsis{Set the number of columns on a vtxxx compatable terminal to 132.}
293\usage{Void w132 ()}
294\description
295  This function may be used to set the number of columns on a vtxxx
296  compatable terminal to 132.
297\seealso{w80, set_term_vtxxx}
298\done
299
300\function{w80}
301\synopsis{Set the number of columns on a vtxxx compatable terminal to 80}
302\usage{Void w80 ()}
303\description
304  This function may be used to set the number of columns on a vtxxx
305  compatable terminal to 80.
306\seealso{w132, set_term_vtxxx}
307\done
308
309\function{window_info}
310\synopsis{Return information concerning the current window}
311\usage{Integer window_info(Integer item);}
312\description
313  The \var{window_info} function returns information concerning the current
314  window.  The actual information that is returned depends on the \var{item}
315  parameter.  Acceptable values of \var{item} and the description of the
316  information returned is given in the following table:
317#v+
318        'r'  : Number of rows
319        'w'  : Width of window
320        'c'  : Starting column (from 1)
321        't'  : Screen line of top line of window (from 1)
322#v-
323\seealso{otherwindow, nwindows}
324\seealso{SCREEN_HEIGHT,SCREEN_WIDTH}
325\done
326
327\function{window_line}
328\synopsis{Return the number of rows from the top of the window}
329\usage{Integer window_line ();}
330\description
331  This function returns the number of rows from the top of the current
332  window for the current line.  If the current line is the very first line
333  in the window, a value of \var{1} will be returned, i.e., it is the first
334  line of the window.
335\seealso{window_info, nwindows}
336\seealso{TOP_WINDOW_ROW}
337\done
338
339\function{get_scroll_column}
340\synopsis{Get the scroll column for the current window}
341\usage{Int_Type get_scroll_column ()}
342\description
343 This function returns the scroll column for the current window.
344\seealso{set_scroll_column}
345\done
346
347\function{set_scroll_column}
348\synopsis{Set the scroll column for the current window}
349\usage{set_scroll_column (Int_Type col)}
350\description
351 This function may be used to set the scroll column of the current
352 window.
353\seealso{get_scroll_column}
354\done
355