[index (frame version)] [index (text version)]
UNI-XEDIT VERSION 2.01 August 21, 1996
uni-Xedit (xe) has been upgraded from version 1.32 to version 2.01.
Parts
of the README file supplied with the software have been included
in this
document for your reference.
The 'help' file can be accessed by pressing PF1 while you are in
xe.
Highlights
----------
- POWerinput now works correctly.
- If you have a graphical screen, uni-Xedit will use the new graphical
user interface (GUI) by default. If you have a graphical
screen but do
NOT wish to use the uniXedit GUI, set the CHARACTER mode option
on your
command line i.e.
xe -C filename
- There is a new .profile.xedit file which will automatically be
copied to
your home directory. If you have previously updated
the default
.profile.xedit file which was supplied with uniXedit Version 1.32,
you
will be asked to apply your local modifications to the new .profile.xedit
file in your home directory. Your old .profile.xedit file
will have been
renamed to .profile.xedit.pbak2 for your reference.
If your .profile.xedit file is updated, you will see the following
message:
The default uni-XEDIT profile has changed. Your previous profile
has
been saved in .profile.xedit.pbak2. Please re-key any local
changes you
have made to your profile.
Press RETURN to continue...
________________________________________________________________________________
Extracts from the README file supplied by the vendor now follow.
The Workstation Group -- uni-XEDIT
readme file -- 19 February 1996
uni-XEDIT is a UNIX version of IBM's XEDIT editor, part of the VM/CMS
mainframe
operating system. It provides a very easy to use fullscreen
editing function,
which can replace VI. Besides the extensive features available
in its mainframe
counterpart, Version 2 includes a graphical user interface to further
enhance
user productivity. Users may customize the editor to their
personal preferences
by writing macros that tailor the initial display, modify PF key
definitions,
establish keyboard mappings for specific terminals, or define synonyms
for editor
commands.
uni-XEDIT Extended includes an embedded Rexx interpreter which provides
the
ability to write complex editor macros. Such macros can automate
routine tasks,
extend the editor's command set, customize command or keystroke
behaviors, or
implement end-user applications using the SET RESERVED and READ
commands. The
uni-XEDIT V2.01
________________________________________________________________________________
uni-XEDIT 2.01 NOTES
This section contains information specific to Version 2.01 of uni-XEDIT.
It covers enhancements or modifications implemented after the documentation
was printed and special items of interest.
_______________________________________________________________________
1. Recent Enhancements:
The following enhancements are included in uni-XEDIT
V2.01 but
are not yet included in the reference manual.
QUERY/EXTRACT RING
The RING option of QUERY and EXTRACT allows you
to determine the
number and names of files currently in the edit
ring. QUERY RING is
normally used from the command line. EXTRACT
RING is intended for
use in macros.
QUERY RING displays a multi-line message. The
first line indicates
the number of files in the ring. Subsequent
lines provide data about
each file.
Query RING
Output is in the following form:
530i n file(s) in storage
filename DATA A1 V lrecl
Trunc=q Size=r Line=s Col=t Alt=u
where "n" in the first line is the number of
files in the ring. The
second line is repeated for each file in the
ring. For each of these
subsequent lines,
filename name of the file
DATA
filetype, filemode and record format strings
A1
provided for compatibility with macros ported
V
from the mainframe
lrecl
current value of LRECL setting
q
current TRUNC setting
r
number of lines in the file
s
current line
t
current column position
u
number of changes to file since last SAVE or AUTOSAVE
Use EXTRACT /RING to return the number of files
in the ring and data
about each file.
EXTRACT /RING
The following variables are returned:
RING.0
number of variables returned
RING.1
number of files currently in the ring
RING.2
descriptor line for 1st file
RING.3
descriptor line for 2nd file
:
:
:
:
RING.n
descriptor line for last file
Descriptor lines are of the form
filename DATA A1 V lrecl Trunc=q Size=r Line=s Col=t Alt=u
filename name of the file
DATA
filetype, filemode and record format strings
A1
provided for compatibility with macros ported
V
from the mainframe
lrecl
current value of LRECL setting
q
current TRUNC setting
r
number of lines in the file
s
current line
t
current column position
u
number of changes to file since last SAVE or AUTOSAVE
SET/QUERY/EXTRACT DISPLAY
The DISPLAY option of SET, QUERY, and EXTRACT
is related to the selection
level of lines to be displayed. The selection
level is a positive
number assigned to lines within a file using
the SET SELECT command.
SET DISPLAY causes the editor to display a given
selection level or a
range of levels. Lines with selection
levels outside the specified level
or range do not appear on the screen.
SET DISPLAY is used in conjunction
with SET SELECT, SET SCOPE, and SET SHADOW.
Use SET DISPLAY to control the lines that appear on the screen.
[SET] DISPlay n1 [n2]
Initial Default: DISPLAY 0 0
n1
is the selection level of lines that are to be displayed
on the screen. If "n2" is omitted, only lines with selection
level of "n1" are displayed.
n2
is a selection level of lines to be displayed. If "n2" is specified,
"n1" and "n2" define a range of selection levels to display.
"n2" must be greater than or equal to "n1". If "n2" is specified
as
"*", all lines with selection levels greater than "n1" are displayed.
Use QUERY DISPLAY to determine the current range
of selection levels for
displayed lines.
Query DISPlay
Output appears on the message line in the form
DISPLAY n1 n2
Use EXTRACT /DISPLAY to return the current selection
level display
settings in variables DISPLAY.0 through DISPLAY.2.
EXTRACT /DISPLAY
The following variables are returned:
DISPLAY.0
2
DISPLAY.1
lowest selection level in the display
DISPLAY.2
highest selection level in the display
SET/QUERY/EXTRACT SELECT
The SELECT option of SET, QUERY, and EXTRACT
is related to assigning
the selection level of lines within a file.
Selection level is specified
as a positive number, and a line may have only
one selection level. This
allows for logical grouping of lines within
a file. SET SELECT is used
in conjunction with SET DISPLAY, SET SCOPE,
and SET SHADOW.
Use SET SELECT to assign selection levels to specified lines.
[SET] SELect [+] n [target]
[-]
Initial Default: All
lines are set to selection level 0 (zero).
n
is a positive number that indicates the selection level to
be assigned. When the optional sign is omitted, "n" is an
absolute selection level.
+/- optional
sign used to modify the current selection level of
specified lines. When "+" is used, "n" is added to the current
selection level to assign a new selection level. When "-" is
used, "n" is subtracted from the current selection level.
target optionally defines the
range of lines for this selection level.
The level is assigned to all lines beginning with the current line
up to, but not including the line identified by "target". If
"target" is omitted, the default is the current line. If "target"
is specified as "*", the range of lines extends from the current
line through the end of file.
Use QUERY SELECT to display the selection level
for the current line,
as well as the maximum selection level assigned
within the file.
Query SELECT
Output appears on the message line in the form
SELECT n1 n2
n1 is the selection level assigned to the current line
n2 is the
maximum selection level assigned in the file
Use EXTRACT /SELECT to return the current selection
level settings
in variables SELECT.0 through SELECT.2
EXTRACT /SELECT
The following variables are returned:
SELECT.0
2
SELECT.1
is the selection level assigned to the current line
SELECT.2
is the maximum selection level within the file
QUERY LINE
QUERY LINE displays the current line number.
Query LINE
Output appears on the message line in the form
LINE n
where "n" is the current line number
EXTRACT FLSCREEN
The FLSCREEN option of EXTRACT returns the line
numbers of
the first and last lines of data that appear
on the screen.
EXTRACT /FLSCREEN
The following variables are returned:
FLSCREEN.0
2
FLSCREEN.1
line number in file of first line displayed
FLSCREEN.2
line number in file of last line displayed
SET/QUERY/EXTRACT/MASK
The MASK option of SET, QUERY, and EXTRACT provides
a way to set the
default mask value. Whenever a new
line is inserted, added, or
replaced, the line is pre-filled with the current
MASK value. If the
mask is not set by the user, then the default
is blanks. QUERY MASK
and EXTRACT MASK provide information about the
current mask setting.
QUERY MASK is normally used from the command
line. EXTRACT MASK is
intended for use in macros.
Use SET MASK to set the default MASK.
[SET] MASK Define
Immed [text]
Modify
Initial Default: blanks
Define allows the user to define
a new mask by over-typing a template on
the command line. The template is a scale line to assist you with
column alignment. When you finish typing the mask, save it by
pressing Enter.
Immed [text]
allows the user to set the mask value with a single command.
The [text] operand is optional. If specified, the mask value is set
set to [text]. If omitted, the mask value is set to blanks.
Modify allows the user to modify
the existing mask value on the command line.
SET MASK M places the current mask on the command line, rather than the
default template. When you finish modifying the mask, save it by
pressing Enter.
Use QUERY MASK to display the current mask setting.
Query MASK
Output appears on the message line in the form
MASK mask_value
where "mask_value" is the current mask value.
Use EXTRACT /MASK to return the current MASK
value in variables
MASK.0 through MASK.1.
EXTRACT /MASK
The following variables are returned:
MASK.0
1
MASK.1
current mask setting
QUERY/EXTRACT NBFILE
The NBFILE option of QUERY and EXTRACT provides
information
on the number of files currently in the edit
ring.
Use QUERY NBFILE to display the number of files in edit ring.
Query NBFILE
Output appears on the message line in the form
NBFILE n
where "n" is the number of files in the edit
ring.
Use EXTRACT /NBFILE to return the number of files
in the edit
ring in variables NBFILE.0 through NBFILE.1.
EXTRACT /NBFILE
The following variables are returned:
NBFILE.0
1
NBFILE.1
the number of files within edit ring.
POWERINPut
POWERINPut provides a "heads-down" input facility
that automatically
reformats the data when you press enter. Words
that span line
boundaries are moved to the beginning of the
next line and subsequent
data is shifted forward in the file. This
is similar to the
automatic reformatting provided by most word
processing software.
POWERINP
Entering POWERINPut mode causes the same screen
changes as entering
Input mode. Function keys and the Enter
key also behave as in Input
mode. The only difference is that POWERINPut
automatically reformats
lines when you exit POWERINPut mode.
System Wide Profile
The system-wide profile allows the system administrator
to provide
a centrally located system profile that is automatically
executed
for users who do not have a user profile in
their HOME directory.
When an edit session is started, the editor
first searches for a user
profile. If this exists in the user's
HOME directory, it is used.
If no user profile is found, the editor searches
for a system profile.
The system profile must be located in the same
directory as the
uni-XEDIT executable binary. If neither
a user profile nor a system
profile can be located, the edit session is
started with no profile.
EXTRACT CURSOR Enhancements
The CURSOR option of EXTRACT now returns all
nine variables. The
variables added in this release are:
CURSOR.5
original screen line position (the original CURSOR.1)
CURSOR.6
original screen column position (the original CURSOR.2)
CURSOR.7
original file line position (the original CURSOR.3)
CURSOR.8
original file column position (the original CURSOR.4)
CURSOR.9
the highest cursor priority
SOS Commands
SOS commands provide a set of high level functions
designed to be
used within macros or assigned to PF keys.
SOS option
Option may be any of the following keywords:
Alarm
LINEDel PF n
TABB [n] TABCMDF
CLEAR
NUlls [ON] POP
TABCmd TABF [n]
LINEAdd
[OFF] PUsh TABCMDB
Alarm
generates an alarm
the next time the screen is refreshed
CLEAR
clears the logical
screen
LINEAdd
adds a blank line
after the line where the cursor is
positioned
LINEDel
Deletes the line
where the cursor is positioned
NUlls [ON]
[OFF]
specifies whether
trailing blanks on each line are displayed
as spaces (hexadecimal
20) or as nulls (hexadecimal 00). Currently,
this option has
no effect on the editor.
PF n
causes any data
or commands assigned to PF(n) to be placed
onto the program
stack
POP
removes the top
entry from the cursor stack and places the
cursor there.
If the resulting cursor position would be outside
the logical screen,
then the cursor is positioned in the upper
left position
of the current logical screen.
PUsh
saves the current
cursor position by placing it on the top
of the cursor
stack in LIFO order
TABB [n]
moves the cursor
to the previous tab position relative to the
current cursor
position. The operand "n" is optional. If
specified, it
must be positive number and defines the number
of tab positions
to move. If "n" is omitted, the default value
is 1.
TABCmd
moves the cursor
to the command line of the current logical screen
TABCMDB
moves the cursor
to the command line of the previous logical screen
TABCMDF
moves the cursor
to the command line of the next logical screen
TABF [n]
moves the cursor
to the next tab position relative to the
current cursor
position. The operand "n" is optional. If
specified, it
must be positive number and defines the number
of tab positions
to move. If "n" is omitted, the default value
is 1.
CMSG Command
The CMSG command is similar to the MSG command,
except that CMSG
places the message on the command line instead
of the message line.
This allows you to display messages even when
MSGLINE is set off. Np
alarm is generated.
CMSG [text]
The text operand is optional. If text is
specified, the contents of
text is placed on the command line, then the
cursor is positioned one
space to the right of the text. If text
is omitted, the command line
is cleared, and the cursor is positioned on
the first column of the
command line.
Support for LRECL of 4096
uni-Xedit now permits specification of logical
record length up to
4096. The default LRECL setting is 256,
but the value may be increased
using SET LRECL up to a maximum of 4096.
Enhanced file protection
uni-XEDIT 2.01 offers enhanced protection against
file truncation
when saving a file to a full file system.
During a FILE or SAVE operation, uni-XEDIT protects
your edits
by copying your current edit session to a temporary
file, then
moving the temporary file to your original data
file. In the
event that the temporary file cannot be moved
due to a
file-system-full condition, a message is displayed,
indicating
the problem and the location of the preserved
edit file.
In the event the temporary file cannot be created,
the user may
issue the FFILE or SSAVE command to bypass the
file protection
mechanism.
The environment variable XETEMP is used by uni-XEDIT
to fine tune
your level of protection and works as follows:
- When XETEMP is not defined
(default behavior), uni-XEDIT
writes the temporary
file in the same directory as your
edit file.
- When XETEMP is set to a fully
qualified directory,
uni-XEDIT writes
the temporary file to this directory.
- When XETEMP is set to "NOTEMP"
(upper case), uni-XEDIT
disables file
protection; no temporary file is created and
all edits are
written to the original file.
For the best protection, we recommend setting
XETEMP to a directory
that exists in a file system other than your
edit file. Make
sure this directory has write permission for
all users and
enough space for your largest edit file.
Good protection is provided when XETEMP is not
set (the default
behavior). This causes the temporary file
to be written to the
same file system as your edit file. If a file-system-full
condition
arises, it is possible that the temporary file
cannot be created.
In this case, the user is notified of the problem,
and may use
FFILE or SSAVE to bypass the file protection
mechanism.
The greatest exposure occurs when XETEMP is set
to "NOTEMP". This
effectively disables the file protection mechanism.
CMS/ The CMS/SHELL/! commands
have been enhanced to provide
SHELL/! improved interaction with the user's
native shell. Shell
commands commands (operating system commands) may be
executed in
(revised) two different ways:
- immediate execution of a single shell command
- temporary access to the user's native shell
for execution of one or more shell commands
Both
options are available regardless of the uni-XEDIT
command
(CMS, SHELL, or !) you choose.
SHELL [string]
CMS
!
The
[string] operand may be any valid Unix command; if
specified,
uni-XEDIT routes the Unix command to the user's
native
shell as defined by their SHELL environment variable.
If
the SHELL environment variable is not defined, the Unix
command
is routed to the Bourne Shell.
How
the results are displayed is dependent upon the
operating
mode. In graphical mode, shell command output
is
displayed in a separate terminal window. In character
mode,
shell command output is displayed at the bottom of
your
edit window, scrolling your edit session upwards.
In
either edit mode, you may return to your edit session by
pressing
the enter key.
When
[string] is omitted, uni-XEDIT temporarily suspends
your
edit session and places you into an interactive shell
session.
In graphical mode, a native shell session is opened
in
a separate terminal window, allowing you to execute multiple
shell
commands. In character mode, your edit session is
replaced
with a native shell window, allowing you to execute
multiple
shell commands. In graphical mode, you may return to
the
edit session by closing the shell window or by executing
the
EXIT command. In character mode, you may return to the
edit
session by executing the EXIT command.
COPY The COPY command syntax
has been extended to allow a text
Command selection to be copied to the clipboard
in addition to
(revised) copying line(s) to locations within the file.
As a result,
the
syntax of COPY has changed to work without operands as
specified
below.
COpy [target-1 target-2]
If
COPY is specified with no operands, the current text
selection
is copied to one of two different clipoards. In
character
mode, COPY copies the current text selection to an
internal
simulated clipboard. In graphical mode, COPY copies
the
current text selection to the window manager clipboard.
When
COPY is specified with target operands, it behaves
as
currently described in the "uni-XEDIT Reference Manual".
SET The SET KEYBIND command
has been extended to allow mode-
KEYBIND specific keybind settings. The
SET KEYBIND syntax now
(revised) includes a mode-specific flag that specifies the
editor
operating
mode. The new syntax is
[SET] KEYBind [mode] sequence KEY keyname
curses-name COMMAND command
[mode]
must be specified as "G" or "C". If [mode] is
specified
as "C", the keybind is effective in character
mode
only. If [mode] is specified as "G", the keybind
is
effective in graphical mode only. If [mode] is
omitted,
the keybind is effective in both character and
graphical
modes.
EXTRACT EXTRACT /UIMODE returns the current editor
operation
UIMODE mode in variables UIMODE.0 through
UIMODE.1.
EXTRACT /UIMODE
The following variables are returned:
UIMODE.0 1
UIMODE.1 The editor operating
mode . When in
character mode, UIMODE.1 is set to
"CHARACTER". When in graphical mode,
UIMODE.1 is set to "GRAPHICAL".
SET The NONDISP option
assigns a display character that appears
QUERY in place of non-display characters.
EXTRACT
NONDISP
Use SET NONDISP to set the display character.
[SET] NONDisp [char]
Initial Default: '"'
[char]
is any displayable character. If [char] is omitted,
NONDISP
is set to blank space.
Use QUERY NONDISP to display the current NONDISP setting.
Query NONDisp
Output appears on the message line in the form
NONDISP char
where
[char] is the current NONDISP character.
Use
EXTRACT /NONDISP to return the current NONDISP setting
in
variables NONDISP.0 through NONDISP.1
EXTRACT /NONDISP
The following variables are returned:
NONDISP.0 1
NONDISP.1 current NONDISP setting
SET The SYNCSCROLL option
controls vertical and horizontal
QUERY synchronized scrolling.
When two or more split screens
EXTRACT are displayed, synchronized scrolling
allows scroll
SYNCSCROLL operations in one display to be reflected in all
remaining
displays.
[SET] SYNCscroll ON [V]
OFF [H]
[V H]
Initial Default: ON V H
V specifies
the vertical scroll component. H specifies the
horizontal
scroll component. If SYNCSCROLL ON or SYNCSCROLL
OFF
is specified with no other options, then both H and V
are
set.
In
both graphical mode and character mode, synchronized
scrolling
occurs in response to the following scrolling
commands:
UP, DOWN, LEFT, RIGHT, NEXT, BACK, and FORWARD
Note:
The TOP and BOTTOM commands do not affect synchronized
scrolling.
Additionally,
graphical mode provides synchronized
scrolling
in response to scroll bar movement.
QUERY
SYNCSCROLL displays the current synchronized
scroll
settings.
Query SYNCscroll
Output appears on the message line in the form
SYNCSROLL H=ON V=ON
OFF OFF
H and
V represent the horizontal and vertical components
of
synchronized scrolling, respectively.
EXTRACT
/SYNCSCROLL returns the current horizontal and
vertical
synchronized scroll settings in variables
SYNCSCROLL.0
through SYNCSCROLL.2.
EXTRACT /SYNCSCROLL
The following variables are returned:
SYNCSCROLL.0 2
SYNCSCROLL.1 the horizontal synchronized scroll setting
SYNCSCROLL.2 the vertical synchronized scroll setting
SET The SELMODE option
controls how text is selected. In
QUERY character mode, SELMODE affects
the behavior of the MARK
EXTRACT command. In graphical mode, SELMODE
affects text selection
SELMODE using a mouse pointing device or keyboard
navigation
alternatives
to the mouse.
[SET] SELMODE STREAM
LINE
COLUMN
BLOCK
STREAM
permits text selection on one or more lines
beginning
or ending anywhere within a line
LINE permits text selection of an entire line or lines.
COLUMN
permits text selection of a vertical column through
the
file between specified columns.
BLOCK
permits text selection of any variable-sized
rectangular
"block" of text.
QUERY SELMODE displays the current SELMODE setting
QUERY SELMODE
Output appears on the message line in the form
SELMODE setting
where
setting is either LINE, STREAM, COLUMN, or BLOCK.
EXTRACT
/SELMODE returns the current text selection
mode
in variables SELMODE.0 through SELMODE.1
EXTRACT /SELMODE
The following variables are returned:
SELMODE.0 1
SELMODE.1 the current text selection mode
SET The SHELLTERM option controls the terminal emulator
QUERY invoked when running shell commands
or interacting
EXTRACT with the shell in graphical mode.
SHELLTERM has no
SHELLTERM effect in character mode.
[SET] SHELLTERM term_type [term_opts] -e twgpause
NOTERM
Initial default: xterm -e twgpause
[term_type]
is any valid terminal type provided by your
window
manager. The [term_type] must support the "-e"
option
to execute a program.
[term_opts]
may be any valid terminal options for the
[term_type]
specified. The documentation for your window
manager
provides details on valid terminal options for the
terminal
types it supports.
"-e
twgpause" is required and must be specified in lower
case.
This executes the twgpause utility which permits
the
terminal window to remain displayed until you respond
to
the message "Press ENTER to return to the editor".
Use
NOTERM to suppress the display of a terminal window
if
do not wish to see the output from shell commands.
If
NOTERM is specified, temporary access to the shell for
a
series of commands is disabled.
Examples:
The
IBM RS/6000 provides the "aixterm" terminal emulator.
To
use it when interacting with the shell, set SHELLTERM
as
follows:
SET SHELLTERM aixterm -e twgpause
On
HP systems, you may specify the "hpterm" emulator as
follows:
SET SHELLTERM hpterm -e twgpause
QUERY SHELLTERM displays the current SHELLTERM setting.
QUERY SHELLTERM
The
current SHELLTERM setting appears on the message line.
EXTRACT
/SHELLTERM returns the current SHELLTERM setting
in
variables SHELLTERM.0 through SHELLTERM.1.
EXTRACT /SHELLTERM
The following variables are returned:
SHELLTERM.0 1
SHELLTERM.1 the current SHELLTERM setting
EXTRACT The VERSION option of EXTRACT returns
the current
VERSION product version in variables VERSION.0
through
VERSION.1.
EXTRACT /VERSION
The following variables are returned:
VERSION.0 1
VERSION.1 the current product version
MARK The MARK command is designed
to be used in character
Command mode for selecting and de-selecting text.
MARK is
normally
assigned to a PF Key for interactive use
or
used within a macro.
MARK [ADJUST]
[CANCEL]
MARK
with no operands marks the beginning and end points of
the
selected test. Once you have marked the starting
position,
you may move the cursor to any new point within the
file;
then issue another MARK command to select your text.
MARK
ADJUST is used to change the size of an existing
selection.
To change the size of the current selection,
position
the cursor to any new point within the file; then
issue
MARK ADJUST.
MARK CANCEL is used to de-select the current selection.
SET
command options that affect the results of the MARK
subcommand
include
SELMODE
PCUT The PCUT command is used
in character mode to delete
Command the current text selection
PCUT
Use
PCUT by executing it on the command line or by
assigning
it to a PF key. PCUT may also by used in a macro.
PCOPY The PCOPY command is used in
character mode to copy the
Command current text selection to the current
cursor position.
PCOPY
Use
PCOPY by assigning it to a PF key. PCOPY may also be
used
in a macro.
PMOVE The PMOVE command is used to
move the current text
Command selection to the current cursor position.
PMOVE
Use
PMOVE to assigning it to a PF key. PMOVE may also be
used
in a macro.
PASTE The PASTE command copies text
from the clipboard and
Command inserts it into the file at the current
cursor position.
PASTE
Use
PASTE by assigning it to a PF key. PASTE may also be
used
in a macro.
[index (frame version)] [index (text version)]