| |
 |
CWTE - Help Reference File |
|
Below is the HELP content for the CWTE editor that is basically a text file. This file defines all of the commands and much of
the operating concepts of the editor. When looking at the HELP content
below, you will see some lines near the top of this file that have been
designed to be used by a special line command (the LEX line command
within CWTE)
that would branch the editor to the various HELP sections. However,
being this is a web page, here are some links that will branch you to a
sampling of the various segments in the HELP file:
CWTE (CoolWay Text Editor) User Guide 05-FEB-13
This is the HELP file that defines all of the CWTE commands and much of
the operating concepts of the CWTE editor. For a general overview of the
CWTE editor and a discussion of some things that are not readily
obvious, enter the CWTE primary command 'help o', which will view the
file named "CWTE-OVue.txt" that is located in the same directory as this
help file. You should also view the "LICENSE.txt" file by entering the
primary commands: Version, License, or 'help L'.
---- NOTE ------------------------------------------------------------
Within this guide, the prefix notations of C-, S-, A- refer to the
simultaneous use of either the CTRL, SHIFT, or ALT keys respectively.
INDEX ---- INDEX ---- INDEX ---- INDEX ---- INDEX ---- INDEX ---- INDEX
The lines listed below represent the index for each of the major
sections in this text document. When viewing this file with the CWTE
editor, you can quickly locate to one of these sections by using the
"LEX" line command on any one of the following lines:
F INVOKING_THE_CWTE_EDITOR 1 FIRST!DOWN C!F -
F EDITOR_START_UP_DEFAULTS 1 FIRST!DOWN C!F -
F FIXED_KEY_ASSIGNMENTS 1 FIRST!DOWN C!F -
F DEFAULT_FKEY_ASSIGNMENTS 1 FIRST!DOWN C!F -
F KEYS_THAT_LAUNCH_ACTION_COMMANDS 1 FIRST!DOWN C!F -
F PRIMARY_COMMAND_FUNCTIONS 1 FIRST!DOWN C!F -
F LINE_COMMAND_FUNCTIONS 1 FIRST!DOWN C!F -
F DETERMINING_CURSOR_LINE_NUMBER 1 FIRST!DOWN C!F -
F TEXT_MARKING_COPY/PASTE_OPERATION 1 FIRST!DOWN C!F -
F GLOBAL_COPY/MOVE_OPERATION 1 FIRST!DOWN C!F -
F LINE_LABEL_SUPPORT 1 FIRST!DOWN C!F -
F PICTURE_CHARACTERS 1 FIRST!DOWN C!F -
F PROFILE_SETUP_FOR_EDITOR 1 FIRST!DOWN C!F -
F COLOR_SETUP_FOR_DISPLAY 1 FIRST!DOWN C!F -
F X-WINDOWS_SPECIFIC_OPERATION 1 FIRST!DOWN C!F -
F MS-WINDOWS_SPECIFIC_OPERATION 1 FIRST!DOWN C!F -
F DOS_SPECIFIC_OPERATION 1 FIRST!DOWN C!F -
F FINDING_FILE/DIRECTORY_NAMES 1 FIRST!DOWN C!F -
F FILE_RING_CONCEPTS 1 FIRST!DOWN C!F -
F DATA_RECOVERY_SCHEME 1 FIRST!DOWN C!F -
(Back To Top)
INVOKING_THE_CWTE_EDITOR -----------------------------------------------
CWTE can start up with or without command line parameters. And
depending on the type and number of parameters passed, CWTE may start
up displaying the contents of the individual file(s) or displaying a
list of files to select from. Generally, CWTE will start up with a
file list view when attempting to select more than two files or
directories to browse or edit.
Currently, CWTE accepts the following parameter switches. These
options can be passed in any order or mix, followed by the file names
that you wish to edit/browse.
-b : To start CWTE up in browse mode.
-e : To start CWTE up in edit mode.
-f : Force CWTE to start up with a FILE list view for the list of
-fb file(s) to be selected. Optionally, append a 'b' (-fb) to set
the block exit feature (see the primary command BLOCK).
-a : To force all files to be opened for viewing (FList remains).
-w : To force text wrapping for all edit views when text entry goes
beyond the SETCOLS limit. This will always override any
settings in the profile files. See primary command RCWRAP.
-p : To specify a directory path that CWTE is to start up in. A
directory path must follow this parameter (separated by a blank
space). If this option is not given, it will default to the
current directory.
Window Resizing Unique Command Line Options (Windows/X-Windows):
-c* : Appending a number to this option (no blanks) will specify the
number of text columns that CWTE should start up with. This
will override any settings in the profile files. Also see
primary command SETCOLS.
-r* : Appending a number to this option (no blanks) will specify the
number of text rows that CWTE should start up with. This will
override any settings in the profile files. Also see primary
command SETROWS.
MS-Windows Unique Command Line Options:
-m : When CWTE first starts up, this will use a MS-Windows file
selection menu in which to select a path and filespec. The
starting path for this menu will either be the directory CWTE
was started in (the -p option path) or the MS-Windows icon
'Start In' directory. Any filespec's on the command line passed
with the execution of CWTE will be ignored.
X-Windows Unique Command Line Options:
-display <host:display.screen>
Specify the targeted physical display screen where the CWTE
window is to be displayed.
-font <fontset_name>
Specify the fontset for the characters used in CWTE.
-root_geom <width>x<height>{+|-}<xoffset>{+|-}<yoffset>
Specify the size and location for the CWTE window.
-xrm <resource_name>
Specify a X-Windows resource item. For more details, see the
section X-WINDOWS_SPECIFIC_OPERATION.
EDITOR_START_UP_DEFAULTS -----------------------------------------------
CWTE starts up in a predefined state that is built into the program
and then adds or modifies that state with user profile files and/or
passed parameters. Examples are the FKey assignments, edit/browse
state, colors, etc. See PROFILE_SETUP_FOR_EDITOR for information
regarding the profile files. The sequence of assignments and overrides
that CWTE makes are as follows:
1) CWTE Program Itself: CWTE first sets all its own defaults that are
designed within the program.
2) Profile Files: CWTE utilizes three levels of profile files. The
1st one processed (if found) is called the GLOBAL file, where the
general overall personalization of CWTE is done. The 2nd and 3rd
one processed is called a DIRECTORY file. The 2nd (if found) is in
the parent directory for a more specific use of settings,
generally for a group of directories (a class of work). The 3rd
(if found) is in the default directory, where a unique set of
settings are needed. For details on the profile files, see
PROFILE_SETUP_FOR_EDITOR.
3) Invocation Parameters: There are a few parameters that can be used
to set the state of CWTE. See INVOKING_THE_CWTE_EDITOR for a
description of these options. These options override the common
options found in the profile files.
4) Primary Command: Lastly, there are primary commands that can
override some of the settings of the above 3 options.
(Back To Top)
FIXED_KEY_ASSIGNMENTS --------------------------------------------------
Most keys are self explanatory, but some do special things and others
have extra features.
PageUp ....... Scrolls up by the SCROLL amount (defaults cursor).
An entry on the primary command line can alter the
default operation. A scroll value can be entered, as
well as "M" for max, "P" for page scroll, and "H" for
half page scroll.
PageDown ..... Scrolls down by the SCROLL amount (defaults cursor).
An entry on the primary command line can alter the
default operation. A scroll value can be entered, as
well as "M" for max, "P" for page scroll, and "H" for
half page scroll.
C-PageUp ..... Scrolls to the top of the file.
C-PageDown ... Scrolls to the bottom of the file.
C-BackSpace .. Deletes the text line that the cursor is on.
Home ......... When the cursor is in the edit text area, but not the
1st position of the text line, the cursor will be moved
to the 1st position of the current text line. If it is
already at the 1st position, the cursor will be moved
to the first column of the line command field for the
text line. Text offset will be affected. When the
cursor is in the primary command field, it will be
moved to the start of the primary command field.
S-Home ....... Moves the cursor directly to the start of the primary
command line field.
C-Home ....... Insures that the left edge of the text viewing area
starts with the 1st position of the text line. This
also moves the cursor to the start of the primary
command line field. The text area cursor reference does
not change.
Esc .......... When in the primary command field, the cursor is moved
to the first column and the field is cleared. When any
where else, the cursor is moved to the first column of
the line command field and the line command field is
cleared.
Enter ........ When CWTE is in EDIT mode, while no primary or line
commands are pending and the cursor is in the text area
of the screen, pressing ENTER will open a new line in
which to enter text. Otherwise, it will process the
primary and/or line commands.
KeyPad+ ...... When the NumLock key is off and the shift key is not
pressed, this state provides the same function as the
A-DnArrow combination specified elsewhere.
C-KeyPad+ .... The cursor will be moved to the next line, to the left
column, of the line command field.
End .......... The cursor will be moved to the end of the text line,
regardless of which field it may be in.
A-UpArrow .... Serves as a tab to previous line. When the cursor is in
the text area, the cursor will be moved to the previous
line and be placed at the first non-blank character of
that line. When the previous line is a blank line, it
will use the line above or below it as a reference.
When the cursor is in the line command field, the
cursor will be moved to the left most column in the
previous line command field.
A-DnArrow .... Serves as a tab to next line. When the cursor is in the
text area, the cursor will be moved to the next line
and be placed at the first non-blank character of that
line. When the next line is a blank line, it will use
the line above or below it as a reference. When the
cursor is in the line command field, the cursor will be
moved to the left most column of the next line command
field.
C-Arrows ..... When the cursor is in the text area, the cursor will
maintain its relative position on the screen and all
the text will scroll to relocate the cursor to the new
text position.
Insert ....... Puts cursor into insert mode to insert entered text.
Insert mode is ignored when in the line command field.
The insert mode is ignored when using the TAB key while
the Crtl key is down.
C-E .......... Erase from cursor position to end of line.
C-Z .......... Erase from cursor position to end of line and then
moves the cursor directly down one line.
A-<num> ...... Used to create characters that are not found on the key
board. If you know the ASCII value of a character, you
can produce that character by first holding down the
ALT key, then use the numeric key pad to enter the
ASCII value of the character, and lastly let up on the
ALT key. For the Windows and X-Windows version of CWTE,
the numeric characters on the main part of the keyboard
can also be used.
C-<mouse> .... The cursor can be dynamically placed on the screen by
holding the Control key down, move the mouse pointer to
the new cursor position, and then press button one of
the mouse. Note: The DOS version does not have mouse
functions and so this is not supported.
DEFAULT_FKEY_ASSIGNMENTS -----------------------------------------------
The default FKey assignments for CWTE are as follows:
--FKey01 ... Recall the previous command line text (RECALLBKWD).
S-FKey01 ... Recall the succeeding command line text (RECALLFWD).
--FKey02 ... SAVE the current file.
--FKey03 ... END edit/browse of the current file.
--FKey04 ... :TS to text-split the text line at the cursor.
--FKey05 ... RFIND to repeat the previous find command.
--FKey06 ... RCHANGE to repeat the previous change command.
--FKey07 ... LEFT to page left by the default scroll amount.
--FKey08 ... RIGHT to page right by the default scroll amount.
--FKey09 ... RINGL switches the file ring view to the left.
--FKey10 ... RINGR switches the file ring view to the right.
--FKey11 ... CRSR2TXT to move the cursor to last known text position.
--FKey12 ... CRSR2CMD to move the cursor to primary command field.
C-FKey01 ... SG_PROF to edit the global profile options.
C-FKey02 ... SD_PROF to edit the directory profile options. The 1st
press is the default directory, 2nd is the parent, etc.
C-FKey11 ... REFRESH the current file/FList view being displayed.
To add more FKey functions or modify the existing settings, refer to
the PROFILE_SETUP_FOR_EDITOR section.
KEYS_THAT_LAUNCH_ACTION_COMMANDS ---------------------------------------
There are just a few keys that will start the process of evaluating
the primary and line commands within CWTE. These are:
ENTER, PageUp, PageDown, and any FKeys
except when the FKey assignment is one of the following:
CRSR2TXT, CRSR2CMD, RECALLFWD, RECALLBKWD, LINENUM
(Back To Top)
PRIMARY_COMMAND_FUNCTIONS ----------------------------------------------
Primary commands can be entered/executed from the primary command
field or through the FKeys. Further, each primary command and its
parameters can be separated by a delimiter so that several commands
can be executed with one entry or FKey. By default, this delimiter is
the "!" character (see Delim=). For each command definition listed
below, the parameter options should generally be passed in the order
specified (particularly for the required options <*> ).
F[IND] .... Find the specified text string:
F <string> [X | NX] [lcol [rcol]] [ALL] [WORD]
See PICTURE_CHARACTERS section for picture type strings.
See LINE_LABEL_SUPPORT for label use with this command.
X ......... Exclude lines where the specified text string is found:
X <string> [lcol [rcol]] [ALL] [WORD]
This command functions similar to the find command.
See PICTURE_CHARACTERS section for picture type strings.
See LINE_LABEL_SUPPORT for label use with this command.
C[HANGE] .. Find and change the specified text string:
C <from-str> <to-str> [X | NX] [lcol [rcol]] [ALL] [WORD]
See PICTURE_CHARACTERS section for picture type strings.
See LINE_LABEL_SUPPORT for label use with this command.
RES[ET] ... Reset line commands, excluded lines, and miscellaneous:
RES [C] [X] [S] [L] [A]
C=line commands, X=excluded lines, S=special lines (COLS,
TABS, INFO), L=line labels, A=all of C/X/S/L. Default is
C/X/S type lines. Marked data is always reset. See
LINE_LABEL_SUPPORT for label use with this command.
END ....... Ends the browse/edit session on one or ALL file(s):
END [ALL]
A prompt will be made on files that have been modified and
have not yet been saved.
CAN[CEL] .. Cancels the browse/edit session on one or ALL file(s):
CAN [ALL]
No prompt will be made on modified files.
E[DIT] .... Enters edit mode on a file:
{ E | CWTE } [<file-name> [...]]
If a file name is not given, the current file will be put
into edit mode. Otherwise, the named file will be edited.
Environmental variables and wild cards in the name are
supported.
BROWSE .... Enters browse mode on a file:
{ BROWSE | V } [<file-name> [...]]
If a file name is not given, the current file will be put
into browse mode. Otherwise, the named file will be
browsed. Environmental variables and wild cards in the
name are supported.
COPY ...... Copy a text file into the current edit view:
COPY <file-name>
The named file will be read in and inserted at the "A" or
"B" line commands. No other line commands must be pending.
If there are no lines in the current edit view, the "A" or
"B" line commands are not needed.
FLIST ..... Creates a list of files for selective operations:
FLIST [<file-spec> [...]]
The FList command creates a view that lists files and
directories. If no file-spec is given, then all entries in
the current directory will be listed. If the FList command
is given while displaying a FList view, the current FList
view will be replaced using either the newly entered
file-spec or reusing the old file-spec entry. If the FList
command is given within an EDIT/BROWSE view, a new FList
view is added to the file ring. Environmental variables
and wild cards in the name are supported. By default, the
directory entries in the FList view will be grouped
(sorted) to the bottom of the entries (See SORTDIR= option
in the PROFILE_SETUP_FOR_EDITOR section to change this).
While displaying a FList view, you can use most any
EDIT/BROWSE command that would not result in
creating/duplicating an entry in the text area. The Sort
command can also be used in an FList view.
PWD ....... Displays the Present Working (Default) Directory:
PWD
The information is presented at the top line of the
displayed text area and labeled as an INFO type line.
LFN ....... Displays the filespec of the current view:
LFN
The information is presented at the top line of the
displayed text area and labeled as an INFO type line. (the
path/filename may be very long and the LFN scheme insures
the ability to see the complete long path/file names and
to cut/paste them).
NAME ...... Names the current file being edited with a new file name:
NAME <file-name>
L[OCATE] .. Locate the cursor to a particular line in the file:
L <line-number> | <line-label>
Locating to line "0" positions the cursor to the first
line in the text area, but does not un-exclude that line.
See LINE_LABEL_SUPPORT for label use with this command.
DEL[ETE] .. Delete the specified X/NX text lines:
DEL { ALL | labels } { X | NX }
See LINE_LABEL_SUPPORT for label use with this command.
TAB ....... To Remove/Insert tabs within the text area:
TAB { OUT | IN | LEAD }
OUT removes all tabs, IN inserts tabs, and LEAD only tabs
leading blanks. All tabbing uses the standard every eight
column tabbing scheme and this is how the data would be
saved to the file once tabbed.
SCROLL .... The scroll amount when using page up/down/left/right
SCROLL <numeric-scroll-value>
The value zero will do full screen (cursor) scrolls.
RELOAD .... Reloads the current file or FList view being displayed:
RELOAD [ASIS] [ 0-3 ]
When reloading a file, any tabs in the file will be
expanded unless ASIS is specified to prevent expanding.
Any changes that may have been made from the last save
will be lost and the new view will be from the last save.
When reloading a FList view, the new list will be updated
to reflect the current state of the file list. A numeric
character can be passed to select or hide system/hidden
entries. This value is the sum of the following (the
default is set by IncFiles= in the profile files):
0 = Do Not Display System/Hidden Files
1 = To Display Hidden Files
2 = To Display System Files
REFR[ESH] . Same as RELOAD.
SORT ...... Sorts the text data in a specified order:
SORT [ X | NX ] [ c1 [ c2 ] [ A | D ] ... ] [ CI ]
-or-
SORT [ X | NX ] { DATE | FILE | SIZE } [ A | D ]
Sorting is done in the range of "c1" to "c2" columns and
will default to the full text area field if not given. If
in a FList view, the DATE/FILE/SIZE can be used in place
of the c1/c2 parameters. Each range can further be sorted
by "A" (ascending, the default) or "D" (descending). "c2"
must be equal to or greater than "c1". If "c2" is not
given, "c1" to "c1" is assumed. The sort fields can repeat
from Major to Minor sorting and the column range groups
must be separated with "A" or "D". The overall sorting can
further be limited to "NX" (non-excluded) or "X"
(excluded) lines. Use "CI" for case insensitive sorting.
Sorting can also be limited to line labels starting at a
top line label and ending at a bottom line label. See
LINE_LABEL_SUPPORT for more info.
BLOCK ..... Blocks CWTE from exiting the given displayed view:
BLOCK [ EXIT | OFF ]
This is a scheme to insure that you will not accidentally
close out (exit from) a particular displayed view (ie, a
file list view that may be central to your work). Option
EXIT is the default. To exit a blocked view, you can set
the block option to OFF or use the CANCEL command to exit
the view.
RCWRAP .... Right Column Wrapping upon hitting the SETCOLS limit:
RCWRAP [ Y[ES] | N[O] ]
When entered without options, this defaults to YES. This
command applies only to the current window. When opening a
new file or reloading a file, the default is no text
wrapping unless the -w option was passed or the rcWrap=
setting in the profile files specifies otherwise. This
command allows the entered text to wrap to the next line
based on the window width dimensions. The window width can
be changed via SETCOLS command, profile file settings, or
by dragging the window edge with the mouse.
HEXVAL .... Displays the Hex and ASCII value of a character:
HEXVAL
Place the cursor under the text character you wish to get
the Hex and/or ASCII character value of.
SG_PROF ... Edit the Global profile file and to set profiles:
SG_PROF
This command will cause an edit view of the global profile
file located in the $HOME/ROOT directory. Upon saving the
file, all profile options will be reapplied. See
PROFILE_SETUP_FOR_EDITOR section for further details.
SD_PROF ... Edit A Directory profile file and to set profiles:
SD_PROF
This command will cause an edit view of the directory
profile file(s). Each entry of this command rotates
between the current and parent directory files. Upon
saving the file, all profile options will be reapplied.
See PROFILE_SETUP_FOR_EDITOR section for further details.
SETPROF ... To dynamically update and apply editor profile settings:
SETPROF [ <profile-assignments> ]
When no options are passed, all of the profile files will
be rescanned, thus setting the condition of CWTE to its
typical startup state. There are some assignments that do
not affect other previously opened views until this
command is executed in those views (like rcWrap= and
Tabset=). Optionally, a single profile assignment can be
passed that will add or override previous settings. See
PROFILE_SETUP_FOR_EDITOR for profile-assignment options
and syntax that can be used.
SETCOLS ... Sets number of visible text columns in the edit window:
SETCOLS <numeric-width-value>
See PROFILE_SETUP_FOR_EDITOR for other means of setting
the number of text columns. Not supported in DOS version.
SETROWS ... Sets text rows for the edit window:
SETROWS <numeric-row-value>
See PROFILE_SETUP_FOR_EDITOR for other means of setting
the text row number. Not supported in DOS version.
VER[SION] . License and Version information of the CWTE Editor.
LICENSE ... License and Version information of the CWTE Editor.
R[ING] .... Move/Name/Find File Ring operations:
RING M(ove) | A(fter) | B(efore) | C(lear)
-or-
RING N(ame) <string> | F(ind) <string/*> | R(eturn)
All of the RING command options are relative to the
current file ring view being presented.
- M option is used to mark the current view to be moved
with reference to the "A" or "B" option.
- A/B option is used to move a view that is marked (or to
be marked) with the "M" option to a location relative to
the view where the "A" or "B" option was/is executed.
- C option is used to clear all pending "M", "A", and "B"
options (for those cases where you're not sure if a
previous ring action is pending).
- N option is used to name (or rename) the current view for
future "F" operations (it basically hides the filename
and this only affects ring operations).
- F option is used to find the 1st/next occurrence of text
in the filename of a view or in its new "N" name. If the
string starts with an "*", then the search will be for
the next occurrence of an FList view. Searching is done
from left to right in the ring. Do not quote the string.
Blanks in the text are accepted.
- R option is used to return to the view where the previous
"F" or "R" option was issued.
CRSR ...... To move the cursor around in the text area of the editor:
CRSR L | R | U | D | H | E | T
Left/Right/Up/Down/Home/End/Tab respectively.
Append a '-' to the 'T' option to tab left (T-).
-or-
Blank out all text from cursor point on the text line:
CRSR < | >
Starting at and including text at the cursor, replace all
text with blank characters to BOL or EOL respectively.
----
The CRSR command does not have much value when used by
itself. It is intended to be stacked with other FKey
commands to perform some end task.
HELP ...... Displays the specified HELP file:
HELP [ <some-alpha-numeric-character> ]
This command browses a text file of your choice for help
information. The help file selected is based on the
correlation of the alpha/numeric character that can be
passed and the HelpFile= option specified in the profile
file. Specifying no character defaults to 'H', which is
the default help file when CWTE starts up. Other built-in
options are 'O' for overview help, and 'L' to view the
licenses for this program.
GRES[ET] .. Global resetting of all global copy/move line commands:
GRESET
See the section GLOBAL_COPY/MOVE_OPERATION for an overall
use of this command.
DSC ....... Do Shell Command Operation for non-CWTE functions:
DSC [-c] <some-shell-command-string>
The intent of this command is to execute an operating
system shell command for commands that are not part of the
CWTE editor. Everything after the optional [-c] option is
sent to the system shell command line for execution. The
results are generally in the shell window that CWTE was
started in. Under Unix, if the window no longer exists
where CWTE was started, the command results may be lost.
Under DOS, the CWTE window is temporarily suspended until
the results are evaluated. Under MS-Windows, a new DOS
window will appear in which the command string will be
executed and the window will remain open unless -c was
passed, in which case the window will automatically close
upon completion of the task. A special string "%1%" can be
added as part of the command string and will be converted
as follows: if viewing a file, it will be replaced with
the filename being viewed. If within a FLIST view, it will
be replaced with the file/directory name entry from the
line that the cursor is located on.
RAP ....... Run Application Program for non-CWTE functions:
RAP <some-application-command-string>
This operation is very much like the DSC command above,
except that the command string becomes an application
system call (it is not passed to the system shell). Note
that most DOS and Shell like commands are likely to fail.
This command is not available in the DOS 16-bit version of
CWTE. See the DSC command for further details.
SELECT .... Copies the whole file or FList view to clipboard:
SELECT
This operation basically mimics the Alt-M/Alt-C functions
to hilite the complete file or FList view and then copies
the contents to the clipboard (COPY buffer). Refer to the
section TEXT_MARKING_COPY/PASTE_OPERATION and the A-M and
A-C operations. Text hiliting rules will be applied.
BEEP ...... Turns the beep tone in CWTE on or off:
BEEP [ ON | OFF ]
When entered without options, this defaults to ON.
MSG ....... Basically a NoOp type command for miscellaneous use:
MSG [<message>]
This command has no real function except to put the MSG
command string into the command recall buffer and to
notify you of that fact. It was designed to be associated
with the use of the LEX line command.
Page scrolling commands. See the section PROFILE_SETUP_FOR_EDITOR for
more details.
PageUp .... This is hard coded into CWTE. This command cannot be
assigned to an FKey.
PageDown .. This is hard coded into CWTE. This command cannot be
assigned to an FKey.
UP ........ Page up:
UP [<value> | M | P | H]
Where M=max, P=page, H=half-page scrolling. This command
can be assigned to a PFkey if desired.
DOWN ...... Page down:
DOWN [<value> | M | P | H]
Where M=max, P=page, H=half-page scrolling. This command
can be assigned to a PFkey if desired.
By default, the following primary commands are assigned to a FKey.
See the section PROFILE_SETUP_FOR_EDITOR to change these assignments.
LEFT ...... Page left:
LEFT [<value> | M | P | H]
Where M=max, P=page, H=half-page scrolling.
RIGHT ..... Page right:
RIGHT [<value> | P | H]
Where P=page, H=half-page scrolling.
RFIND ..... Repeat the last find text string operation:
RFIND
RCHANGE ... Repeat the last find and change text string operation:
RCHANGE
RINGL ..... Switches the file ring view to the view on the left:
RINGL [C]
The optional C clears pending messages in the next view.
See FILE_RING_CONCEPTS for more information.
RINGR ..... Switches the file ring view to the view on the right:
RINGR [C]
The optional C clears pending messages in the next view.
See FILE_RING_CONCEPTS for more information.
SAVE ...... Save the current file:
SAVE [<file-name>]
If a file name is not given, the file will be saved under
the current name. Otherwise, the file will be saved into
the named file.
By default, the following primary commands are assigned to a FKey (see
PROFILE_SETUP_FOR_EDITOR section), but are treated in a special manner
when assigned to the FKey (as compared to typing it on the command
line). When executed from a FKey, these commands will be executed
without acting on or affecting the line commands or primary commands
that may be pending.
LINENUM ... Display the line number that the cursor is on:
LINENUM
Place the cursor on the text line for which you want the
line number for. Also, see S-A-# below.
CRSR2TXT .. Moves the cursor to the last known position within the
text edit area:
CRSR2TXT
CRSR2CMD .. Moves the cursor to the left most position within the
primary command field.
CRSR2CMD
RECALLFWD Recalls the previous command text to the command buffer:
RECALLFWD
This function moves forward through the command buffer.
This command only works when assigned to a FKey.
RECALLBKWD Recalls the previous command text to the command buffer:
RECALLBKWD
This function moves backward through the command buffer.
This command only works when assigned to a FKey.
Line commands, when entered as a primary command, must be entered by
preceding the line command text with the character ":". This will tell
the primary command processor to enter this line command on the line
that the cursor is on. Remember that there are only 6 columns in the
line command field. Truncation may take place.
(Back To Top)
LINE_COMMAND_FUNCTIONS -------------------------------------------------
Being that CWTE is an alternative to the ISPF/PDF type editors, the
line-command functions generally work the same, but some will have
different action rules. When a line command has been entered, the
syntax and validity of the command must be proper before the cursor
will be allowed to leave the field. Also, CWTE does not do a global
check to make sure that each and every line command can complete its
action before being able to do any one line command. When the CWTE
editor starts to process line commands, it starts from the top and
works its way down to the bottom of the line commands. An attempt is
made to process each line command as it is encountered. Line commands
are skipped over if the action can not be completed so that it can
attempt to find another. And CWTE does not check for line command
grouping (for instance, ISPF/PDF doesn't handle consecutive lines of
"M", followed by consecutive lines of "A"). Line command processing in
CWTE stops when a conflict is detected or the bottom of the list is
encountered. Some line commands could remain pending because no
matching actions were detected (ie, copy with no after, before,
overlay, etc). A line command can be made a primary command by
prepending a colon (:) to the command. It will be applied to the line
that the cursor is on. Also note that when several consecutive lines
are excluded, that group of excluded lines is counted as one
displayable line.
X[n] ...... Exclude one or more displayable lines.
XX ........ Exclude a block of displayable lines.
C[n] ...... One or more displayable lines to be copied.
CC ........ A block of displayable lines to be copied.
M[n] ...... One or more displayable lines to be moved.
MM ........ A block of displayable lines to be moved.
A ......... The reference point to copy/move displayable lines after.
B ......... The reference point to copy/move displayable lines before.
O[n] ...... The reference point of one or more displayable text lines
to overlay the copied or moved text lines onto.
OO ........ The reference point for a block of displayable text lines
to overlay the copied or moved text lines onto.
D[n] ...... One or more displayable lines to be deleted.
DD ........ A block of displayable lines to be deleted.
I[n] ...... One or more blank lines to be inserted.
R[n] ...... One or more displayable lines to be repeated.
RR[n] ..... A block of displayable lines to be repeated.
F[n] ...... Un-exclude the first or more excluded displayable lines.
L[n] ...... Un-exclude the last or more excluded displayable lines.
S[n] ...... Show, to un-exclude, only those lines from an excluded
group of lines where the 1st non-blank column has the same
starting column as the left most starting column of the
lines in that excluded group. Or use the optional 'n'
value to show only those lines where the 1st non-blank
starting column is equal to the specified 'n' value.
XD ........ Excludes lines downward, starting after the cursor
reference line, while the 1st non-blank column of each
line is not the same as the 1st non-blank of the cursor
reference line. Downward excluding stops at the 1st line
when this is no longer true.
XU ........ Excludes lines upward, starting before the cursor
reference line, while the 1st non-blank column of each
line is not the same as the 1st non-blank of the cursor
reference line. Upward excluding stops at the 1st line
when this is no longer true.
TABS ...... Opens a special line showing the key-tabbing positions.
The key-tabbing can be changed by editing the TABS line in
the current window (pasting is not allowed, but a regular
text line can be *overlayed* into the TABS line). Any
non-blank character represents a tab stop. By default,
when lacking any assigned tabs or for tab points after the
last assigned tab, there is a virtual key-tab every eight
columns. Any tab changes made in the current window do not
affect other windows and are not automatically saved. To
save the TABS setting for session to session use, use the
TabSet= setting in the profile files. This has to be
manually set, but you can use the MD line command on the
TABS line and then the GM/GC/GA to move/copy the tab data
and assigned to the keyword. Also note that this TABS
information is not used in the process of saving data to
the file. To set tabs in the file, use the TAB primary
command, which uses the standard every eight columns
tabbing scheme, and then saves to the file with tabs in
the data.
COLS ...... Opens a column position line (not editable or MD!).
TF[n] ..... Text flow one or more text lines to the 'n' column. By
default, the text is flowed to the SETCOLS value of the
text line (and will change with window width adjustments).
Flowing stops when the left indention changes for the
group of lines being flowed or when a special character is
detected in column 1, which can be one of:
.:&#!</ or the hex character 0x0C.
If the end of a line to be flowed ends with one of the
following characters, either one or two blanks will be
appended to the line before appending the next line (the
tfSpace= setting determines how many blanks are appended):
!.?;
TFF[n] .... This is a two step TF[] operation, where the first step is
to do the basic TF[2] operation so that all words start in
the same left most indented column. The second step is
again to use the TF[n] operation to flow the text to the
specified column 'n' value. The intent is to remove any
extra multiple blanks and then have the text flow to the
rules of the basic TF function. Normally, the basic TF
operation does not remove a string of blanks located in
the middle of a line (an SPF rule).
J ......... Join the next text line to the current text line.
See TF command above about adding extra blanks.
TS ........ Split the text line at the cursor.
)[n] ...... Shift the text line to the right by the specified amount.
([n] ...... Shift the text line to the left by the specified amount.
))[n] ..... Shift a block of text lines to the right by the specified
amount.
(([n] ..... Shift a block of text lines to the left by the specified
amount.
Note: The above shift operation is treated as data shifts.
The <, <<, >, and >> do the same. The concept of
column shifts is not supported. No text will be lost
due to shifting. When the left or right limits have
been reached, text shifting on that line will stop.
LC[n] ..... Lower-case one or more text lines.
UC[n] ..... Upper-case one or more text lines.
LCC ....... Upper-case a block of text lines.
UCC ....... Lower-case a block of text lines.
LEX ....... Line EXecute. The contents of the text line will be copied
into the primary command field and executed. The text line
should have valid CWTE commands. This operation is similar
to the FKey assignments discussed in the
PROFILE_SETUP_FOR_EDITOR section.
SAA[n] .... Start Associated Application. This line command is used to
launch an application that is associated with any valid
file name, path, or URL that is displayed somewhere in the
line. In the FLIST view, the file name is automatically
picked out. In the EDIT/BROWSE view, by default the first
delimited string is picked out unless the value "n" of 1
or greater is included to pick out a particular delimited
text field of interest. The selected entry will be passed
to an associated application and if no application can
process the entry, it will be considered a failed
operation. The function can be further customized to
specify what particular application will be used for the
association. See the profile file settings SaaB= and SaaE=
for details.
MD ........ Makes an ">INFO>" line a regular text line (Make Data).
LR[n] ..... Line Recall. Recall the original specified number of text
lines that were previously modified. Recalled lines show
up as an ">INFO>" type lines. To restore the ">INFO>" line
of interest to a normal text line, use the "MD" line
command.
With reference to the next five line commands, see the section
GLOBAL_COPY/MOVE_OPERATION for an overall use of these commands.
GC[n] ..... Identify 1 or more displayable lines to be globally copied
across files in CWTE's ring of files.
GCC ....... Identify a block of displayable lines to be globally
copied across files in CWTE's ring of files.
GM[n] ..... Identify 1 or more displayable lines to be globally moved
across files in CWTE's ring of files.
GMM ....... Identify a block of displayable lines to be globally moved
across files in CWTE's ring of files.
GA ........ Identifies a reference point where text will be globally
inserted from across files in CWTE's ring of files.
The next six line commands are valid only while displaying a FList
view. Further, while displaying a FList view, you can use/enter any
line command that generally does not alter or duplicate entries in the
text area of the screen.
V ......... View the file on the selected line. If the line contains a
directory entry, another FList view will be started
listing all the entries in that directory.
VV ........ A block of "V" line commands. See "V" command.
E ......... Edit the file on the selected line. If the line contains a
directory entry, another FList view will be started
listing all the entries in that directory.
EE ........ A block of "E" line commands. See "E" command.
DEL ....... Delete the actual file on the selected line. Directory
entries can not be deleted with this option. Be aware that
the read-only-permissions on a file are ignored.
DDEL ...... A block of DEL line commands. See DEL command.
Note: If a file is edited and saved, you will need to
REFRESH (RELOAD) the FList view to see the new date
and file size changes.
Note: When using the V or E line commands to view
directories, the actual working (current) directory
reference does not change!
DETERMINING_CURSOR_LINE_NUMBER -----------------------------------------
Sometimes it is nice to know what line number the cursor is on. This
can be done in one of two ways: using the primary line command LINENUM
or with a multi-key action on the keyboard:
S-A-# : Pressing the SHIFT and ALT keys together, followed by
pressing the '#' character produces a line number message.
TEXT_MARKING_COPY/PASTE_OPERATION --------------------------------------
Marking the text area can be done by mouse or by keyboard (also see
primary command SELECT). Further, the text can be marked in one of two
modes: from some text point to the next text point, or from some
corner to another corner of text. The SHIFT key determines the type of
marking that will take place. The beginning mark and ending mark of
the text is done with the same single key or mouse button.
Text marking can be done in any direction or any corner to corner.
But, all CUT/PASTE operations will gather and paste the text from the
upper left to the lower right of the marked area.
Text marking is grouped into two areas on the screen, the command line
area and the file text area. After text marking has started, text
marking will not be allowed to copy text outside the selected area.
If text marking is done across EXCLUDED lines in the text area, only
the NON-EXCLUDED lines will be put into the COPY buffer. The INFO
lines can also be marked and can/will be put into the COPY buffer. The
COLS and TAB lines can not be marked, nor will they be put into the
COPY buffer.
WITH THE MOUSE:
Using the mouse to perform COPY/PASTE is somewhat different throughout
the various operating systems. See the sections
DOS_SPECIFIC_OPERATION, X-WINDOWS_SPECIFIC_OPERATION, and
MS-WINDOWS_SPECIFIC_OPERATION for details when using the mouse.
When the text to be selected goes beyond what can be seen on the
screen, move the pointer to the edges of the text screen and this will
cause the editor to scroll the text to bring the text to be marked
into view. To prevent a scroll run away, no more than a window size
will scroll and then stop. To continue or maintain the scrolling, you
can keep moving the mouse pointer. Also, make sure there are no
pending line commands because they will cause text marking to be
canceled. Once the marking has been started, the LEFT/RIGHT/UP/DOWN
key commands can also be used.
WITH THE KEYBOARD:
With the keyboard, there are several keys that are used to mark, copy,
paste, and other miscellaneous functions. These keys and their
definition are (note that: A- = Alt and C- = Cntl):
A-M : Used to MARK the beginning and ending points of hilited text.
The first press marks the beginning point while the following
press(s) extends the marked area. To produce corner to corner
hiliting, hold down the SHIFT and ALT keys together.
A-U : Used to UNMARK/reset any marking activity with reference to the
current file. It does not remove or modify the copy buffer
contents.
A-C : Used to COPY the marked text into the COPY buffer.
A-B : Used to BLANK out the characters in the hilited area. This
feature is not support when marking the command line.
A-D : Used to DELETE the characters and space (close up) in the
hilited area. When marked as text point to text point (not
corner to corner), nulled lines will also be deleted. This
feature is not support when marking the command line.
A-V : VACATE. This is a combination of two actions on the given
hilited area. First, the A-C operation is performed, followed
by the A-B operation. The same conditions apply as previously
given for these operations.
A-F : FETCH. This is a combination of two actions on the given
hilited area. First, the A-C operation is performed, followed
by the A-D operation. The same conditions apply as previously
given for these operations.
A-P : Text in the COPY buffer will be PASTED into the text area where
the cursor is located. The insert key will determine if the
text is to be inserted and only affects the first line that
pasting is started on. If the COPY buffer contains more than
one line, the editor will create new text lines that follow the
current line in which to add the additional data. The PASTE
operation can also perform corner to corner pasting by pressing
and holding the SHIFT key before pressing the A-P keys.
A-O : Text in the COPY buffer will be PASTED into the text area where
the cursor is located by OVERLAYING the text (the state of the
INSERT key has no affect on this operation). The text will only
be copied into the blank areas of the text to be overlaid (the
non-blank characters will not be altered). If the COPY buffer
contains more than one line, the editor moves the cursor to the
start area of the next line and continues to OVERLAY the text
by going down the file line by line until the COPY buffer runs
out of data. The PASTE operation can also perform corner to
corner pasting by pressing and holding down the SHIFT key
before pressing the A-O keys.
A-I : Text in the COPY buffer will be PASTED into the text area where
the cursor is located by INSERTING the text horizontally into
the line (the state of the INSERT key has no affect on this
operation). If the COPY buffer contains more than one line, the
editor moves the cursor to the start area of the next line and
continues to INSERT the text by going down the file line by
line until the COPY buffer runs out of data. The PASTE
operation can also perform corner to corner pasting by pressing
and holding down the SHIFT key before pressing the A-I keys.
C-C : COPY - This functions the same as A-C above.
C-V : PASTE - This functions the same as A-P above.
C-X : COPY - This functions the same as A-F above.
GLOBAL_COPY/MOVE_OPERATION ---------------------------------------------
To accommodate the copying and moving of lines across edit views, a
special set of line commands are available for use (besides the copy
and paste operations). These line commands are GC, GCC, GM, GMM, and
GA. You can use any number or combination at any time across as many
views as you like (it is up to you to understand the results). The GA
line command can also be used in FList views, but can only accept
lines from other FList views. The search starts with the current view,
followed by the next (view to the right), etc. The primary command
GRESET can be used to remove all pending global line commands
throughout all the views. To better understand these commands, see
sections LINE_COMMAND_FUNCTIONS and KEYS_THAT_LAUNCH_ACTION_COMMANDS.
LINE_LABEL_SUPPORT -----------------------------------------------------
Line labels are specified in the line command field. They are defined
as a character string that begins with a "." (dot) character and is
followed by any 1-5 characters of your choice. The following are the
only commands that will make use of the labels. The labeled lines are
included in the specified operations below.
* LOCATE - Locates the cursor to the specified line label.
* FIND/CHANGE/X - Limits the operation within the specified labeled
range of the text lines.
* SORT - Sorts only the text lines within the specified labeled
range of the text lines.
* DELETE - Deletes only the text lines within the specified labeled
range of the text lines.
* RESET - Line labels can be individually cleared or all cleared
(removed) with the -l option of the RESET primary command.
Not entering a label specification when using the above commands will
assume that the action is on the entire file.
Labels entered on an excluded line puts the label on the first line in
the excluded group. Labels that are on lines further down in the
excluded group will not be displayed.
The editor in the ISPF/PDF utility uses default labels of .ZFIRST and
.ZLAST. This labeling concept is not supported by the CWTE editor.
PICTURE_CHARACTERS -----------------------------------------------------
CWTE can work with PICTURE strings under the FIND, X, and CHANGE
primary commands. A picture string is a single or double quoted text
string where the letter 'p' must *precede* the first quote. The FIND
picture string can contain any character and any number of characters.
However, the special characters listed below will only match up with a
class of characters as follows:
= : Any character, including blank
@ : Any alphabetic character
< : Any lower case character
> : Any upper case character
# : Any numeric character
- : Any non-numeric character
^ : Any non-blank character
$ : Any special character
% : Any extended character (128-254)
. : Any non-printable character
For the CHANGE primary command, the 'to-str' text can be any regular
text or a picture string (and the 'from-str' does not necessarily need
to be a picture string). However, when using a picture string for the
'to-str' text, both the 'from-str' and 'to-str' must be of the same
length. The 'to-str' affects the text *found* by the 'from-str' on a
character by character correspondence. Where each character will be
replace with a corresponding 'to-str' character except when one of the
special character listed below is encountered, in which case it will
act as a class of characters and do the following:
= : The original corresponding character remains unmodified
> : Converts the corresponding character to upper case
< : Converts the corresponding character to lower case
(Back To Top)
PROFILE_SETUP_FOR_EDITOR -----------------------------------------------
CWTE can have up to three profile files as the means to add or modify
settings within CWTE. Each of these are found with reference to the
directory where CWTE is started up and the presence of each is
optional. The first to be scanned is the GLOBAL profile file and is
for the anywhere use of the editor that generally defines the overall
default usage of the editor. The second profile file to be scanned is
the one found in the parent directory and generally would be shared by
one or more common directories for a class of work. The third profile
file to be scanned is the one in the current directory. This will be
for the most specific use of the editor. These profile files and their
configuration assignments will provide common portability across the
supported platforms. Note however, that the profile files are not
needed if you are willing to use the built-in defaults, but most
likely you will have your own preferences.
When CWTE first starts up or is instructed to reset the profile
settings, in all cases the following update sequence will take place:
1) The program presets all options to the program defaults.
2) If found, applies assignments found in the CWTE-Ref directory.
3) If found, applies assignments found in the parent directory.
4) If found, applies assignments found in the default directory.
With respect to the profile files, the first step is to find the
GLOBAL profile file and apply those settings. If this file is to
exist, it must be in a predefined directory name, a predefined file
name, and located as follows:
UNIX :
The directory is named ".CWTE-Ref" (this is a hidden directory)
and must be located in the users $HOME directory. The profile file
is named "CWTE-Gbl".
WINDOWS / DOS :
The directory is named "CWTE-Ref" and can be located in one of two
places. The first place searched is the users %USERPROFILE% (HOME)
directory and if not found there, the root directory of the disk
where the Windows product is installed (like a Win95 machine). The
profile file is named "CWTE-Gbl".
Also, a HELP file (this file) and an OVERVIEW file is expected to be
within in the above directory if the CWTE program is to find them.
These must be named "CWTE-Help.txt" and "CWTE-OVue.txt" respectively.
Next, a search is done for the DIRECTORY profile files and apply those
settings by first looking in the parent directory and then the current
directory. The name of these profile file(s) for the various platforms
is as follows:
UNIX :
This file is named ".CWTE-Dir" (marked as a hidden file).
WINDOWS / DOS :
This file is named "CWTE-Dir". If you prefer not to see this file
within Windows Explorer or in the CWTE FList view, refer to the
'HideProf=' profile setting below.
If you create or move any profile file while CWTE is running, you will
need to restart CWTE or execute the primary command SETPROF to properly
detect the profile files and have the new settings applied.
The profile files can be created in many ways, but to have them
recognized in CWTE to update the profiles when the files are saved,
you need to use either the SG_PROF or SD_PROF commands (see
PRIMARY_COMMAND_FUNCTIONS). The SG_PROF command loads up the GLOBAL
profile file and the SD_PROF command loads up the DIRECTORY related
profile files (regardless if they exist or not). These commands
conveniently allow you to make changes and when saved, the updates
will be applied automatically to CWTE. Note that when using the
SD_PROF command, it will first load the current directory profile
file, but if it is already in the current view, it will then load the
parent profile file. There after, the SD_PROF command will rotate
between the two profile files views (it does not reload the data).
The format and content of these files are as follows. All keywords are
case insensitive. The "=" character must be appended directly to the
keyword, thus making it a part of the keyword. If this is not the
case, it will be treated as an ignored entry. If the line does not
start with one of the defined keywords below, that line will also be
ignored and processing will continue on the next line.
Delim= { ! | # | $ | % | ; }
Multiple primary commands can be entered at one time in the
command field by separating the commands with this delimiter
character (which defaults as "!"). This also applies to the
command stream within a given FKey= assignment. If the default
cannot be used for technical or preference reasons, use this
option to change it to one of the above listed characters.
FKey#= [ ! ] primary_command_and_parms [ ! ] [ ... ] [ ! ]
SFKey#= [ ! ] primary_command_and_parms [ ! ] [ ... ] [ ! ]
CFKey#= [ ! ] primary_command_and_parms [ ! ] [ ... ] [ ! ]
The "#" is the FKey number. There are 12 FKeys, where each key
can have three separate assigned functions based on whether the
SHIFT, CTRL, or neither of these keys is active when pressing
the FKey. The text following the FKey#= can be any valid
primary command. The validity of this data is not checked until
execution time. Any tab characters in the assignment will be
converted to a single blank character.
** Note: It is recommended that the default key assignments be
maintained. This will help reduce possible confusion with
other CWTE users when discussing the use of the CWTE editor.
EditMode= { Y[ES] | N[O] }
This is primarily designed to override the startup mode of
CWTE, which by default is edit mode. There may be some cases
where will prefer to start up in browse mode.
SortDir= { T[op] | B[ottom] | M[ix] }
Use this option to change where directory entries are sorted to
in the FList views. They can be sorted to the top (T), bottom
(B), or mixed with the files (M). The default is Bottom.
Scroll= scroll_value
Refer to the SCROLL primary command for information on the
values for the scroll_value. The default is 0 (cursor scroll).
TabSet= tab_position_marks
Used for key-tab positions. A tab position mark can be any
non-blank character. The tab for column one begins immediately
after the keyword. Refer to the TABS line command above for
more detailed information.
rcWrap= { Y[ES] | N[O] }
Refer to the RCWRAP primary command for information relating to
this keyword.
tfSpace= { 1 | 2 }
This keyword is used during the TF and J line commands and
specifies how many blanks are appended to the end of a text
line when appending the next line. A '1' appends a single
blank, while other values appends a double blank (the default).
HideProf= { 0 | 1 }
This keyword is only meaningful within the Windows/D32 versions
of CWTE. This keyword is used to hide/unhide the CWTE-Dir file
at the time the file is saved if the command SD_PROF is used to
start the edit. A '1' means to hide the file, '0' means to
unhide the file. If this keyword cannot be detected, the
hide/unhide state will not be changed. Also, see 'IncFiles='
with respect to seeing this file within the FList view.
IncFiles= [n]
This keyword determines if the system/hidden entries will be
included in the selection of the Flist view. This value is a
number as follows or the sum of these (the default is 0):
1 = To View Hidden Files
2 = To View System Files (only on Windows)
SetBeep= { ON | OFF }
Enable (ON) or disable (OFF) the beep tones in CWTE. If this is
not specified, CWTE starts up with BEEP ON.
DPaste= { Y[ES] | N[O] }
Use this option to allow the right button of the mouse to act
like the Windows DOS cut/paste operation (a nice feature for
the two button laptops and the bothersome middle button wheel).
When this option equals YES, the cut/paste operation acts the
same for both Unix and Windows. That is, pressing the left
button and dragging the mouse will hilite the text. When the
left button is released, that ends the hilite operation and the
text stays hilited. To get a copy of the hilited text into the
cut buffer, you would press the right mouse button. If there is
no text hilited, then pressing the right mouse button will
cause a text paste operation (if there is text in the cut
buffer). In both Unix and Windows, the middle button normally
does the paste operation. Setting this option to 'Yes' allows
the right button to do pasting as well. The default is 'No'.
HelpFile= { c } { File-Name-To-Browse }
This keyword setting is used by the HELP primary command to
select and browse a text file of your choice. Multiple entries
can be entered for different files by using a different
character 'c' (1-9 or A-Z) for each (this can be a word, but
only the first character is used and is case insensitive). When
using the HELP primary command, passing this character will
select the appropriate help file of choice. Further, if during
startup CWTE finds the "CWTE-Help.txt", "CWTE-OVue.txt", and
LICENSE.txt files in the "CWTE-Ref" directory, by default they
will be assigned the letters, 'H', 'O', and 'L' characters
respectively. See the HELP primary command.
saaB= { DSC | RAP } { MATCH_TEXT } { PROGRAM_STRING %1% }
saaE= { DSC | RAP } { MATCH_TEXT } { PROGRAM_STRING %1% }
These keywords are used by the SAA line command to define a
non-CWTE application that is to be applied to the selected file
or URL string. This option can also be used to override other
associations. Use the SaaB= option for matching up the
BEGINNING characters of the %1% string and SaaE= for matching
up the ENDING characters (the matching is not case sensitive).
Next, select whether to use the DSC or RAP primary command for
this operation. Next, specify MATCH_TEXT with the text that is
to match the beginning or ending of the %1% string. Next,
specify PROGRAM_STRING with the path/program and associated
parameters that are to be used to process the %1% string (file
or URL). The %1% characters are optional, but should be
specified if the filename/text is mixed within the parameters
or needs to be quoted. If a match cannot be found from within
this list, the %1% substituted string will be passed to the
operating system to resolve the application to be used. If no
application can be found, it will be considered a failed
operation. See PRIMARY_COMMAND_FUNCTIONS for the DSC and RAP
usage. See LINE_COMMAND_FUNCTIONS for the SAA usage. The
following are examples:
saaB= RAP http SomeWebBrowserPgm %1%
saaE= RAP .jpg SomePicViewerPgm %1%
saaE= DSC .bat %1% -f -parm
FilSizLmt= { n | X }
File Size Limit: This is primarily designed to limit the amount
of data (the maximum number of bytes) that CWTE will read in
before aborting a read operation (prevents reading huge files).
The maximum value of 'n' is 500MB and the minimum is 500KB. The
default is 5MB. If you need more than 500MB, then use 'X' which
will turn off this checking.
Option= unique_os_platform_option
The Option= has further keywords that are unique to each
operating system. If the particular operating system does not
recognize a keyword or the value setting, then the line will be
ignored and processing continues to the next line. See
MS-WINDOWS_SPECIFIC_OPERATION, DOS_SPECIFIC_OPERATION, and
X-WINDOWS_SPECIFIC_OPERATION for more details.
COLOR_SETUP_FOR_DISPLAY ------------------------------------------------
The color assignment for the CWTE display can be changed within the
profile files. This is done through the Option= keyword. Listed below
is the syntax and the current set of color options. These assignments
represent the default settings as if the following statements were set
in the PROFILE file (those in "()" are for a monochrome display):
Option= TextBG : Black (Black) # Text area background
Option= TrimBG : Black (Black) # Trim area background
Option= LcmdBG : Black (Black) # Line cmd background
Option= TextFG : Lgreen (White) # Text area foreground
Option= FlstFG : LMagenta (White) # FList area foreground
Option= PcmdFG : LRed (White) # Primary cmd foreground
Option= TxHiFG : Yellow (Black) # Text area HiLite foreground
Option= TxHiBG : Black (White) # Text area HiLite background
Option= LcmdFG : Cyan (White) # Line cmd foreground
Option= LcHiFG : White (Grey) # Line cmd HiLite foreground
Option= TrimFG : Yellow (White) # Trim area foreground
Option= TmsgFG : LMagenta (Grey) # Trim message area foreground
There are 16 predefined color names that can be used to set colors
within the profile files. The table below list the colors and various
information associated with each color.
ColorName EGA-Color RGB-Valu MonoChrome
--------- -- FG - BG - -------- - FG ---- BG ----
Black 00-Norm/Norm 0x000000 White Black
Blue 01-Norm/Norm 0x00A800 UL-White
Green 02-Norm/Norm 0x00A800
Cyan 03-Norm/Norm 0x00A8A8
Red 04-Norm/Norm 0xA80000
Magenta 05-Norm/Norm 0xA800A8
Brown 06-Norm/Norm 0xA85000
LGrey 07-Norm/Norm 0xA8A8A8 Black White
Grey 08-Norm/Blnk 0x505050 LWhite BlnkBlack
LBlue 09-Norm/Blnk 0x5050FF UL-LWhite
LGreen 10-Norm/Blnk 0x50FF50
LCyan 11-Norm/Blnk 0x50FFFF
LRed 12-Norm/Blnk 0xFF5050
LMagenta 13-Norm/Blnk 0xFF50FF
Yellow 14-Norm/Blnk 0xFFFF50
White 15-Norm/Blnk 0xFFFFFF LBlack BlnkWhite
** Note: UL = UnderLine, Blnk = Blinking.
Colors prefixed with "L" are Lite/Bright colors.
Under the PC-DOS version of CWTE, you will be limited to the EGA or
Monochrome variation of the above color names.
For the W9x, WinXP, Win7, and X-Windows versions, you can further
apply your own personal choice of RGB values. The following is an
example of setting the RGB color value of Brown:
Option= TmsgFG : 0xA85000 # Red=A8 Green=50 Blue=00
X-WINDOWS_SPECIFIC_OPERATION -------------------------------------------
Mouse Button COPY/PASTE Operations
---------------------------------
To perform a COPY operation, place the pointer at a starting position,
press button one, and drag the pointer to the desired ending position.
To make corner to corner block (box) marking, press and hold the SHIFT
key down before and after pressing button one. When the desired text
is marked, release button one. This will immediately make a copy of
the marked text and places it in the COPY buffer.
To perform a PASTE operation, place the cursor (not the mouse pointer)
at the desired entry point. Then use either the key sequence Cntl-V or
press the middle mouse button to enter the text at that starting
location. The insert key will determine if the text is to be inserted
and only affects the first line that pasting is started on. If some of
the text flows to following lines, the editor will insert new lines
for the text to enter into. The PASTE operation can also perform
corner to corner pasting by pressing and holding the SHIFT key down
before pressing either the key sequence Cntl-V or the middle mouse
button. Also see 'DPaste=' under PROFILE_SETUP_FOR_EDITOR.
Mouse Button Scrolling
----------------------
For versions of CWTE where a mouse can be used and the middle button
has a wheel on it, the button wheel can be used to scroll the editor
vertically, regardless of where the cursor is located.
Profile Options
---------------
CWTE under X-Windows can accept a few Xdefaults resources to modify
some aspects of CWTE. Below is a list of Xdefaults for CWTE. The
assignments below represent the default settings of CWTE. You can copy
these to your Xdefaults file and set the values to your choosing
(don't add the stuff after and including the "#", which are only
references for this guide).
cwtee*geometry: =+0+0 # Window placement
cwtee*font: fixed # Text font
cwtee*cursorColor: Red # cursor color
cwtee*pointerColor: SkyBlue # pointer color
cwtee*warp: true # warp pointer at start up
cwtee*deiconWarp: false # warp pointer at de-icon'ing
cwtee*pointerShape: 132 # pointer image shape value
The above resources can also be passed through the command line
parameter using the "-xrm" parameter. For example, to change or set
the window placement position upon invocation:
cwtee -xrm "*geometry:+10+10" ...
Here are some other pointerShape options you may want to consider:
68 = left_ptr ........ (points left/up)
86 = pencil .......... (points right/down)
94 = right_ptr ....... (points right/up)
132 = top_left_arrow .. (points left/up)
152 = xterm ........... (letter I shape)
The following are options that can only be applied through the PROFILE
file via the Option= keyword.
Option= SetCols : 72 # Number of visible text cols
Option= SetRows : 44 # Number of visible text rows
Option= WinOffs : +0+0 # Win Offset upper left corners
Option= TossKey : { Y[ES] | N[O] }
The SetCols/SetRows options control setting the number of text Columns
and Rows used in CWTE. The WinOffs can be used to position the CWTE
window to a specific offset from the upper left corners of the desktop
and CWTE window. Using a '-1' value will cause the program to center
the CWTE window in the desktop display.
**Note** Due to the X-Windows architecture, the WinOffs assignment
may not work as expected. You may need to comment out this
option and use the .Xdefaults file via the *geometry
assignment or the command line parameter "-xrm".
The TossKey setting is for responding to the auto-repeat key action.
If the key buffer overruns CWTE, the extra duplicate key entries can
be tossed. This is a handy feature if you use the auto-repeat feature
a lot, particularly on networked terminals.
The maximum text line length that CWTE can handle under X-Windows is
9,999 columns. Any text read from a file that is longer than this
will be wrapped to the next line.
MS-WINDOWS_SPECIFIC_OPERATION ------------------------------------------
Mouse Button COPY/PASTE Operations
---------------------------------
To perform a COPY operation, place the pointer at a starting position,
press button one, and drag the pointer to the desired ending position.
To make corner to corner block (box) marking, press and hold the SHIFT
key down before and after pressing button one. When the desired text
is marked, release button one. You can now use either the key sequence
Cntl-C or press the right mouse button to extract a copy of the marked
text and place it in the MS-Windows ClipBoard.
To perform a PASTE operation, place the cursor (not the mouse pointer)
at the desired entry point. Then use either the key sequence Cntl-V or
press the middle mouse button to enter the text at that starting
location. The insert key will determine if the text is to be inserted
and only affects the first line that pasting is started on. If some of
the text flows to following lines, the editor will insert new lines
for the text to enter into. The PASTE operation can also perform
corner to corner pasting by pressing and holding the SHIFT key down
before pressing either the key sequence Cntl-V or the middle mouse
button. Also see 'DPaste=' under PROFILE_SETUP_FOR_EDITOR.
** Note: The MS-Windows concept of replacing hilited text with the
new pasted text is not supported. You need to first delete the
unwanted text and then paste in the new.
Profile Options
---------------
The following are options that can only be applied through the PROFILE
file via the Option= keyword.
Option= SetCols : 72 # Number of visible text cols
Option= SetRows : 44 # Number of visible text rows
Option= WinOffs : +0+0 # Win Offset upper left corners
Option= FontType : OEM # type of font to use
Option= FontSize : 2 # font size in range of 1-5
The SetCols/SetRows options control setting the number of text Columns
and Rows used in CWTE. The WinOffs can be used to position the CWTE
window to a specific offset from the upper left corners of the desktop
and CWTE window. Using a negative value will cause the program to
center the CWTE window in the desktop display.
Currently, the font selection is limited to three font types: OEM,
SYSTEM, and ANSI (only mono spaced fonts). The default is OEM. The
font size can be changed in increments of 1 to 5 (2 is the default).
The font is set when the editor starts up and cannot be changed
thereafter.
Color options can also be specified. See COLOR_SETUP_FOR_DISPLAY for
more information.
The maximum text line length that CWTE can handle under the various
Microsoft Window versions is 3,000 columns. Any text read from a file
that is longer than this will be wrapped to the next line.
DOS_SPECIFIC_OPERATION -------------------------------------------------
Mouse Button COPY/PASTE Operations
---------------------------------
The DOS version of CWTE itself does not perform any COPY or PASTE
operations that goes external to CWTE. Nor does the DOS version of
CWTE itself support mouse functions. However, the MS-Windows
environment itself does allow COPY and PASTE operations within the DOS
box of MS-Window (need to set MS-Window properties for this to work).
For the COPY operation, MS-Windows will only do a corner to corner
COPY operation of the visible part of the DOS window. And if the DOS
window is properly set up, the PASTE operation acts like a keyboard
input to CWTE. Also, by using the RCWRAP command, you can get text
wrapping at the window edge.
Profile Options
---------------
Currently, the only options that can be applied through the DOS EDITOR
PROFILE file via the Option= keyword are the color assignments. See
COLOR_SETUP_FOR_DISPLAY for more information.
The maximum text line length that CWTE can handle under PC-DOS is 999
columns. Any text read from a file that is longer than this will be
wrapped to the next line.
FINDING_FILE/DIRECTORY_NAMES -------------------------------------------
When searching for file or directory names, the name can include both
environmental variables and wild cards characters. For CWTE, the
environmental variables are resolved in one of two places: by the
shell command line or in CWTE's primary command line. The using of
single quotes will bypass expansion in CWTE's primary command line and
in the Unix shell (but not in the Windows shell). While wild cards can
be selectively expanded by the shell via quoting, CWTE will always do
wild card expansion of the names both when passed via shell command
line parameters and from CWTE's primary command line. Once the name
has been entered into a FList view or when a file has been opened, any
wild card or environmental characters in the name will remain. If a
file name has environmental or wild card characters that should not be
expanded, try using other wild card selections that would otherwise
pick out those file names.
Another concept that is helpful is knowing that in CWTE, any action to
select a file or directory that comes from the shell, the primary
command line, or selecting a directory in CWTE is always first done by
creating a FList view of the entry(s) found. If the request was not
for a FLIST view, CWTE goes on to determine how many views would have
to be created for the selection. If more that two file views would
have to be created or if there is a mix of file and directory entries,
the FList view remains. Otherwise, when only two or less files are
present, each will be displayed. Or if just one directory is present,
the contents of the directory will be displayed in a FList view.
When selecting entries under the FList view, CWTE can also determine
if a selection is already present in the file ring from a previous
FList selection. It does not try to match human generated selections
because there are too many ways to represent a selection, so no
attempt is made to do so.
FILE_RING_CONCEPTS -----------------------------------------------------
There are several commands to help you find your way around the file
ring. The two most common commands are RINGR (right) and RINGL (left)
which are normally assigned to FKeys. The RING command has several
options to navigate around the file ring. It also has the means to
branch and return to various ring views. Further, the RING command
also has options to move a view to another position within the file
ring. To help you get a mental image for navigating the file ring,
here are the rules of how various views within the file ring come and
go:
- The entries (views) in a file ring can be perceived as sheets of
paper attached to the outside of a large round barrel, where you
would move left or right to view each sheet.
- The RINGL command is like moving yourself left to the next sheet.
- The RINGR command is like moving yourself right to the next sheet.
- When a new view (sheet) is added to the file ring, it is added to
the immediate left of the current view and becomes the new
reference view.
- When a view is closed out, the view that was to the right of the
that view will now become the new reference view.
- Now consider having a FList view where you select several entries
for viewing (either in block form or individually). Each of those
entries will be processed from top to bottom and each will be
placed into the file ring just to the left of the FList view that
is selecting the entries. Thus, the top to bottom list will get
placed in the file ring in a left to right order. Once all the
selected entries are in the file ring, the first of those selected
will become the new reference view. The repeated use of the RINGR
command will step your view from left to right that would represent
the selected entries from top to bottom of the FList view. And
lastly, if you start by viewing the first of those selected and
closing all the views (files) you selected, you will eventually
return to your original FList view.
DATA_RECOVERY_SCHEME ---------------------------------------------------
There is somewhat, but very limited, text line RECOVERY built into
CWTE. Also, there is no reverse un-do feature as such. The recovery is
only for some text lines that will be put into the recall buffer and
can hold the last 50 lines entered (20 for DOS). What can be found in
the recall buffer are: lines that were typed on (modified) that had
already existed, a CHANGE command that affected only one line, single
deleted lines, or the last line of a block of lines being deleted. To
recover lines, use line command LR to display lines in the recall
buffer and use line command MD to make the desired lines a real data
line again. It is suggested that you do a save regularly to
potentially prevent redoing a lot of work. You may also wish to
consider making backups of the file before editing.
|
Web Page Updated February 6, 2014
|
|
|