Description: Documentation

## variable BLINK

### Synopsis

Set whether or not parentheses will be blinked

### Usage

Int_Type BLINK

### Description

The BLINK variable controls whether or not matching parenthesis are blinked upon the insertion of a closing parenthesis. If its value is non-zero, the matching parenthesis will be blinked; otherwise, it will not.

## variable DISPLAY_EIGHT_BIT

### Synopsis

Set the display mode for eight-bit characters

### Usage

Int_Type DISPLAY_EIGHT_BIT

### Description

This variable determines how characters with the high bit set are to be displayed. Specifically, any character whose value is greater than or equal to the value of DISPLAY_EIGHT_BIT is output to the terminal as is. Characters with the high bit set but less than this value are sent to the terminal in a multiple character representation. For Unix and VMS systems the value should be set to 160. This is because many terminals use the characters with values between 128 and 160 as eight bit control characters. For other systems, it can be set to zero.

### See also

META_CHAR

## variable DISPLAY_TIME

### Synopsis

Control the display of the current time

### Usage

Int_Type DISPLAY_TIME

### Description

If this variable is non-zero, the current time will be displayed on the status line if the format for the status line permits it. If it is zero, the time will not be displayed even if the %t format string is part of the status line format.

### See also

set_status_line

## variable DOLLAR_CHARACTER

### Synopsis

### Usage

Int_Type DOLLAR_CHARACTER = '$'

### Description

The character represented by DOLLAR_CHARACTER is used to indicate that text extends beyond the borders of the window. This character is traditionally a dollar sign. If the value of DOLLAR_CHARACTER is 0, no character will be used for this indicator.

### See also

set_color

## variable HIGHLIGHT

### Synopsis

Turn on or off region highlighting

### Usage

Int_Type HIGHLIGHT

### Description

If this variable is non-zero, marked regions will be highlighted.

### See also

WANT_SYNTAX_HIGHLIGHT , set_color

## variable HORIZONTAL_PAN

### Synopsis

Set the horizontal panning mode

### Usage

Int_Type HORIZONTAL_PAN

### Description

If the value of this variable is non-zero, the window wil pan when the cursor goes outside the border of the window. More precisely, if the value is less than zero, the entire window will pan. If the value is positive, only the current line will pan. The absolute value of the number determines the panning increment.

### See also

SCREEN_WIDTH

## variable LINENUMBERS

### Synopsis

Enable the display of line or column numbers

### Usage

Int_Type LINENUMBERS

### Description

The LINENUMBERS variable determines whether or not line or column numbers will be displayed on the status line. If the value of LINENUMBERS is 0, then neither the line nor column number information will be displayed. If LINENUMBERS is set to 1, then the current line number will be displayed but column numbers will not be. If LINENUMBERS is 2, the both line a column numbers will be displayed.

### See also

set_status_line

## variable LINE_NUMBERS

### Synopsis

Control the display of line and column number information

### Usage

Int_Type LINE_NUMBERS

### Description

If set to 0, line numbers are not displayed on the status line. If set to 1, line numbers will be displayed. If set to anything else, the %c column format specifier will be parsed allowing the column number to be displayed on the screen.

### See also

set_status_line

## variable Simulate_Graphic_Chars

### Synopsis

Specifies whether or not graphic characters are to be used

### Usage

Int_Type Simulate_Graphic_Chars

### Description

If the value of this variable is non-zero, graphic characters will be simulated by simple ascii characters instead of trying to use the terminal's alternate character set.

### Notes

This variable is not available on all platforms.

## variable Status_Line_String

### Synopsis

The string used for the status line

### Usage

String_Type Status_Line_String

### Description

Status_Line_String is a read-only string variable that specifies the format of the status line for newly created buffers. To set the status line format, use the function set_status_line .

### See also

set_status_line

## variable TAB

### Synopsis

Set the current buffer TAB width

### Usage

Int_Type TAB

### Description

This variable controls the tab width associated with the current buffer. A value of zero means that tab characters are not expanded and that tabs are never used to produce whitespace.

### See also

TAB_DEFAULT , USE_TABS

## variable TAB_DEFAULT

### Synopsis

Set the default tab width

### Usage

Int_Type TAB_DEFAULT

### Description

The value of TAB_DEFAULT is the default tab setting given to all newly created buffers. A value of zero means that tab characters are not expanded and that tabs are never used to produce whitespace.

### Notes

A related variable TAB , TAB(1) may be used to change the current buffer's tab setting.

### See also

TAB , TAB(1) , USE_TABS , TAB_DEFAULT

## variable TOP_WINDOW_ROW

### Synopsis

Top window's starting row

### Usage

Int_Type

### Description

This read-only variable gives the value of the starting row of the top window. If a menubar is present, the value will be 2, otherwise it will be 1.

### See also

enable_top_status_line , window_info

## variable WANT_EOB

### Synopsis

Control the display of the end of buffer indicator

### Usage

Int_Type

### Description

If this value of this variable is non-zero, the end of buffer indicator "[EOB]" will be displayed at the end of the buffer. Such an indicator is used for various editor emulations such as the VAX/VMS EDT editor.

## variable WANT_SYNTAX_HIGHLIGHT

### Synopsis

Enable or disable syntax highlighting

### Usage

Int_Type WANT_SYNTAX_HIGHLIGHT

### Description

If the value of this variable is non-zero, syntax highlighting will be enabled. Otherwise, syntax highlighting will be turned off.

### See also

HIGHLIGHT , set_color

## function blink_match

### Synopsis

blink_match

### Usage

Void blink_match ();

### Description

This function will attempt to blink the matching delimiter immediately before the editing point.

### See also

find_matching_delimiter , define_syntax

## function enlargewin

### Synopsis

enlargewin

### Usage

Void enlargewin ();

### Description

This function increases the size of the current window by one line by adjusting the size of the other windows accordingly.

### See also

window_info , onewindow

## function nwindows

### Synopsis

nwindows

### Usage

Integer nwindows ();

### Description

The nwindows function returns the number of windows currently visible. If the variable MINIBUFFER_ACTIVE is non-zero, the minibuffer is busy and contributes to the number of windows.

### See also

splitwindow , onewindow , window_size

### See also

MINIBUFFER_ACTIVE

## function onewindow

### Synopsis

onewindow

### Usage

Void onewindow ();

### Description

This function deletes all other windows except the current window and the mini-buffer window.

### See also

nwindows , splitwindow , enlargewin

### See also

MINIBUFFER_ACTIVE

## function otherwindow

### Synopsis

otherwindow

### Usage

Void otherwindow ();

### Description

This function will make the next window in the ring of windows as the default window. For example,

            define zoom_next_window ()
            {
              otherwindow (); onewindow ();
            }

defines a function that moves to the next window and then makes it the only window on the screen.

### See also

nwindows , onewindow

### See also

MINIBUFFER_ACTIVE

## function recenter

### Synopsis

recenter

### Usage

Void recenter (Integer nth);

### Description

This function may be used to scroll the window such that the nth line of the window contains the current line. If nth is zero, the current line will be placed at the center of the window and the screen will be completely redrawn.

### See also

nwindows , window_info

## function set_status_line

### Synopsis

set_status_line

### Usage

set_status_line (String format, Integer flag);

### Description

This function may be used to customize the status line of the current window according to the string format . If the second parameter flag is non-zero, format will apply to the global format string; otherwise it applies to current buffer only. Newly created buffer inherit the global format string when they appear in a window. The format string may contain the following format specifiers:

            %b   buffer name
            %f   file name
            %v   JED version
            %t   current time --- only used if variable DISPLAY_TIME is non-zero
            %p   line number or percent string
            %%   literal '%' character
            %m   mode string
            %a   If abbrev mode, expands to "abbrev"
            %n   If buffer is narrowed, expands to "Narrow"
            %o   If overwrite mode, expands to "Ovwrt"
            %c   If the variable LINENUMBERS is 2, this expands to the current
                   column number.

For example, the default status line used by JED's EDT emulation uses the format string:

            "(Jed %v) EDT: %b   (%m%a%n%o)  %p,%c   Advance   %t"

### See also

set_mode , narrow , whatbuf , getbuf_info

### See also

DISPLAY_TIME , LINENUMBERS

## function splitwindow

### Synopsis

splitwindow

### Usage

Void splitwindow ();

### Description

This function splits the current window vertically creating another window that carries the current window's buffer.

### See also

onewindow , enlargewin , window_info

## function update

### Synopsis

update

### Usage

Void update (Integer f);

### Description

This function may be called to update the display. If the parameter f is non-zero, the display will be updated even if there is input pending. If f is zero, the display may only be partially updated if input is pending.

### See also

input_pending , flush

## function w132

### Synopsis

w132

### Usage

Void w132 ();

### Description

This function may be used to set the number of columns on a vtxxx compatable terminal to 132.

### See also

w80 , set_term_vtxxx

## function w80

### Synopsis

w80

### Usage

Void w80 ();

### Description

This function may be used to set the number of columns on a vtxxx compatable terminal to 80.

### See also

w132 , set_term_vtxxx

## function window_info

### Synopsis

window_info

### Usage

Integer window_info(Integer item);

### Description

The window_info function returns information concerning the current window. The actual information that is returned depends on the item parameter. Acceptable values of item and the description of the information returned is given in the following table:

            'r'  : Number of rows
            'w'  : Width of window
            'c'  : Starting column (from 1)
            't'  : Screen line of top line of window (from 1)

### See also

otherwindow , nwindows

### See also

SCREEN_HEIGHT , SCREEN_WIDTH

## function window_line

### Synopsis

window_line

### Usage

Integer window_line ();

### Description

This function returns the number of rows from the top of the current window for the current line. If the current line is the very first line in the window, a value of 1 will be returned, i.e., it is the first line of the window.

### See also

window_info , nwindows

### See also

TOP_WINDOW_ROW