OS/2 Shareware BBS: 18 REXX/18-REXX.zip/cmdpk164.zip/mlrxshl.inf

OS/2 Help File | 1997-12-22 | 141KB | 3,814 lines

ΓòÉΓòÉΓòÉ 1. CmdShl User's Guide ΓòÉΓòÉΓòÉ

     What's That?
     Installation
     Starting CmdShl
     Environment Variables
     Editing Keys
     Internal Commands
        -  ALIAS
        -  DEFine
        -  QUIT
        -  RULE
        -  RX
        -  CD
     Known Limitations
     Related Files
     National Language Support
     Profile Support
     Internal Functions
     Internal Variables
     Editing Variables
     History


ΓòÉΓòÉΓòÉ 1.1. What's That? ΓòÉΓòÉΓòÉ

CmdShl is a command interpreter front-end.  It mimics the CMD.EXE command line
behavior.  It adds the following features:

   1. You can define the initial insertion/overwriting state.
   2. The TAB and Shift+TAB keys provide smart name completion.
   3. An alias support is included.
   4. You can easily redefine keys assignments via profile.
   5. The "CD" command accepts both "/" and "\".
   6. The "CD -" command switches between current and previous directories.
   7. You can edit lines longer than 255 chars.
   8. A new "RX" internal command.
   9. Using the "CD" command is optional if you want to change to another
      directory (aka "executable" directories).
  10. With the "DEFine" internal command, you can set a key's value (either a
      text or a command).
  11. The "CD" command can use the CDPATH environment variable.
  12. The "executable" directories feature is optional (enabled by default).
  13. Optional command name validation (if an unknown command name is entered,
      it is highlighted).
  14. You can copy/paste text from line to line.
  15. You can expand parameters (even environment variable and aliases, for
      easy editing).
  16. The "CD" command allows partial path substitution.
  17. and much, much more...

 Note:  CmdShl can also be used as a front-end for 4OS2, or with any command
        interpreter which provides a REXX interface.


ΓòÉΓòÉΓòÉ 1.2. Installation ΓòÉΓòÉΓòÉ

Installing CmdShl is very simple:  just copy CMDSHL.CMD somewhere along your
PATH, REXXVIO.DLL somewhere along your LIBPATH and, if you want to use a
profile file, customize PROFILE.SHL and move it somewhere along your DPATH.

If REXXVIO.DLL is currently in use, close ALL your OS/2 windowed or fullscreen
sessions, and open a bare OS/2 windowed session (that is, one not starting
CmdShl of Fl).  You can then replace REXXVIO.DLL from this session.

If you were using a previous version of MLRXSHL, execute the following code
from an OS/2 command prompt, to allow the new functions defined in REXXVIO to
be registered:

   rexxtry call VioDropFuncs

If you want to use CmdShl whenever you open an OS/2 session, you can add the
following statement in the "Parameter" field of your OS/2 Windowed (or
fullscreen) session object:

   /k "cmdshl"


ΓòÉΓòÉΓòÉ 1.3. Starting CmdShl ΓòÉΓòÉΓòÉ

Syntax

   cmdshl [/?] [/I|/O] [/P profile] [/C command|/K command]

Parameters

   /?         -  Display a short explanation for CmdShl;

   /I         -  Use Insert mode by default (default);
   /O         -  Use Overstrike mode by default;

   /P profile -  Use profile instead of "PROFILE.SHL";

   /C cmd     -  Just like the CMD.EXE /C switch;
   /K cmd     -  Just like the CMD.EXE /K switch.

Examples

   CMDSHL
   CMDSHL /C DIR
   CMDSHL /K ALIAS @myalias


ΓòÉΓòÉΓòÉ 1.4. Environment variables ΓòÉΓòÉΓòÉ

CmdShl recognizes the following environment variables:

   CDPATH
   CMDSHL.PROMPT
   CMDSHL.PROMPT.environment
   PROMPT

   HELP.COMMAND
   HELP.SWITCHES

If one or more of those environment variables are not defined, the missing ones
are silently ignored.

The last two environment variables are used to define an optional external help
subsystem.


ΓòÉΓòÉΓòÉ 1.4.1. CDPATH ΓòÉΓòÉΓòÉ

This environment variable specifies the path along which the CD command should
search for directories.

   SET CDPATH=[path[;...]]

Example

   SET CDPATH=E:\LOCAL;E:\;E:\OS2;E:\TCPIP;


ΓòÉΓòÉΓòÉ 1.4.2. CMDSHL.PROMPT ΓòÉΓòÉΓòÉ

This environment variable specifies the prompt to be used if no specific prompt
is defined for the current environment.  It takes precedence over PROMPT.

See the PROMPT section for details on the possible values of CMDSHL.PROMPT.


ΓòÉΓòÉΓòÉ 1.4.3. CMDSHL.PROMPT.environment ΓòÉΓòÉΓòÉ

This environment variable specifies the prompt to be used in the given
environment.  It takes precedence over  CMDSHL.PROMPT and PROMPT.

For example, you can define two different prompts for two different (possible)
environments:

   SET CMDSHL.PROMPT.CMD=$i[$p]$s
   SET CMDSHL.PROMPT.EDIT=EDIT:[$p]$s

See the PROMPT section for details on the possible values of
CMDSHL.PROMPT.environment.


ΓòÉΓòÉΓòÉ 1.4.4. PROMPT ΓòÉΓòÉΓòÉ

This environment variable specifies the prompt to be used if no more specific
prompt is defined.  If PROMPT is undefined, '[$p]' is assumed.

   SET PROMPT=text

The following symbols can be used to define a new prompt.  Each symbol must be
preceded by a dollar symbol ($):

 $         $ symbol
 _         Carriage Return / Line Feed sequence
 A         & symbol
 B         | symbol (pipe)
 C         ( symbol
 D         Date
 E         ASCII Code 27 (escape)
 F         ) symbol
 G         > symbol
 H         Backspace
 I         Help bar
 L         < symbol
 N         Default disk unit (e.g. A:)
 P         Current directory (e.g. E:\OS2)
 Q         = symbol
 R         Return code
 S         Space
 T         Time
 V         Version number

 All other symbols are emitted without changes.

 Example

     SET PROMPT=$i$e[33m{$r}$e[32;1m[$p]$e[0m$s


ΓòÉΓòÉΓòÉ 1.4.5. HELP.COMMAND ΓòÉΓòÉΓòÉ

If this environment variable is defined, CmdShl will not use its build-in help
messages for internal commands.  Instead, it will call the script/application
defined by this variable.

For example, if HELP.COMMAND is defined as:

   SET HELP.COMMAND=ECHO Help for

Issuing 'ALIAS /?' will give:

   Help for ALIAS /?

(In other words, the command is displayed back to the user.)

The syntax of the call is the following:

   call %HELP.COMMAND% <command> <args>

where <command> is the upper-cased full command name (namely, one of ALIAS, CD,
CMDSHL, DEFINE, QUIT or RULE) and <args> the argument(s) given to the command
by the user.


ΓòÉΓòÉΓòÉ 1.4.6. HELP.SWITCHES ΓòÉΓòÉΓòÉ

If this environment variable is defined, it is used as the default value for
the helpSwitches environment variable.  If HELP.SWITCHES is not defined, the
default value for helpSwitches is '/?'.

See the helpSwitches definition in CmdShl internal variables for more details.


ΓòÉΓòÉΓòÉ 1.5. Editing Keys ΓòÉΓòÉΓòÉ

By default, CmdShl uses CMD.EXE editing commands, as well as some EPM keys,
that is:

 Alt+C
           Copies the marked text.
 Alt+D
           Deletes the current mark.
 Alt+M
           Moves the current mark.
 Alt+U
           Removes the current mark.
 Alt+W
           Marks the word at the current cursor position using a character
           mark.
 Alt+Z
           Character-marks the current character.
 Backspace
           Deletes the character to the left of the cursor.
 Ctrl+E
 Ctrl+End
           Erases from the current cursor position to the end of the line.
 Ctrl+Home
           Erases from the beginning of the line to the current cursor
           position.
 Ctrl+K
           Duplicates the element preceding the cursor.  (A space is added
           between the elements, and completion state is preserved.)
 Ctrl+Left arrow
           Moves the cursor to the beginning of the word.
 Ctrl+Right arrow
           Moves the cursor to the beginning of the next word.
 Ctrl+X
           Expands the element preceding the cursor.
 Del
           Deletes the character at the current cursor position.
 Down arrow
           Recalls the next entry in the command history list.
 End
           Moves the cursor to the end of the line.
 Esc
           Erases the command line.
 F1
           Finds the previous entry in the command history list matching the
           beginning of the line (from the beginning to the current cursor
           position).
 Home
           Moves the cursor to the beginning of the line.
 Ins
           Switches between insert and replace modes.
 Left arrow
           Moves the cursor one position to the left.
 Right arrow
           Moves the cursor one position to the right.
 Shift+Tab
           Replaces the element preceding the cursor with the previous matching
           item.
 Space
           Insert a space and check the validity of the element preceding the
           cursor if it is a command.
 Tab
           Replaces the element preceding the cursor with the next matching
           item.
 Up arrow
           Recalls the previous entry in the command history list.

 But you can redefine almost all keys to suit your needs.  As an example, the
 default PROFILE.SHL file provides the following additional editing keys:

     (                                -- insert () and move cursor inside
     F3                               -- close the current session
     F8                               -- insert current date
     Shift+F7                         -- show all matching file names
     F2, F5, F7                       -- save, load and rename
                                      -- history list
     Ctrl+R                           -- search command in history
     Ctrl+F                           -- search next match in history
     Ctrl+Down arrow                  -- save current screen
     Ctrl+Up arrow                    -- restore last screen


ΓòÉΓòÉΓòÉ 1.5.1. The expand Internal Action ΓòÉΓòÉΓòÉ

The expand internal action is used to expand the element preceding the cursor.
That is:

     If the element is in a command position, it is replaced with its complete
      filename (with full path) if applicable -- if it's an alias or an
      internal command, it remains unchanged.  If it's an invalid command, it
      is highlighted;
     If the element follows an ALIAS internal command, and ends with an equal
      sign, the alias value is inserted (if available);
     If the element follows a RULE internal command, and ends with an equal
      sign, the rule value is inserted (if available);
     If the element ends with an equal sign, and if an environment variable of
      that name exists, its value is inserted;
     Otherwise, if the element contains environment variable names surrounded
      by percent sign, these parts are replaced with the environment variables
      values.

 In the following examples, the cursor is supposed to be the underscore sign.

     keyb_fr                 -->  c:\OS2\keyb.com_fr
     keyb fr_                -->  keyb fr_
     alias xrn=_             -->  alias xrn=e:\local\yarn ^& yarn.exe ^& cd -
     rule RD=_               -->  rule RD=%d %d*^|/?
     set etc=_               -->  set etc=d:\tcpip\etc
     type %etc%\connect.log_ -->  type d:\tcpip\etc\connect.log_


ΓòÉΓòÉΓòÉ 1.5.2. The tab and backtab Internal Actions ΓòÉΓòÉΓòÉ

The tab and backtab internal actions are used to complete the element preceding
the cursor.  That is:

     If the element at this position is expected to be an environment
      variable, an environment variable name whose name begins with the element
      preceding the cursor is searched for;
     If the element at this position is expected to be a directory, a
      directory name whose name begins with the element preceding the cursor is
      searched for -- the element preceding the cursor can contain wildcards;
     If the element at this position is expected to be a keyword or a symbol,
      nothing occurs;
     Otherwise, a file or directory whose name begins with the element
      preceding the cursor is searched for -- the element preceding the cursor
      can contain wildcards.

 When more than one matching item is found, the tab and backtab internal
 actions are used to enumerate the possibilities.

 The type of the element at cursor position is determined by user-defined
 rules.  When no such rule exists, a file or directory whose name begins with
 the element preceding the cursor is searched for.  The following rules are
 predefined (they can be redefined at will):

     CD           %d|%f %f|/?|
     CHDIR        %d|/?|
     DETACH       %x
     FOR          %%%l IN (%*) DO %x
     RD           %d %d*|/?
     RMDIR        %d %d*|/?
     SET          %e=%*|/?|
     START        "%*" %o %x|"%*" %o|%o %x|%o

 See the RULE command for details on rules.


ΓòÉΓòÉΓòÉ 1.5.3. The space Internal Action ΓòÉΓòÉΓòÉ

The space internal action is used to insert (or overstrike) a space and to
check the validity of the command preceding it.  That is to say, the command
preceding the cursor is checked if it is in a command (findcontexttype()
returns 'c') or invalid (findcontexttype() returns '0') context, as defined by
rules.

If it is a command context, nothing happens if the command found is valid.
Otherwise, invalidCmd is evaluated.  If it is an invalid context, invalidCmd is
evaluated too.

invalidCmd by default flags the offending command in red, but it can be
redefined by the user.  See its definition in the Internal Variables section
for details.


ΓòÉΓòÉΓòÉ 1.6. Internal Commands ΓòÉΓòÉΓòÉ

CmdShl adds the following "internal" commands:

   ALIAS [LIST|@file|alias=[cmd]]
   DEFine key [value]
   QUIT
   RULE [LIST|@file|rule=[def]]
   RX cmd

And it "enhances" the following underlying shell commands:

   CD [directory|string1 string2]


ΓòÉΓòÉΓòÉ 1.6.1. ALIAS ΓòÉΓòÉΓòÉ

The ALIAS command is used to view/define/remove aliases.  Alias names ARE
case-sensitive.  Recursive aliases are not allowed (but an alias can use
another alias).  And an alias can use all CmdShl's internal commands.

ALIAS ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇLISTΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                       Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇ@fileΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                       ΓööΓöÇalias=Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γöÿ
                               ΓööΓöÇvalueΓöÇΓöÿ

     To view all defined aliases, issue the "ALIAS LIST" command.
     To save all defined aliases in a file, redirect the previous command
      output into a file, as in "ALIAS LIST >mylist".
     To load an alias list, use "ALIAS @mylist" (where "mylist" is a file
      containing alias definitions).
     To remove an existing alias, use an empty definition, as in "ALIAS foo=".
     To define a new alias, use "ALIAS alias=def", where "alias" is the alias
      name, and "def" its definition (any valid command).  In addition, you can
      use the "%*" parameter as well as "%n" (where n is the argument number in
      range 0..9, 0 being the alias name), which denotes "runtime" parameters.
      (If "%n" is immediately followed by '*', it means "arg n and all
      remaining args".)  Here are some aliases definitions:

               ALIAS dir=dir %* ^| less
               ALIAS prj=cd \user\alpha\smith\MyProject\Current
               ALIAS makeprj=prj ^& nmake
               ALIAS calc=rx say %*; RC=0
               ALIAS in=cd %1 ^& %2* ^& cd -

 Note:  An alias can redefine an existing command, as "dir" in the previous
        list.  The right-hand-side "dir" is the CMD.EXE internal command --
        recursive aliases are not allowed, and hence this second "dir" cannot
        be an alias, so it must be something else (a CMD.EXE internal command
        in this very case).

 When defining aliases from the command line, you may have to quote special
 symbols (such as '&'  and '|') with a '^' in order to prevent unexpected
 results.  For example, the first (dir), third (makeprj) and last (in) aliases
 require an '^' in front of their '&'s when entered from the command line.

 When the execution of an alias is interrupted by the user (by the mean of
 Ctrl+C or Ctrl+Break), the execution of the alias is interrupted, as is the
 execution of the possibly following commands in the current command line.


ΓòÉΓòÉΓòÉ 1.6.2. DEFine ΓòÉΓòÉΓòÉ

The DEFine command is used to [re]define a key.  You can either assign to a key
an internal action, an immediate command or a static text.  You can also remove
a key definition (the key will then returns its default value).

DEFine ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇkeyΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                                     ΓööΓöÇΓöÇΓöÇvalueΓöÇΓöÇΓöÇΓöÿ

[In this section, if a command name is shown in mixed case, as "DEFine" above,
it means it can be abbreviated.  That is, you can use either "DEF", "DEFI",
"DEFIN" or "DEFINE" -- upper-cased letters are required, others are optional.]

keys names

By default, the following keys-name are defined:

   A-C, A-D, A-M, A-U, A-W, A-Z, A-F10, BKSP, CURD, CURL, CURR, CURU,
   C-CURL, C-CURR, C-E, C-END, C-HOME, C-PGDN, C-PGUP, C-X, DEL, END,
   ENTER, ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12,
   HOME, INS, PGDN, PGUP, SPACE, S-TAB, TAB

[Shifted keys have a "S-" prefix, control keys have a "C-" prefix and Alt keys
have a "A-" prefix.]

Note:  If you want to define another key, you have to define a synonym, as in:

                 RX S_F7='005A'x; C_A='01'x

The variable name is the key name, with an "_" instead of a "-", as you can't
use "-" in a REXX variable name, and the key name value is the hexadecimal
value returned by the getKey function.  You can use the following CmdShl
command to find this value for a key:

   RX call getkey; say "'"substr(ckey,2)"'x"

 Keys values

 The following internal actions are available:

     backmatch, backsp, backtab, cdown, cleft, cright, ctrlend, ctrlhome,
     ctrlleft, ctrlright, cup, del, dup, end, enter, esc, expand, home,
     ins, mark (char|clear|copy|word|delete|move), match, space, tab

 If you assign an internal action to a key, this key will act just as if the
 internal action was used.  If you want to assign more than one internal action
 to a key, you can use the MC command.

 For example, if you want the C_A key to act as the Home key (if you're used to
 EMACS), use:

     DEFINE C-A home

 And, if you don't like the command validity check, use:

     DEFINE SPACE

 [That is, restore default behavior -- you can use "DEFINE SPACE space" to undo
 your change.]

 Miscellaneous

 If you want to assign a static text to a key, use the TEXT command:

     DEFINE A_F10 TEXT Hello World!

 If you want to assign an immediate command, use the OSNowait statement (or its
 SHELL synonym).  It can be followed by any CmdShl valid command(s):

     DEFINE F3 OSNowait EXIT

 Now, if you hit F3, your session will be closed.

 If you want to assign more than one command to a key, use the MC command:

     DEFINE " MC /TEXT ""/cleft

 The first non-blank character following MC is the separator.  It does not have
 to be a "/".

 [See PROFILE1.SHL for more complex keys definitions.]


ΓòÉΓòÉΓòÉ 1.6.3. QUIT ΓòÉΓòÉΓòÉ

The QUIT command is used to exit from CmdShl.  It does not close the underlying
CMD.EXE session.

QUIT ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ


ΓòÉΓòÉΓòÉ 1.6.4. RULE ΓòÉΓòÉΓòÉ

The RULE command is used to view/define/remove rules.  Rules names ARE
case-sensitive but a case-insensitive rule is assumed if rule name is in
UPPERCASE.

Rules are used to help providing smart completion  and command checking.

RULE ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇLISTΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇ@fileΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                        ΓööΓöÇrule=Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γöÿ
                               ΓööΓöÇΓöÇdefΓöÇΓöÇΓöÿ

     To view all defined rules, issue the "RULE LIST" command.
     To save all defined rules in a file, redirect the previous command output
      into a file, as in "RULE LIST >myrules".
     To load an rule list, use "RULE @myrules" (where "myrules" is a file
      containing rule definitions).
     To remove an existing rule, use an empty definition, as in "RULE foo=".
     To define a new rule, use "RULE rule=def", where "rule" is the rule name,
      and "def" its definition.  The definition can contain more than one
      clause (in which case the clauses are separated by '|').  When more than
      one definition is given, they are checked from left to right, the first
      matching clause being retained.  When specifying a definition, the
      following elements can be used to denote the argument type: %*, %c, %d,
      %e, %f, %l, %o and %x.  See below for details.

               RULE WHENCE=%f %e
               RULE CD=%d^|%f %f^|/?|

 Note:  When defining rules from the command line, you may have to quote
        special symbols (such as '&'  and '|') with a '^' in order to prevent
        unexpected results.

 Rules

 A rule contains one or more clauses, separated by '|'. Each clause describes a
 possible parameter list for the command.

 In a clause, you can use any literal symbol, or one of the following values:

  (space)  One (or more) space.
 %%        The symbol '%'.
 %(list)   A file name matching at least an element of the space- or
           comma-delimited list.
 %*        Anything.
 %c        A command name.
 %d        A directory name.
 %e        An environment variable name.
 %f        A file name.
 %l        A single letter.
 %o        A (possibly empty) list of options.
 %x        An expression

 For example, the rule for the FOR command would be:

     RULE FOR=%%%l IN (%*) DO %x

 It means that the FOR command requires a '%' sign immediately followed by a
 letter, then one (or more) space, an 'IN' keyword (case insensitive), one (or
 more) space again, an open parent, one or more symbols, a close parent, one
 (or more) space, a 'DO' keyword (case insensitive), one (or more) space and
 finally an expression.

 Another example is the rule for the START command, which contains four
 clauses:

     RULE START="%*" %o %x|"%*" %o|%o %x|%o

 An example using the '%(list)' specification follows:

     RULE EDITINI=%(*.INI *.FOO)

 It means that the (hypothetical) EDITINI command requires a file whose
 extension is either '.INI' or '.FOO' (case insensitive).

 If the last element of a clause is one of the special symbols listed above
 followed by a '*', it means this element can be repeated zero or more time.

 For example, the RD (aka RMDIR) command is described with the following rule
 by default:

     RULE RD=%d %d*|/?

 The first clause specifies thant RD can take one or more directory name on its
 command line.

 Case sensitivity

 The left hand side of a rule respects the following:

     If you want to define a rule for a command, regardless of its case, use
      an all-upper-cased name;
     If you want to define a rule for a case-sensitive command (for example
      for an alias which overrides an internal command or such), use the
      case-sensitive name.

 For example, assuming the following:

     RULE FOO=BAR|BAZ
     RULE foo=FOOBAR
     RULE Foo=FOOBARBAZ

 If you enter "foo", rule 2 is applied.  If you enter "Foo", rule 3 is applied.
 If you enter anything else (such as "FOO" or "foO"), rule 1 applies.

 Note  It means that, if you want to define a specific rule for an
       all-upper-cased command, you have to define the default rule for all
       other cases.

 For example:

     RULE IN=<a special rule>
     RULE In=<the default rule>
     RULE in=<the default rule>
     RULE iN=<the default rule>

 The right hand side respects:

     The special symbols (such as %c, %d, etc.) are case sensitive;
     All other symbols and letters are case insensitive.

 For example, assuming the default rule for FOR, the following entries are all
 valid:

     for %a in (a b) do echo %a
     for %a In (a b) Do echo %a
     for %a IN (a b) DO echo %a

 Predefined rules

 The following rules are defined by default (they describe the various CMD.EXE
 internal commands):

     CD           %d|%f %f|/?|
     CHDIR        %d|/?|
     DETACH       %x
     FOR          %%%l IN (%*) DO %x
     RD           %d %d*|/?
     RMDIR        %d %d*|/?
     SET          %e=%*|/?|
     START        "%*" %o %x|"%*" %o|%o %x|%o

 You can redefine or remove them if needed, by using the RULE command (either
 in a PROFILE file or directly from the command line).

 If no rules is defined for a command, '%*' is assumed.


ΓòÉΓòÉΓòÉ 1.6.5. RX ΓòÉΓòÉΓòÉ

RX is CmdShl's backdoor.  You can use any valid REXX statement as a parameter,
and you can check/set CmdShl internal variables, or call CmdShl internal
functions.  It's useful, but mostly for "power users" :-)

RX ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇstatementΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ

[See PROFILE1.SHL for some RX usage samples.]


ΓòÉΓòÉΓòÉ 1.6.6. CD ΓòÉΓòÉΓòÉ

The CD command now accepts a new parameter, "-", and uses the CDPATH
environment variable.  Additionally, both "\" and "/" can be used in
directories specifications and the drive is changed.  Partial path substitution
is also allowed.

CD ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
                           Γö£ΓöÇΓöÇdirectoryΓöÇΓöÇΓöñ
                           Γö£ΓöÇstr1ΓöÇΓöÇΓöÇstr2ΓöÇΓöñ
                           ΓööΓöÇΓöÇΓöÇΓöÇΓöÇ - ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

The CDPATH environment variable contains a list of paths.  You don't have to
include the current (".") directory in it.  It is always looked up first.

For example, if CDPATH is defined as:

  SET CDPATH=C:\;C:\OS2;

Issuing the "CD APPS" command will bring you to "C:\OS2\APPS" (if there was no
APPS entry in the then-current directory).

A trailing "/" or "\" is allowed in directories specification.

You can perform path substitution.  For example, if you're currently in
C:\project\beta\source and want to switch to C:\project\gamma\source, you can
use "CD BETA GAMMA".

Warning:  If you want to switch to a directory named "-", you'll have to
          enclose it with double quotes, follow it with "\" or precede it with
          ".\" as in:

                       CD "-"
                       CD -\
                       CD .\-


ΓòÉΓòÉΓòÉ 1.7. Known Limitations ΓòÉΓòÉΓòÉ

     When using CmdShl as a CMD.EXE front-end, interrupting the execution of a
      CMD.EXE internal command aborts CmdShl too.  Not much can be done
      regarding this problem except waiting for a new CMD.EXE with a better
      signal handling...

     When using CmdShl as a CMD.EXE front-end with OS/2 2.x, your command-line
      window may not close upon shutdown.  THIS PROBLEM NO LONGER OCCURS WITH
      WARP.

     Alias names ARE case-sensitive.  This is intentional but if you don't
      like it that way, please, let me know!

     If you want to switch to a directory named "-", you'll have to enclose it
      with double quotes or precede it with ".\" or append "\" to it, as in:

               CD "-"
               CD .\-
               CD -\

     When "implied" CD is enabled, a directory name takes the precedence over
      an executable name with no arguments.  That is, if "foo" is a
      subdirectory of the current directory and there also exists a "foo.exe"
      somewhere along the PATH, issuing the "foo" command will change the
      current directory.  If you want to call "foo.exe", either use some
      arguments, or specify the file's extension, as in:

               foo bar
               foo.exe

      [This behavior is the default, but you can choose to give precedence to
      an executable name with no arguments by setting impCD to 2.  See the
      impCD definition in CmdShl internal variables.]

     CmdShl aliases and so-called "internal commands" (i.e., ALIAS, RX, QUIT
      and DEFine) can not be used in sub-expressions.  That is, in:

               for %i in (foo bar) do alias do_%i=baz %i
      or

               (foo prj & bar prj) >foobar.log

      CmdShl's ALIAS command is not called in the first statement, and foo and
      bar cannot be aliases.

     The &  ('and') operator cannot be used in an expression for the RX
      command.  CmdShl interprets it as a command separator.  For example:

               RX say foo & bar

      can be interpreted either as "RX say foo" followed by a "bar" command, or
      as "RX say foo & bar", displaying 1 if foo and bar are both equal to 1
      and 0 otherwise.  As there's no way to choose between those two valid
      interpretations, the first one is retained.

     Due to a limitation with the linein() builtin function, lines in a
      PROFILE file exceeding 250 characters may cause problem.  An easy fix is
      to break it in more than one piece:

               'a very long line...'

      can be entered as:

               'a very',
                  'long line...'

      (Note the ending comma at the end of the first line.)


ΓòÉΓòÉΓòÉ 1.8. Related Files ΓòÉΓòÉΓòÉ

df.cmd [drive ...]

This is a UNIX "df" clone.  It displays all available (or specified) drives,
with their total, used and free capacity.

pushd.cmd [new dir]

This command pushes the current directory in a "directory stack", and
(optionally) changes to the given disk/directory.

popd.cmd

This command pops the head of the directory stack, and go to this new
directory.

whence.cmd file [path]

This command tries to find a file along a path (PATH by default).  If the file
is found, its complete path is displayed.


ΓòÉΓòÉΓòÉ 1.9. National Language Support ΓòÉΓòÉΓòÉ

There's just six language-dependent messages which are not automatically
adjusted:  it's the alias command help string (aliasHelp), the CmdShl help
string (cmdHelp), the define command help string (defHelp), the quit command
help string (quitHelp), the rule command help string (ruleHelp) and the
additional CD help string (cdHelp).  It's at the beginning of the file, and you
can translate it.  Or, even better, you can define them in your PROFILE.SHL
(see below).

All other language-dependent messages are automatically adjusted by CmdShl
(secondary prompt, top of screen help string, ...).


ΓòÉΓòÉΓòÉ 1.10. Profile Support ΓòÉΓòÉΓòÉ

CmdShl supports profile files.  By default, PROFILE.SHL is used, but you can
override it via the /P switch.

If present, the profile file should be somewhere along the DPATH, or you can
alternatively specify its complete path.

A profile file is a plain REXX file.  It's called after command line arguments,
but before any user interaction.  It's usually used to redefine keys
assignments, displaying or setting some session- dependant data, and so on...

Please refer to PROFILE1.SHL for more explanations.


ΓòÉΓòÉΓòÉ 1.10.1. PROFILE1.SHL ΓòÉΓòÉΓòÉ

This is my current profile file, which you can use as a sample profile file for
CmdShl.  [Hint:  for better startup performances, you can remove all comments
-- that is, all except the first.]

For a detailed explanation of the features added by this profile file, read the
end of this section.

/* profile.shl - sample bindings                               971221 */


/* This profile file demonstrates typical profile usage:              */
/*                                                                    */
/*       - Improving/tailoring existing commands, adding shortcuts    */
/*         [The auto-close '(', the insert-date key (F8), and S-F7,   */
/*         which displays all possible filenames.]                    */
/*                                                                    */
/*       - Adding new functions                                       */
/*         [The persistent command history, F2 (save), F5 (load) and  */
/*         F7 (name), tools to search items through command history   */
/*         as well as screen management system with C-UP, C-DOWN and  */
/*         C-PADPLUS.]                                                */
/*                                                                    */
/*       - National Language Support                                  */
/*         [on-line messages in French.]                              */
/*                                                                    */
/*       - Useful global aliases and rules                            */


/* In a profile file, you can use any REXX instruction, but, due to   */
/* the current implementation, it must fit in one line.               */
/*                                                                    */
/* That is, you can use:                                              */
/*                                                                    */
/*     if foo = 'XYZZY' then say 'Nothing happens'; else  x = x + 1   */
/*                                                                    */
/* But you can't use:                                                 */
/*                                                                    */
/*     if foo = 'XYZZY' then                                          */
/*        say 'Twice as much happens'                                 */
/*     else                                                           */
/*        x = x + 1                                                   */
/*                                                                    */
/* Alternatively, you can use the comma as a line continuation marker */
/*                                                                    */
/*     foo = 'Hello',                                                 */
/*           'world'                                                  */
/*                                                                    */
/* Another important difference with standard REXX scripts is that    */
/* you cannot call CmdShl commands in a REXX structure using the      */
/* standard way.  You have to use the eval function.  That is,        */
/*                                                                    */
/*     if answer = 'YES' then                                         */
/*        'DEFINE F12 OSNOWAIT shutdown'                              */
/*     else                                                           */
/*        'DEFINE F12 TEXT shutdown'                                  */
/*                                                                    */
/* does not work.  You have to use:                                   */
/*                                                                    */
/*     if answer = 'YES' then                                         */
/*        call eval 'DEFINE F12 OSNOWAIT shutdown'                    */
/*     else                                                           */
/*        call eval 'DEFINE F12 TEXT shutdown'                        */
/*                                                                    */
/* [But it works just fine outside of a structure.]                   */


/* Note: when a command name is in mixed case, like DEFine below, it  */
/*       means that you can use DEF, DEFI, DEFIN or DEFINE.           */

/*                                                                    */
/* There's currently only one "pseudo" command, DEFine, which is most */
/* useful in profile file. Its syntax is as follows:                  */
/*                                                                    */
/*     DEFine key value                                               */
/*                                                                    */
/* Key is a user-defined key or a predefined one:                     */
/*                                                                    */
/*     A-F10, BKSP, CURD, CURL, CURR, CURU, C-CURL, C-CURR, C-END,    */
/*     C-HOME, C-PGDN, C-PGUP, DEL, END, ENTER, ESC, F1, F2, F3, F4,  */
/*     F5, F6, F7, F8, F9, F10, F11, F12, HOME, INS, PGDN, PGUP,      */
/*     SPACE, S-TAB, TAB                                              */
/*                                                                    */
/*     [Shifted keys have a "S-" prefix, control keys have a "C-"     */
/*      prefix and Alt keys have a "A-" prefix.]                      */
/*                                                                    */
/* and value is an internal action or MC nnn, OSNowait nnn or         */
/* TEXT nnn:                                                          */
/*                                                                    */
/*     backmatch, backsp, cdown, cleft, cright, ctrlend, ctrlhome,    */
/*     ctrlleft, ctrlright, cup, del, end, enter, esc, match, home,   */
/*     ins, tab, space, expand                                        */
/*                                                                    */
/*     TEXT nnn simulates the keyboard entry of nnn                   */
/*                                                                    */
/*     OSNowait cmd executes cmd (via the CmdShl interpreter)         */
/*                                                                    */
/*     MC separator cmd1 separator cmd2... allows the usage of more   */
/*     than one command for a key                                     */
/*                                                                    */
/* All other "pseudo" commands are executed via CmdShl's interpreter. */

/* [In fact, the DEFine command could have been implemented as an     */
/*  alias:                                                            */
/*                                                                    */
/*     ALIAS DEFINE=RX _args="%*";                                    */
/*                     parse value _args with key rest;               */
/*                     if length(key) > 1 then                        */
/*                        key = value(translate(key,"_","-"));        */
/*                     if rest \= "" then                             */
/*                        call value "key._"c2x(key), rest;           */
/*                     else interpret "drop key._"c2x(key)            */
/*                                                                    */
/*  It is functionally equivalent.]                                   */

/* user-defined key name - note the usage of "_" in place of "-" in   */
/*                         the key name (you can't use "-" in a REXX  */
/*                         variable name).                            */
/*                                                                    */
/*                         The value of a key name is the hexadecimal */
/*                         value returned by the getKey function when */
/*                         pressing it (you can use the following     */
/*                         CmdShl command to find it) :               */
/*                                                                    */
/*                         RX call getkey; say "'"substr(ckey,2)"'x"  */

/* Note: by default, variables are hidden when inside a getLine call. */
/*       If you want to expose some of them, add them to the global   */
/*       variable -- global = global "newname1 newname2"              */
/*                                                                    */
/*       So, each time you use one of your variable in the right hand */
/*       side of a DEFine command, you have to expose it.             */


S_F7 = '005A'x; C_CURU = '008D'x; C_CURD = '0091'x; C_PADPLUS = '0090'x

/* defining key value - a shifted key can use "-" or "_" in its name  */
'DEFINE F3 OSNOWAIT EXIT'


/* you can even do complex things:                                    */
'DEFINE (  MC /TEXT ()/cleft'

'DEFINE F8 OSNOWAIT RX line = insert(date(),line,currOfs); currOfs = currOfs+length(date())'

'DEFINE S-F7 osn rx if currTab = 0 then currTab = findcontextcompletion(); if currTab \= 0 then do; say; do i = 1 to tree.0; say tree.i; end; call charout, print(); oline=""; parse value SysCurPos() with origRow origCol .; key="tab"; end'


/* we can even add a new feature: loading/saving commands history     */

/* first, we define a file name (and make it public, F7 requires it): */
history = expand('%tmp%\history.shl'); global = global 'history'

/* then, an alias, LOADHIST, which loads the commands history         */
'ALIAS LOADHIST=RX drop prevLine.; i = 0; do while lines(history); i = i+1; prevLine.i = linein(history); end; prevLine.0 = i; call stream history, "c", "close"'

/* now, we define three function keys, F2 (save), F5 (load/refresh)   */
/* and F7 (name)                                                      */
'DEFINE F2 OSNOWAIT RX "@del /f" history; do i = 1 to prevLine.0; call lineout history, prevLine.i; end; call stream history, "c", "close"'
'DEFINE F5 OSNOWAIT LOADHIST'
'DEFINE F7 OSNOWAIT RX call charout ,"1b"x"[s"||"1b"x"[0;0H"||"1b"x"[1;37;42m"||"1b"x"[KNew history name: "; history=getLine(history); call charout ,"1b"x"[0;0H"||"1b"x"[0;34;47m"||"1b"x"[K"helpstring"1b"x"[0m"||"1b"x"[u"'

/* finally, we load the default history                               */
'LOADHIST'


/* We can even define a screen management system.                     */
scr.0 = 0; global = global 'scr.'

'ALIAS PUSHSCR=RX i = scr.0 + 1; scr.i._C = SysCurPos(); scr.i._P = currOfs origRow origCol; scr.i._L = line; scr.i._S = VioReadCellStr(0,0); scr.i._O = oldDir; scr.i._D = directory(); scr.0 = i'
'ALIAS POPSCR=RX i = scr.0; if i > 0 then do; call VioWrtCellStr 0,0,scr.i._S; line = scr.i._L; call SysCurPos word(scr.i._c,1), word(scr.i._c,2); parse var scr.i._P currOfs origRow origCol; oldDir = scr.i._O; call directory scr.i._D; scr.0 = i-1; end'
'ALIAS SWAPTMPSCR=RX i = scr.0 + 1; scr.i._C = scr._C; scr.i._P = scr._P; scr.i._L = scr._L; scr.i._S = scr._S; scr.i._O = scr._O; scr.i._D = scr._D; scr.0 = i'
'ALIAS SWAPSCR=RX if scr.0 > 0 then do; scr._C = SysCurPos(); scr._P = currOfs origRow origCol; scr._L = line; scr._S = VioReadCellStr(0,0); scr._O = oldDir; scr._D = directory(); call eval "POPSCR & SWAPTMPSCR"; end'

'DEFINE C-CURD OSNOWAIT PUSHSCR'
'DEFINE C-CURU OSNOWAIT POPSCR'
'DEFINE C-PADPLUS OSNOWAIT SWAPSCR'

/* We redefine C-K to a smarter duplication function.                 */
'DEFINE C-K MC /dup/tab'

/* We define tools to search through command history.                 */
C_F = '06'x; C_R = '12'x; global = global 'item'; item = ''
'DEFINE C-R OSN RX oldLine=currLine;call charout ,"1b"x"[s"||"1b"x"[0;0H"||"1b"x"[1;37;42m"||"1b"x"[KSearch for: "; item=getLine(item); call charout ,"1b"x"[0;0H"||"1b"x"[0;34;47m"||"1b"x"[K"helpstring"1b"x"[0m"||"1b"x"[u";',
           'if item \= "" then do;prevLine.0=prevLine.0-1;currLine=oldLine-1;if currLine=0 then currLine=prevLine.0;do prevLine.0 while pos(item,prevLine.currLine) = 0;currLine = currLine-1;',
           'if currLine=0 then currLine=prevLine.0;end;if pos(item,prevLine.currLine) \= 0 then line=prevLine.currLine;currOfs=length(line);xOfs=0;end'
'DEFINE C-F OSN RX if item\="" then do; oldCur=currLine;currLine = currLine-1;if currLine = 0 then currLine=prevLine.0;',
           'do prevLine.0 while pos(item,prevLine.currLine) = 0;currLine = currLine-1;if currLine=0 then currLine=prevLine.0;end;if pos(item,prevLine.currLine) \= 0 then line=prevLine.currLine;currOfs=length(line);xOfs=0; end'

/* Here, we redefine help messages in French...                       */
defHelp = "Utilisez la command DEFINE pour (re)dВfinir le rУle des touches"nl||,
          "du clavier."nl||nl||,
          "SYNTAXE:    DEF touche [valeur]"nl||,
          "         DEFINE touche [valeur]"nl||nl||,
          "          touche  SpВcifie le nom de la touche Е dВfinir."nl||,
          "          valeur  Valeur affectВe Е la touche. Ce peut Иtre une"nl||,
          "                  commande interne, MC xxx, OSNowait yyy ou TEXT zzz."nl||nl||,
          "Exemples:"nl||,
          "          DEF F12 TEXT dir /w"nl||,
          "       DEFINE F3  OSNOWAIT exit"nl||,
          "          DEF F12"
aliasHelp = "Utilisez la commande ALIAS pour afficher, dВfinir ou"nl||,
            "supprimer un alias."nl||nl||,
            "SYNTAXE: ALIAS [LIST|alias=[chaМne]|@fichier]"nl||nl||,
            "          LIST     Affiche la liste des alias en cours."nl||,
            "          alias    SpВcifie le nom de l'alias."nl||,
            "          chaМne   Valeur alphanumВrique affectВe Е l'alias."nl||,
            "          fichier  Nom d'un fichier contenant un ensemble de"nl||,
            "                   dВfinitions d'alias."nl||nl||,
            "Dans la dВfinition d'un alias, %* correspond aux paramКtres"nl||,
            "passВs sur la ligne de commande."
ruleHelp = "Utilisez la commande RULE pour afficher, dВfinir ou"nl||,
           "supprimer une rКgle."nl||nl||,
           "SYNTAXE: RULE [LIST|rКgle=[chaМne]|@fichier]"nl||nl||,
           "          LIST     Affiche la liste des rКgles en cours."nl||,
           "          rКgle    SpВcifie le nom de la rКgle."nl||,
           "          chaМne   Valeur alphanumВrique affectВe Е la rКgle."nl||,
           "          fichier  Nom d'un fichier contenant un ensemble de"nl||,
           "                   dВfinitions de rКgles."nl||nl||,
           "Dans la dВfinition d'une rКgle, %*, %c, %d, %e, %f, %l, %o et"nl||
           "%x dВnotent le type des paramКtres."
cmdHelp = "Utilisez la commande CMDSHL pour augmenter les capacitВs de"nl||,
          "votre interprВteur de commande."nl||nl||,
          "SYNTAXE: CMDSHL [/I|/O] [/P profile] [/C cmd|/K cmd]"nl||nl||,
          "          /I    SВlecte le mode Insertion par dВfaut."nl||,
          "          /O    SВlecte le mode surfrappe par dВfaut."nl||,
          "          /P    Utilise le fichier profile spВcifiВ."nl||,
          "          /C    ExВcute la commande cmd et met fin Е l'exВcution"nl||,
          "                de CMDSHL."nl||,
          "          /K    ExВcute la commande cmd sans mettre fin Е l'exВcution"nl||,
          "                de CMDSHL."nl||nl||,
          "Par dВfaut, le mode Insertion est actif et le fichier PROFILE.SHL"nl||,
          "est utilisВ comme profile s'il existe sur le chemin spВcifiВ par"nl||,
          "la variable d'environnement DPATH."
cdHelp = "Tapez CD -        Pour retourner au rВpertoire prВcВdent."nl||,
         "Tapez CD s1 s2    Pour remplacer s1 par s2 dans le rВpertoire en cours."
quitHelp = "Utilisez la commande QUIT pour quitter CMDSHL."nl||nl||,
           "SYNTAXE: QUIT"


/* useful aliases... from my point of view :-) */
'ALIAS rlogin=cls ^& ckermit ^& UTIL\telnet %1.unice.fr ^& cd -'
'ALIAS xrn=e:\local\yarn ^& yarn.exe ^& cd -'
'ALIAS open=rx xline = "%*"; if xline = "" then xline = directory(); else xline = findcommand(); call SysOpenObject xline,"DEFAULT",1; call SysOpenObject xline,"DEFAULT",1'
'ALIAS tc=java TCTypeCheck %*'
'ALIAS dir=sdir %*'
'ALIAS build=nrc -nocompile %1 ^& javac -d . %1.java ^& del %1.java'
'ALIAS netscape=rx url=stream("%1", "c", "query exists"); if url="" then call eval("start netscape.exe %1"); else call eval("start netscape.exe" url)'
'ALIAS loop=rx do %*'
'ALIAS qd=query date'
'ALIAS qt=query time'
'ALIAS recurse=rx orgdir=directory(); call SysFileTree "*","dirs.","DSO"; do i=1 to dirs.0; call directory dirs.i; call eval "%1*^&rx needCR=0"; end; call directory orgdir'
'ALIAS revmap=rx call SysFileTree "*","dirs.","DSO"; do i=dirs.0 to 1 by -1; call eval "%1*" dirs.i "^&rx needCR=0"; end'
'ALIAS map=rx call SysFileTree "*","dirs.","DSO"; do i=1 to dirs.0; call eval "%1*" dirs.i "^&rx needCR=0"; end'


/* useful rule... from my point of view :-) */
'RULE WHENCE=%f %e'
'RULE recurse=%x'

This profile file does the following:

     It redefines the '(' key so that it adds the closing ')';

     It defines the F8 key so that it inserts the current date at the cursor
      position;

     It defines the Shift+F7 key so that it displays all possible completions
      for the element preceding the cursor;

     It defines a persistent history feature:

      The command history is read from/stored in the file whose name is
      contained in the 'history' variable (by default %tmp%\history.shl).

      F2 is used to store the current command history list to this file.

      F5 is used to replace the current history list by the one defined in the
      file.

      F7 is used to interactively give a new name for the file (to be used by
      subsequent F2 or F5 actions).

      The default history file is loaded at startup (the 'LOADHIST'
      invoquation);

     A screen management system is added:

      You can save the current "screen" by pressing Ctrl+Down arrow.

      You can restore a previously saved "screen" by pressing Ctrl+Up arrow.

      You can toggle between the current "screen" and the last previously saved
      one by pressing Ctrl+Numpad +.  It allows you to easily switch between
      two different "screens".

      When more than one "screen" are saved, they are stored in a stack (that
      is, the last stored "screen" is the first restored one.)

      The "screen" above means the current state (screen layout, currently
      edited command, current directory and such).  This feature has been added
      to circumvent the 16 OS/2 sessions limit and also because it's much
      simpler to press Ctrl+Up/Down arrow than to start or switch to another
      session.  On the down side, it does not work from other VIO applications;

     It redefines the Ctrl+K key so that it steps to the next completion too,
      after duplicating the element preceding the cursor;

     It adds tools to search through command history:

      Ctrl+R asks (on the top screen line) an item to search, and find (if any)
      the first occurence of it in the command history (starting from current
      line, and going backward).

      Ctrl+F finds (if any) the next occurence (going backward, too).

      Those two definitions show another way to add functionality without using
      aliases.  It's a bit faster that way but it's also less user-friendly (no
      way to easily edit such definitions, ...).  Reserve it for editing
      features;

     It redefines all CmdShl's messages in French.  You can freely scrap it if
      you don't want them, or translate them in your own language (see
      CmdShl.cmd for the English version of those messages);

     It then defines some aliases:

      rlogin is probably useless for you :-)

      xrn is used to lauch my newsreader (Yarn/2).  You probably won't use it,
      but it shows you how to launch an application which does not resides in
      the PATH.

      open is used to open the current directory (or the specified argumenty,
      either a directory or file) in a window.  The default view is used (as
      defined by your current Workplace Shell settings).

      tc is again probably of no use :-)

      dir overrides the default CMD.EXE's DIR command with the enhanced
      SDIR.CMD one.  (SDir is part of MLRXSHL.)

      build is, ... yes, you guess it, useless again.

      netscape is used so that you can simply enter "netscape index.html"
      instead of "netscape file:index.html" which is required by Netscape if
      you don't want to receive an error message. If you specify an URL instead
      of a file name, it still works, too.

      loop allows you to do a command more than once.  Please note that it
      requires a REXX syntax.  For example "loop 10; 'mp123 Lillith.mp3'; end"
      will play the Lillith song ten times.

      [Lillith is a track from Plaid's album "Not For Threes", featuring
      BjФrk.]

      qd and qt are simple synonyms for "query date" and "query time",
      respectively.  Not that useful if you're not used to use those
      two-letters commands to get current date/time;

      recurse is used to repeat a command in each subdirectories beneath the
      current directory.  The order in which the subdirectories are enumerated
      is filesystem-dependant.  The only guarantee is that a child subdirectory
      comes after its parent.  The given command is not run on the current
      directory.

      map and revmap are two commands used to map (i.e., apply) a command over
      the list of subdirectories.  The order in which the subdirectories are
      enumerated is filesystem-dependant.  The only guarantee is that a
      subdirectory comes after its parent for map and before  its parent for
      revmap.  The command passed in argument receives one additional
      parameter, a full directory name.  That is, if we suppose the current
      directory contains two subdirectories, one of which contains another
      subdirectory, the following commands would be issued:

               map aCommand              --> aCommand x:\curdir\subdir1
                                             aCommand x:\curdir\subdir2
                                             aCommand x:\curdir\subdir1\subsubdir1
               revmap aCommand arg1      --> aCommand arg1 x:\curdir\subdir2
                                             aCommand arg1 x:\curdir\subdir1\subsubdir1
                                             aCommand arg1 x:\curdir\subdir1

      So the following would define a simple "deltree" command:

               ALIAS zap=del %1* /n ^& rd %1*
               ALIAS deltree=revmap zap

      And the following...

               ALIAS tricky=pushd ^& alias _foo=cd ^%1 ^^^& %1* ^& map _foo ^& popd

      ...is another way to define the recurse alias given above. How it works
      is left as an exercise to the reader :-)

     It finally defines a rule for the WHENCE command and recurse alias.


ΓòÉΓòÉΓòÉ 1.11. CmdShl Internal Functions ΓòÉΓòÉΓòÉ

This section describes useful CmdShl internal functions.  Please note that
theses functions may evolve in future releases.

addAlias("alias=[cmd]")

The addAlias command adds (or removes) an alias to (from) the alias database.

No return value.

Examples

   call addAlias "foo=cd e:2_X/unix/emacs19.29/info/beta"
   call addAlias "foo=cd d:/local"
   call addAlias "foo="

addRule("rule=[def]")

The addRule command adds (or removes) a rule to (from) the rule database.

No return value.

Examples

   call addRule "CD=%d|%f %f|/?|"
   call addRule "foo=%e %d*"
   call addRule "foo="

double(expr)

The double function returns expr in which all occurrences of '%' are doubled.

Examples

   say double('foo bar')         --> 'foo bar'
   say double('echo %abc%')      --> 'echo %%abc%%'
   say double(double('5%'))      --> '5%%%%'

eval(line [,current])

The eval command evaluate its line argument.  The optional current parameter is
here to prevent recursive execution of aliases (current is a space-delimited
list of alias names).

Returns 0 if it evaluates the QUIT command, 1 otherwise.

Examples

   call eval "FOO"                  If FOO is an alias or an
                                    external command, it's
                                    executed.

   call eval "FOO", "FOO"           If FOO is an external command,
                                    it's executed.  Error SYS1041
                                    occurs otherwise.

   call eval "FOO & BAR", "ZOO BAZ" FOO and BAR will be executed in
                                    sequence.  If they are alias,
                                    and if they call ZOO or BAZ
                                    (either directly or
                                    indirectly), it's the external
                                    command ZOO or BAZ which will
                                    be used.

expand(string)

The expand function returns string where all occurrences of environment
variables surrounded by '%' are substituted by their values.

Examples

   say expand('%tmp%\foo')        --> 'E:\IBMCPP\TMP\foo'
   say expand('%unknown%')        --> '%unknown%'
   say expand('%unknown%tmp%')    --> '%unknownE:\IBMCPP\TMP'
   say expand('100%')             --> '100%'

findcommand([arg])

The findcommand function returns the expanded command name defined by xline, if
any, or '' if xline is not a valid command.

If arg is specified, the real command name is returned.  If no arg is used (or
if arg is empty) an approximation is returned (in this case, aliases and
internal commands take precedence over directories, regardless of the "implied"
CD status -- it's faster, because the possible disk access is delayed).

     If implied CD is "1", and if xline is a valid directory name somewhere
      along the CDPATH environment variable, the complete directory path is
      returned;
     If xline is a defined alias, it is returned as is;
     If xline is an internal command, it is returned as is;
     If xline is a fully qualified name, and if the corresponding file exists
      (without additional extension, or with one in extList), the fully
      qualified name (with its extension) is returned;
     If xline is a valid name somewhere along the PATH environment variable
      (without additional extension, or with one in extList), the fully
      qualified name (with its extension) is returned;
     If implied CD is "2", and if xline is a valid directory name somewhere
      along the CDPATH environment variable, the complete directory path is
      returned.

 Examples

     xline = "keyb"; say findcommand()   --> 'C:\OS2\keyb.COM'
     xline = "xyzzy"; say findcommand()  --> ''

 findcompletion([type])

 The findcompletion function returns 1 if it can find a file name completion
 for the element preceding the cursor position, or 0 otherwise.

 If successful, tree. contains the possible completions.

 If type is specified, only names of the specified type are returned.  The
 possible types are 'F' or 'D', for respectively file and directory.

 Example

     if findcompletion() then
        do i = 1 to tree.0
           say tree.i
        end
     else
        say "No match!"

 findcontextcompletion()

 The findcontextcompletion function returns 1 if it can find a completion for
 the element preceding the cursor position, or 0 otherwise.  It uses the
 context (as defined by rules) to find a completion:

     If the element is expected to be a directory name, tree. contains the
      possible completions as a directory;
     If the element is expected to be an environment variable name, tree.
      contains the possible completions as an environment variable;
     If the element is expected to a file, a command or a undefined item,
      tree. contains the possible completions as either a directory name or
      filename;
     If something else is expected, 0 is returned and hence the content of
      tree. is irrelevant.

 Example

     if findcontextcompletion() then
        do i = 1 to tree.0
           say tree.i
        end
     else
        say "No match!"

 findcontexttype([cmd])

 The findcontexttype function returns the type of the element preceding the
 cursor position (or, if cmd is provided, the cursor is supposed to follow the
 last character of cmd).  The returned value is one of:  'a', 'c', 'd', 'e',
 'f', '(list)', '' or '0':

     If it is 'a', an undefined item is expected.  That is, anything is
      allowed at that position;
     If it is 'c', a command name is expected;
     If it is 'd', a directory name is expected;
     If it is 'e', an environment variable name is expected;
     If it is 'f', a file name is expected;
     If it is '(list)', a file name whose name matches at least one
      specification contained in the space- or comma-delimited list is
      expected;
     If it is '', nothing is expected at that position;
     If it is '0', a rule has been defined for the context, but the context
      does not match it.  It indicates either a syntax error in the command or
      an incorrectly defined rule.

 Examples

     say findcontexttype('cd')           --> 'c'
     say findcontexttype('cd ')          --> 'd'
     say findcontexttype('cd e:')        --> 'd'
     say findcontexttype('cd e: ')       --> 'f'
     say findcontexttype('for %i is')    --> '0'

 If we assume the default rules for the CD and FOR commands, which are '%d|%f
 %f|/?|' and '%%%l IN (%*) DO %x'.

 findcurrentcommand(cmd)

 The findcurrentcommand function returns the command ending cmd.  It does just
 return the command, its (possible) arguments aren't.  If the line is empty, an
 empty string is returned.

 It does not always returns the 'finest' command (for example, in the third
 example below, 'for' is returned, not 'del') but it nonetheless returns a
 valid one, so that the context can be correctly determined.

 This function modifies the xline global variable.  It contains the command
 plus its arguments, if any.  (Warning:  the length of xline is correct, but
 all opening and closing parents in it are remplaced by spaces.)

 Examples

     say findcurrentcommand('dir *foo')                          --> 'dir'
     say xline                                                   --> 'dir *foo'
     say findcurrentcommand('dir & cd bar')                      --> 'cd'
     say xline                                                   --> 'cd bar'
     say findcurrentcommand('for %i in (a b) do del %i')         --> 'for'
     say xline                                                   --> 'for %i in  a b  do del %i'
     say findcurrentcommand('for %i in (a b) do (echo %i & del') --> 'del'
     say xline                                                   --> 'del'

 findenvcompletion()

 The findenvcompletion function returns 1 if it can find an environment
 variable completion for the element preceding the cursor position, or 0
 otherwise.

 If successful, tree. contains the possible completions.

 Example

     if findenvcompletion() then
        do i = 1 to tree.0
           say tree.i
        end
     else
        say "No match!"

 findmulticompletion(list)

 The findmulticompletion function returns 1 if it can find a file name
 completion whose name matches at least an element of the space- or
 comma-delimited list for the element preceding the cursor position, or 0
 otherwise.

 If successful, tree. contains the possible completions.

 Example

     if findmulticompletion('*.exe *.cmd') then
        do i = 1 to tree.0
           say tree.i
        end
     else
        say "No match!"

 getArg(cmd)

 The getArg function returns the first argument contained in cmd. An argument
 can contain spaces if they are enclosed in quotes. If the first argument of
 cmd contains no spaces, getArg is equivalent to word(cmd, 1).  If the first
 argument contains an open quote, cmd is returned.

 Examples

     say getArg('dir /w')                --> 'dir'
     say getArg('"Desktop archive"')     --> '"Desktop archive"'
     say getArg('A" "funny" command" !') --> 'A" "funny" command"'
     say getArg('"Oops ...')             --> '"Oops ...'

 getFileSpec(cmd)

 The getFileSpec function returns the (possibly) partial file name ending cmd.
 It also sets the fileOfs variable to point to the first symbol of the file
 specification.

 Examples

     say getFileSpec('dir c:\os2\dll')     -->    c:\os2\dll
     say getFileSpec('dir "My Desktop"')   -->    "My Desktop"

 getKey()

 This function reads a key from the keyboard, and returns its value, as defined
 by the DEFine command.  If the key has not been DEFined, the key itself is
 returned.

 As a side effect, the ckey value is set to the internal representation of the
 key (a "_" followed by 2 to 4 hexadecimal digits).

 Examples

     say getKey()      --> F3      --> OSNOWAIT EXIT  (ckey is _003D)
     say getKey()      --> a       --> a              (ckey is _61)

 getLine([line])

 This function reads an entry from the user, and returns it.  It can be a
 multi-line entry.  All currently defined editing keys can be used.  If line is
 specified, it's the default value.

 Warning: getLine can be used recursively, but the command history is shared
 among all calls.

 halt()

 This function is called when an alias execution is interrupted by the user (by
 using either Ctrl+C or Ctrl+Break).

 Its default action is to stop the execution of the command, switch to the
 orgdir directory (if defined) and resume execution of the command interpreter.

 mark()

 This function handles mark management.  It is used to remove or copy mark, and
 to mark word/elements.  It sets the following variables: markLen, markOfs and
 markLine.

 This function has no argument, but it uses the second word of the key variable
 ("word", "char", "clear", "delete", "move" or "copy"). It can only be used
 while in editing mode.

 print()

 This function returns the string corresponding to the current prompt (as
 defined by the CMDSHL.PROMPT.environment (or CMDSHL.PROMPT or PROMPT)
 environment variable, if any).  It can then be displayed by charout.

 Example

     call charout, print()

 profile()

 This procedure read a profile file from disk, and interpret it. The real file
 name is derived from the profileName variable (if it's not an absolute path,
 it is searched via DPATH).

 No return value.

 [This procedure can be used to execute 'enhanced' command scripts, that is,
 command script calling CmdShl-specific commands -- but keep in mind that
 CmdShl profiles suffer some syntax restrictions.]

 Examples

     profileName = 'D:\tmp\foo.cmd'; call profile
     'ALIAS EXEC=RX profileName = SysSearchPath('PATH',"%*"); call profile'

 profilesyntax()

 This procedure is called when a syntax error is detected in the profile file.
 It displays the offending file and line number, as well as the error message.
 Interpretation of the profile is aborted, but the execution of CmdShl
 continues.

 substitute(line, arg)

 This function returns line, where all occurrences of %[n]* or %n (if any) have
 been replaced with the nth word of arg (or the nth word of arg and all
 following word if n is followed by *).

 Examples

     say substitute("bla bla", "xxx")           --> bla bla
     say substitute("it's %1 (%2)", "yyy zzz")  --> it's yyy (zzz)
     say substitute("%1 (%2*)", "x y z")        --> x (y z)


ΓòÉΓòÉΓòÉ 1.12. CmdShl Internal Variables ΓòÉΓòÉΓòÉ

This section describes useful CmdShl internal variables.  Please note that
theses variables may evolve in future releases.

aliasHelp [string]

What to display when the 'ALIAS /?'  command is issued.  You can translate this
message (the recommended place to do so is in your PROFILE.SHL).

aliasNames [string]

A space-delimited list of name (case is sensitive) which enumerates all defined
aliases.  This list is maintained automatically by the ALIAS command, but you
can use it to check the existence of an alias, or ...

Example

   'ALIAS EXISTS?=RX if wordpos('%*',aliasNames) > 0 then say YES;
                                                     else say NO'

aliasStem. [stem]

The aliases definitions.

cdHelp [string]

What to display in addition to the default 'CD /?'  output (in fact, a
description of the 'CD -' and 'CD path1 path2' commands).  You can translate
this message (the recommended place to do so is in your PROFILE.SHL)

cmdHelp [string]

What to display when the 'CMDSHL /?'  command is issued.  You can translate
this message (the recommended place to do so is in your PROFILE.SHL).

cmdList [string]

The list of all internal command interpreter commands, in uppercase (that is,
CD, DIR, etc.).  Used when command validation is enabled.

cmdQueue [0|1]

The history-list behavior.  Can be 0 or 1 (the default).  If cmdQueue is 1, a
recalled command is moved to the end of the history list; otherwise, it remains
in place.

[the default behavior mimics the CMD.EXE behavior.]

defHelp [string]

What to display when the 'DEFine /?'  command is issued.  You can translate
this message (the recommended place to do so is in your PROFILE.SHL).

extList [string]

The extensions to be tried by the findcommand function.  Its value is 'exe cmd
bat com' by default.

fileOfs [number]

The position of the first symbol of the last file name specification queried by
getFileSpec.

fileSeparator [string]

When trying to find a file name, where to stop.  Used by filename completion.
Its value is ' =;<>|()&' by default.

helpColor1, helpColor2 [strings]

helpColor1 contains the ANSI escape sequence to use at the beginning of the
(optional) top line help string, and helpColor2 contains the ANSI escape
sequence to use at the end of this string. Theses two strings should not move
the cursor or ...  They should only change the color attribute.  Their default
values is:

   helpColor1='1b'x'[34;47m'    -- blue on white background
   helpColor2='1b'x'[0m'        -- default color

helpSwitches [string]

helpSwitches contains the list of blank-separated switches used to obtain help
from an internal command.  Its value is '/?' by default.

For example, if you come from an UNIX background, you may be used to type '-h'
to get help.  Changing helpSwitches to be '/? -h' will then suits your habits.

See HELP.COMMAND and HELP.SWITCHES for more details on how to define an
optional help subsystem.  (If you redefine helpSwitches in your PROFILE.SHL,
this redefinition will take precedence over the HELP.SWITCHES environment
variable.)

impCD [0|1|2]

The " implied CD" (aka "executable" directories) state (1 by default, can be
overridden in your PROFILE.SHL).

If impCD is 0, the "implied CD" feature is disabled.  When impCD is 1, a
directory name takes precedence over a possible command with no arguments.
When impCD is 2, a command with no arguments takes precedence over a directory
name.

To explain the difference between the 1 and 2 values, lets assume the following
command was entered:

   help

If impCD is 1, and if there exists a directory named HELP accessible via the
CDPATH environment variable, the current directory will be changed to it.
Otherwise, the "\OS2\HELP.CMD" command is executed.

If impCD is 2, the "\OS2\HELP.CMD" command is executed, regardless of the
presence of a possible HELP directory accessible via the CDPATH environment
variable.  (You can naturally still reach it by issuing "help/" or "help\" or
"cd help".)

insertMode. [stem]

How to display the cursor in insert/overwrite mode (by default, '-80 -90', i.e.
a low bar, and '0 -90', i.e. a plain box).

   insertMode.1 = '-80 -90'
   insertMode.0 = '0 -90'

Note:  The two numbers for each state are the horizontal scan lines that mark
       the top and bottom of the cursor.  0 is the top scan line, and n-1 is
       the bottom one (where n is the scan lines in the character cell -- it
       cannot exceeds 32).

To set start line and end line independent of the number of scan lines for each
character cell, you may specify these parameters as percentages.  OS/2 then
calculates the physical start and end scan lines, respectively, by multiplying
the percentage specified for the parameter by the total number of scan lines in
the character cell and rounding to the nearest scan line.  Percentages are
specified as negative values (or 0) in the range 0 through -100.  Specifying
start line = -90 and end line = -100 requests a cursor that occupies the bottom
10 percent of the character cell.

 insertState [0|1]

 The default insertion state (1 by default, can be overridden via CmdShl's /O
 switch).  Each time you start to edit a new command, the insertion state is
 reset to insertState value (when editing a command, you can change the
 insertion state by using the Ins key -- by default, but theses changes are
 local).

 invalidCmd [string]

 What to interpret when an invalid command is found on the command line.  In
 addition to the usual editing variables, xlen contains the position of the
 first symbol of the offending command and xline is the offending command.
 invalidCmd default's value is

     invalidCmd = "call VioWrtNAttr origRow + xlen % col, xlen // col, length(xline), 12;",
                  "xOfs = currOfs+1"

 [That is, it displays the offending command in red.]

 _LEVEL_ [number]

 The current recursion level of the eval command.

 oldDir [string]

 The previously visited directory.  This variable is maintained by CmdShl's CD
 command.

 prevLine. [stem]

 The commands history list.  prevLine.0 contains the history size.

 profileName [string]

 The file name to be used by the profile() internal function.

 quitHelp [string]

 What to display when the ' QUIT /?'  command is issued.  You can translate
 this message (the recommended place to do so is in your PROFILE.SHL).

 rules. [stem]

 The rules definitions.

 rulesList [string]

 A space-delimited list of name (case is sensitive) which enumerates all
 defined rules.  This list is maintained automatically by the RULE command, but
 you can use it to check the existence of a rule, or ...

 Example

     'ALIAS SHOWRULE=RX if wordpos('%*',rulesList) > 0 then say rules.%*;
                                                       else say "(undefined)"'

 shlList [string]

 The list of enabled CmdShl internal commands (in uppercase).  Used when
 command validation is enabled.


ΓòÉΓòÉΓòÉ 1.13. CmdShl Editing Variables ΓòÉΓòÉΓòÉ

This section describes the variables which can be used while editing a command
(that is, only usable when used in a key definition).

col [number]

The current screen width.

currOfs [number]

The current cursor position in the command (first char is at currOfs 1).

currTab [number]

If not null, we are in filename completion mode.  If null, we're not (or, no
longer).  The "tab" and "backtab" internal actions enter completion mode.  ALL
OTHER internal actions exit completion mode.  If you want to remain in
completion mode after having used another action, add the following code after
your action definition:

   key = "tab"

key [string]

The internal action name being executed (see currTab for an important note).

line [string]

The line being edited.

markLine [number]
markLen [number]
markOfs [number]

The position and length of the mark.  if markLen is null, there's no mark.

oline [string]

The edited line before its last modification.

origCol [number]
origRow [number]

The initial cursor position (that is to say, where the cursor was just after
displaying the prompt).

row [number]

The current screen height.

tree. [stem]

If tree.0 is not null, the stem contains the matching file names.


ΓòÉΓòÉΓòÉ 1.14. History ΓòÉΓòÉΓòÉ

 WARNING:  This product does work well with Object REXX as included
           in DEVCON 10 or higher.  It does not work well with the one
           included in DEVCON 8/9.


1.30.000    Dec 22 1997

 --- New feature:
     o %(list) implemented in rules.
 --- Misc. change:
     o Default rule provided for CHDIR.

1.29.000    Dec 21 1997

 --- New features:
     o better error handling in profiles.
     o halt procedure added for use in aliases.

1.28.000    Dec 09 1997

 --- New feature:
     o Optional external help subsystem added (use HELP.COMMAND and
       HELP.SWITCHES if defined).

1.27.000    Nov 27 1997

 --- Bug fix:
     o CD sets RC when called (either directly or indirectly).

1.26.000    Nov 25 1997

 --- Bug fix:
     o findcontexttype abend when called with an argument.
 --- Misc. changes:
     o Using CMDSHL.PROMPT instead of CMDSHLPROMPT.
     o Case sensitiveness added to rule names.
 --- New feature:
     o Added command-handler-dependant prompts (CMDSHL.PROMPT.*).

1.25.000    Nov 19 1997

 [Those changes were made to unify CmdShl with Ulrich MФller's CommandPak.]

 --- Misc. changes:
     o The priority of implicit CDs is now user-definable (that is,
       it can now preempt or not a command with no argument).
     o User-definable help switch (helpSwitches) so that internal
       commands can use -h or whatever the user expects for obtaining
       help.
     o quitHelp added to describe QUIT usage.
     o SHELL allowed as OSNowait synonym.
 --- New feature:
     o If a CMDSHLPROMPT environment variable is defined, it is used
       in place of PROMPT.

1.24.000    Nov 15 1997

 --- Misc. change:
     o "expand" also uses rules.  So commands are expanded even when
       they are not in first position.

1.23.000    Nov 07 1997

 --- Bug fix:
     o %c in findcontexttype was not initializing xline correctly
       (the current context was flaged as incorrect, not just the
       offending command).

1.22.000    Nov 06 1997

 --- Bug fixes:
     o findcurrentcommand was returning incorrect result when command
       was either START or DETACH.
     o file was not cleared in findenvcompletion.
 --- Misc. changes:
     o %o implemented in rules.
     o "space" uses rules, too.

1.21.000    Nov 03 1997

 --- Bug fix:
     o Environment variable in commands were incorrectly handled.
 --- Misc. change:
     o "expand" now also expands rules.

1.20.000    Nov 02 1997

 --- Misc. changes:
     o '*' allowed in rules definition to denote repetition.
     o Default rules provided for RD and RMDIR.

1.19.000    Oct 31 1997

 --- Bug fix:
     o RC is now a public variable.
 --- New features:
     o Enhanced rules definition.
     o Default rule provided for FOR.

1.18.000    Oct 23 1997

 --- New features:
     o RULE command added.
     o Default rules provided for START, DETACH, CD and SET.

1.17.000    Oct 22 1997

 --- New features:
     o Completion also completes environment variable name if the
       current command is 'SET'.
     o Rules (partialy) implemented to help providing smart
       completion and command checking.
 --- Misc. change:
     o Enhancing command detection algorithm.

1.16.000    Jun 17 1997

 --- New feature:
     o A "dup" internal action added.

1.15.000    Jun 10 1997

 --- Bug fix:
     o Quoted elements now supported in path substitution.

1.14.000    Jun 03 1997

 --- Bug fixes:
     o Quoted command and directory names now correctly handled.
     o Multiple commands in "/c" and "/k" correctly handled when
       specified in quotes.
     o Incorrect display if cursor is on lower right corner and
       spacebar is pressed.

1.13.000    Mar 13 1997

 --- Bug fix:
     o interactive was not initialised when using the "/k" switch.

1.12.000    Oct 07 1996

 --- Bug fix:
     o OSNowait now accepts quoted '&'.

1.11.000    Sep 28 1996

 --- Bug fix:
     o xOfs reseted by "esc", "match", "backmatch", "cup" and "cdown".
 --- Misc. changes:
     o Removed "STDOUT:" statements.
     o "space" now understands START and DETACH.

1.10.000    Sep 16 1996

 --- Bug fixes:
     o '%' handled correctly in command name and arguments.
     o Filenames with '(' or ')' correctly handled during filename
       completion.
     o CD no longer overrides oldDir if not relevant.
 --- Misc. changes:
     o Enhancing CD with path substitution.

1.09.000    Sep 13 1996

 --- Misc. changes:
     o Speeding up filename completion.
     o Speeding up command line display.

1.08.000    Sep 12 1996

 --- Bug fixes:
     o "PROMPT" added in the CMD internal command list.
     o Fully qualidied directory path correctly recognized as
       a valid command when implicit CD is enabled.
     o Unit specification correctly recognized as a valid command.
 --- Misc. change:
     o '/' or '\' allowed at the end of directories names during CD
       (either implicit or explicit).

1.07.000    May 23 1996

 --- Bug fixes:
     o '&' added to fileSeparator.
     o "space" handles stream redirections ('>&') correctly.
     o "expand" was duplicating command name when there was only spaces
       between cursor and command name.
     o '&&' correctly handled.
 --- Misc. change:
     o findcommand speed optimized when checking aliases and internal
       commands.

1.06.000    Apr 29 1996

 --- Misc. changes:
     o Displaying helpString is a bit faster now.
     o Removing the unused assignment to line in loop:.
     o Executable filename extensions are stored in extList instead of
       beeing hardcoded.

1.05.000    Apr 19 1996

 --- Bug fixes:
     o Fully qualified directory specifications recognized by findcommand
       (and hence by on the fly command checking).
     o The eval function is now safely recursive.
 --- New feature:
     o A new "backmatch" command.

1.04.000    Mar 26 1996

 --- Bug fix:
     o Stream redirection (i.e., things like 2>&1) handled correctly.

1.03.000    Mar 07 1996

 --- New features:
     o A new key-related function, MC.
     o "expand" now also expands aliases.
     o "mark move" and "mark delete" have been added (if the mark is
       not on current line, "mark move" do a copy, and "mark delete"
       do nothing).

1.02.000    Mar 05 1996

 --- New feature:
     o The "expand" internal action also expands command name (with
       its path and extension, if applicable).
 --- Buf fixes:
     o getFileSpec failed if first char was '"' in arg(1) and there was
       an odd number of '"'.
     o A fully qualified path was incorrectly flagged as being an
       invalid command.
 --- Misc. changes:
     o RexxVIO is now required (was optional since 0.98.000).
     o "f1" internal action now called "match".

1.01.000    Mar 04 1996

 --- New features:
     o A new "expand" internal action (bound to C_X by default).
     o Command line copy/paste added (mark char|clear|copy|word).

1.00.000    Feb 22 1996

 --- New feature:
     o File name completion understands environment variables.

0.99.000    Feb 19 1996

 --- Bug fixes:
     o Re-enabling environment variable substitution in 'CD' commands.
     o Command line checking now handles fully qualified commands.
 --- New feature:
     o User-definable file separator (fileSeparator, ' =;<>|()' by
       default).

0.98.000    Feb 15 1996

 --- New feature:
     o If RexxVIO is present, cursor reflects insert state (insertMode,
       overwriteMode).

0.97.000    Feb 02 1996

 --- Bug fixes:
     o Incorrect alias handling when no substitution was required.
     o Blank lines no longer emitted while processing profile file.
     o helpColor1 and helpColor2 are now public.
 --- New feature:
     o backtab added.

0.96.000    Nov 15 1995

 --- Bug fixes:
     o Command line checking now handles correctly quoted "&" and "|".
     o Quoted "&" and "|" are now correctly handled when defining an
       alias from the command prompt.
 --- New features:
     o Command line checking now uses a user-defined function to warn
       the user (so, if you prefer an audible clue, you can define it)
       (invalidCmd).
     o The help line color is user-definable (helpColor1, helpColor2).

0.95.000    Oct 18 1995

 --- New features:
     o CmdShl internal commands can be enabled/disabled.
     o Enhanced ALIAS substitution parameters (%[0-9]?[*]).

0.94.000    Oct 12 1995

 --- Bug fix:
     o CMD.EXE quoting symbol (^) is now correctly handled.

0.93.000    Oct 11 1995

 --- Bug fixes:
     o Command line checking handles '|', '(' and ')'  correctly.
     o DEFINE no longer crashes if its first parameter is invalid.
     o "CD -" now works with implicit CDs.
 --- New features:
     o Improved command line parsing (strings and subexpressions are
       now recognized).
     o Speed improvement when using CMD.EXE internal commands.

0.92.000    Oct 06 1995

 --- New features:
     o Implicit "CD" feature is now optional (impCD).
     o Optional command line checking (if a command is nonexistent, its
       name is highlighted).
     o Faster screen updates.

0.91.000    Aug 08 1995

 --- Bug fixes:
     o Default messages are now in English.
     o Newline no longer automatically emitted after a RX command.
 --- New commands:
     o A new DEFINE internal command.
     o And two new key-related functions, TEXT and OSNOWAIT.
 --- New features:
     o An improved profile interpreter (multi-lines, REXX expression
       allowed in external commands).
     o getLine can be called recursively.
     o Interesting internal functions have been documented.
     o Some key names have been defined (for use with the DEFINE
       command).

0.90.000    Jul 27 1995

 --- First public release


ΓòÉΓòÉΓòÉ 2. Filelist User's Guide ΓòÉΓòÉΓòÉ

     What's That?
     Installation
     Starting Filelist
     Screen Description
     Available Commands
     Profile Support
     History


ΓòÉΓòÉΓòÉ 2.1. What's That? ΓòÉΓòÉΓòÉ

Fl is yet another character-mode directory browser.  It's just a REXX script,
but it's nonetheless very easy to use.  You just have to "annotate" the files
you want to apply a command to with the desired command.

Suppose you want to print the 8514.RC file.  Just move the cursor over the
corresponding line, and enter "PRINT" (without quotes!).  The command will
appear in the prefix command (the area filled with "="s). You will have to
press the Enter key to execute it (in fact, the Enter key executes all pending
commands -- that is, you can prepare more than one command, and execute them in
one step.)

If, in the previous example, you've wanted to print out the 8514.RC file while
renaming ATTRIB.EXE to, say, SETATTR.EXE, you would have had to enter the
"PRINT" command over the 8514.RC line and the "REN / SETATTR.EXE" one over the
ATTRIB.EXE line.  And then, pressing the Enter key in the main screen area
would have executed theses two commands sequentially (that is, from top to
bottom).

You can also use (and redefine) function keys to execute frequently used
commands (such as browsing a file, or copying it to another disk...).

All colors and keys are redefinable.  If you like the XEDIT look, you can use
the provided PROFILE.FL:

You can open more than one directory at a time, sort them, or use a restricted
view (eg, *.EXE and *.CMD files only).


ΓòÉΓòÉΓòÉ 2.2. Installation ΓòÉΓòÉΓòÉ

Installing Fl is very simple:  just copy FL.CMD somewhere along your PATH,
REXXVIO.DLL somewhere along your LIBPATH and, if you want to use a profile
file, customize PROFILE.FL and move it somewhere along your DPATH.

If REXXVIO.DLL is currently in use, close ALL your OS/2 windowed or fullscreen
sessions, and open a bare OS/2 windowed session (that is, one not starting
CmdShl or Fl).  You can then replace REXXVIO.DLL from this session.

If you were using a previous version of MLRXSHL, execute the following code
from an OS/2 command prompt, to allow the new functions defined in REXXVIO to
be registered:

   rexxtry call VioDropFuncs


ΓòÉΓòÉΓòÉ 2.3. Starting Filelist ΓòÉΓòÉΓòÉ

Syntax

   fl [filespec] [([tree|sort[d|a] name|ext|size|date [...]]]

Parameters

   (Noprofile        -  Do not use a profile file;
   (Profile file     -  Use the specified profile file;
   (Sort[d|a] opt    -  Sort the entries by opt;
   (Wide             -  Display more than one file per line;
   (Tree             -  Recursively include subdirectories.

Examples

   fl c:\os2 (sort name
   fl *.cmd
   fl


ΓòÉΓòÉΓòÉ 2.4. Screen Description ΓòÉΓòÉΓòÉ

The Fl screen is composed of four parts.  The first line is the info area.  It
is followed by the main area.  The penultimate line is the command area, while
the last line is the key/message area.

The Info Area

It contains the directory name, the available space in the corresponding disk,
and the current file # and file count.

The Main Area

This area is composed of two sub-areas.  The first one is the prefix area.
It's by default filled with "="s.  You can replace them with line number, by
issuing the "SET NUM ON" command in the command area.  The second one contains
the file's information; that is, file date, file time, file size and file name.

The Command Area

Use this area to enter non-file related commands (such as, say, PSTAT, SET NUM
...  or RESET PREFIX).  The number surrounded by square brackets is the current
view number (1 for the first opened directory, 2 for the second, ...).

The Key/Message Area

This area usually displays function keys labels.  If an error occurs, it will
temporarily display an error message.


ΓòÉΓòÉΓòÉ 2.5. Available Commands ΓòÉΓòÉΓòÉ

When entering commands in the main area, you can use the following shortcuts:

   /     =     The whole file name (drive+path+name+ext);
   /n    =     The file name;
   /e,/t =     The file extension (or "type");
   /p    =     The file path;
   /d,/m =     The file drive (or "mode");
   /o    =     Nothing;
   //    =     A "/" symbol;
   "     =     Repeat the previously defined command.

If you enter a main area command without at least one of the above shortcuts,
the complete file name will be added at the end of the command (so, use the
"/o" shortcut if you do not want to pass the file name to the command).

For command area commands, these shortcuts refer to the current file.
Additionally, the complete file name is NOT appended by default.

The following commands are also available in addition to all standard internal
or external commands:

     BAckward [n|*]
     BOTtom
     CCancel
     DEFine keyname [command [args]]
     DOS [command]
     DOSNowait command
     Down [n|*]
     Edit [dir or file name]
     FList [dir or file name]
     FOrward [n]
     HELP
     Next [n|*]
     NEXTWindow
     OS [command]
     OSNowait command
     QUIT
     RESet ALL|PREfix
     RUN [command]
     SET CASE Mixed|Upper|Lower
     SET COLO[U]R [modifier [...]] [foreground [background]]
     SET CURLine M[+n|-n]|[+|-]n
     SET IMPcmscp ON|OFF
     SET IMPOS ON|OFF
     SET MSGLine ON [M[+n|-n]|[+|-]n]
     SET NUMber ON|OFF
     SHOWkey
     SOS DELBAck
     SOS DELChar
     SOS STARTENDChar
     SOS UNDO
     TEXT text
     TOP
     Up n|*
     Xedit [dir or file name]


ΓòÉΓòÉΓòÉ 2.5.1. BAckward ΓòÉΓòÉΓòÉ

scroll backwards [n] screens

SYNTAX

          BAckward [n|*]

DESCRIPTION

The BACKWARD command scrolls the file contents backwards through the file [n|*]
screens.

If 0 is specified as the number of screens to scroll, the last line of the file
becomes the current line.  If the BACKWARD command is issued while the current
line is the "Top of File" line, the last line of the file becomes the current
line.

DEFAULT

          1

SEE ALSO

          FORWARD, TOP


ΓòÉΓòÉΓòÉ 2.5.2. BOTtom ΓòÉΓòÉΓòÉ

move to the bottom of the file

SYNTAX

          BOTtom

DESCRIPTION

The BOTTOM command moves to the very end of the current file. The last line of
the file is set to the current line.

SEE ALSO

          FORWARD, TOP


ΓòÉΓòÉΓòÉ 2.5.3. CCancel ΓòÉΓòÉΓòÉ

qquit from all files in the ring

SYNTAX

          CCancel

DESCRIPTION

The CCANCEL command exits from FL quickly by executing the QQUIT command for
every file in the ring.  Any changes made to any of the files will be lost.


ΓòÉΓòÉΓòÉ 2.5.4. DEFine ΓòÉΓòÉΓòÉ

assign one or many commands to a key

SYNTAX

          DEFine key-name [command [args] [[#command [args]...]]]

DESCRIPTION

The DEFINE command allows the user to assign one or many commands and optional
parameter(s) to a key.

Commands may be abbreviated.

With no arguments, any existing definition for that key is removed and the key
reverts back to its default assignation (if it had any).

key-names correspond to the key name shown with the SHOW command.

SEE ALSO

          SHOWKEY


ΓòÉΓòÉΓòÉ 2.5.5. DOS ΓòÉΓòÉΓòÉ

execute an operating system command

SYNTAX

          DOS [command]

DESCRIPTION

The DOS command executes the supplied operating system command or runs an
interactive shell if no command is supplied.

SEE ALSO

          OS


ΓòÉΓòÉΓòÉ 2.5.6. DOSNowait ΓòÉΓòÉΓòÉ

execute an operating system command - no prompt

SYNTAX

          DOSNowait command

DESCRIPTION

The DOSNOWAIT command executes the supplied operating system command not
waiting for the user to be prompted once the command has completed.

SEE ALSO

          OSNOWAIT


ΓòÉΓòÉΓòÉ 2.5.7. Down ΓòÉΓòÉΓòÉ

move forward in the file a number of lines

SYNTAX

          Down [relative_target]

DESCRIPTION

The DOWN command moves the current line forwards the number of lines specified
by the relative_target.  This relative_target can only be a positive integer or
the character "*".

DEFAULT

          1

SEE ALSO

          NEXT, UP


ΓòÉΓòÉΓòÉ 2.5.8. Edit ΓòÉΓòÉΓòÉ

edit another file or switch to next file

SYNTAX

          Edit [filename or directory]

DESCRIPTION

The EDIT command allows the user to edit another file or directory. The new
file or directory is placed in the file ring.  The previous file being edited
remains in memory and can be returned to by issuing an EDIT command without any
parameters.  Several files can be edited at once, and all files are arranged in
a ring, with subsequent EDIT commands moving through the ring, one file at a
time.

SEE ALSO

          FLIST, XEDIT


ΓòÉΓòÉΓòÉ 2.5.9. FList ΓòÉΓòÉΓòÉ

edit another file or switch to next file

SYNTAX

          FList [filename or directory]

DESCRIPTION

The FLIST command allows the user to edit another file or directory.  The new
file or directory is placed in the file ring.  The previous file being edited
remains in memory and can be returned to by issuing an FLIST command without
any parameters.  Several files can be edited at once, and all files are
arranged in a ring, with subsequent FLIST commands moving through the ring, one
file at a time.

SEE ALSO

          EDIT, XEDIT


ΓòÉΓòÉΓòÉ 2.5.10. FOrward ΓòÉΓòÉΓòÉ

scroll forwards [n] screens

SYNTAX

          FOrward [n]

DESCRIPTION

The FORWARD command scrolls the file contents forwards the number of screens
specified.

If 0 is specified as the number of screens to scroll, the "Top of File" line
becomes the current line.  If the FORWARD command is issued while the current
line is the "Bottom of File" line, the "Top of File" line becomes the current
line.

DEFAULT

          1

SEE ALSO

          BACKWARD, TOP


ΓòÉΓòÉΓòÉ 2.5.11. HELP ΓòÉΓòÉΓòÉ

edit help file for Fl

SYNTAX

          HELP

DESCRIPTION

The HELP command displays help for the file manager.  Uses DPATH environment
variable to point to the help file.


ΓòÉΓòÉΓòÉ 2.5.12. Next ΓòÉΓòÉΓòÉ

move forward in the file a number of lines

SYNTAX

          Next [relative_target]

DESCRIPTION

The NEXT command moves the current line forwards the number of lines specified
by the relative_target.  This relative_target can only be a positive integer or
the character "*".

DEFAULT

          1

SEE ALSO

          DOWN, UP


ΓòÉΓòÉΓòÉ 2.5.13. NEXTWindow ΓòÉΓòÉΓòÉ

switch focus of editing session to other window

SYNTAX

          NEXTWindow

DESCRIPTION

The NEXTWINDOW command moves the focus of the editing session to the other
window (if more than one window is currently displayed) or to the next file in
the ring.

SEE ALSO

          EDIT


ΓòÉΓòÉΓòÉ 2.5.14. OS ΓòÉΓòÉΓòÉ

execute an operating system command

SYNTAX

          OS [command]

DESCRIPTION

The OS command executes the supplied operating system command or runs an
interactive shell if no command is supplied.

SEE ALSO

          DOS


ΓòÉΓòÉΓòÉ 2.5.15. OSNowait ΓòÉΓòÉΓòÉ

execute an operating system command - no prompt

SYNTAX

          OSNowait command

DESCRIPTION

The OSNOWAIT command executes the supplied operating system command not waiting
for the user to be prompted once the command has completed.

SEE ALSO

          DOSNOWAIT


ΓòÉΓòÉΓòÉ 2.5.16. QUIT ΓòÉΓòÉΓòÉ

exit from the current file if no changes made

SYNTAX

          QUIT

DESCRIPTION

The QUIT command exits the user from the current file, provided no changes have
been made to the file.  An error message will be displayed if changes have been
made.  The previous file in the ring then becomes the current file.  If the
current file is the only file in the ring, the user is returned to the
Operating System.


ΓòÉΓòÉΓòÉ 2.5.17. RESet ΓòÉΓòÉΓòÉ

cancel the marked block or prefix commands or both

SYNTAX

          RESet ALL|Block|Prefix

DESCRIPTION

The RESET command unmarks any marked block or outstanding prefix commands or
both.


ΓòÉΓòÉΓòÉ 2.5.18. RUN ΓòÉΓòÉΓòÉ

execute the specified command

SYNTAX

          RUN file [args]

DESCRIPTION

The RUN command executes the specified file.


ΓòÉΓòÉΓòÉ 2.5.19. SET CASE ΓòÉΓòÉΓòÉ

set case sensitivity parameters

SYNTAX

          [SET] CASE Mixed|Lower|Upper

DESCRIPTION

The CASE command sets the editor's handling of the case of text.

The option (which is mandatory) controls how text is entered by the user.  When
LOWER or UPPER are in effect, the shift or caps lock keys have no effect on the
text being entered.  When MIXED is in effect, text is entered in the case set
by the use of the shift and caps lock keys.

DEFAULT

          MIXED


ΓòÉΓòÉΓòÉ 2.5.20. SET COLO[U]R ΓòÉΓòÉΓòÉ

set colours for display

SYNTAX

          [SET] COLOUR area [modifier[...]] [foreground background]
          [SET] COLOR  area [modifier[...]] [foreground background]

DESCRIPTION

The COLOUR command changes the colours or display attributes of various display
areas in FLIST.

Valid values for 'area':

            Arrow    - command line prompt
            Cmdline  - command line
            CUrline  - the current line
            Filearea - area containing file lines
            Idline   - line containing file specific info
            Msgline  - error messages
            Pending  - pending commands in prefix
            PRefix   - prefix area
            STatarea - line showing status of editing session
            TOfeof   - *** Top of File *** and *** Bottom of File *** lines

Valid values for 'foreground' and 'background':

   black,blue,green,cyan,red,magenta,yellow,white

Valid values for 'modifier':

   normal,blink,bold,bright,high,reverse,underline

It is an error to attempt to set a colour on a mono display.


ΓòÉΓòÉΓòÉ 2.5.21. SET CURLine ΓòÉΓòÉΓòÉ

set position of current line on screen

SYNTAX

          [SET] CURLine M[+n|-n] | [+|-]n

DESCRIPTION

The CURLINE command sets the position of the current line to the physical
screen line specified by supplied arguments.

The two forms of parameters are:

          M[+n|-n] - this sets the current line to be relative to the
                     middle of the screen. A positive value adds to the
                     middle line number, a negative subtracts from it.
                     eg. M+3 on a 24 line screen will be line 15
                         M-5 on a 24 line screen will be line 7

          [+|-]n   - this sets the current line to be relative to the
                     top of the screen (if positive or no sign) or
                     relative to the bottom of the screen if negative.
                     eg. +3 or 3 will set current line to line 3
                         -3 on a 24 line screen will be line 21

If the resulting line is outside the bounds of the screen the position of the
current line will become the middle line on the screen.

DEFAULT

          +6


ΓòÉΓòÉΓòÉ 2.5.22. SET IMPcmscp ΓòÉΓòÉΓòÉ

set implied operating system command processing

SYNTAX

          [SET] IMPcmscp ON|OFF

DESCRIPTION

The IMPCMSCP command is used to toggle implied operating system command
processing from the command line.  By turning this feature on you can then
issue an operating system command without the need to prefix the operating
system command with the OS command.

DEFAULT

          ON

SEE ALSO

          SET IMPOS


ΓòÉΓòÉΓòÉ 2.5.23. SET IMPOS ΓòÉΓòÉΓòÉ

set implied operating system command processing

SYNTAX

          [SET] IMPOS ON|OFF

DESCRIPTION

The IMPOS command is used to toggle implied operating system command processing
from the command line.  By turning this feature on you can then issue an
operating system command without the need to prefix the operating system
command with the OS command.

DEFAULT

          ON

SEE ALSO

          SET IMPCMSCP


ΓòÉΓòÉΓòÉ 2.5.24. SET MSGLine ΓòÉΓòÉΓòÉ

set position and size of message line

SYNTAX

          [SET] MSGLine ON [M[+n|-n]|[+|-]n] [lines]

DESCRIPTION

The MSGLINE set command specifies the position of the message line and the size
of the message line window.

The two forms of the position parameters are:

          M[+n|-n] - this sets the first line to be relative to the
                     middle of the screen. A positive value adds to the
                     middle line number, a negative subtracts from it.
                     eg. M+3 on a 24 line screen will be line 15
                         M-5 on a 24 line screen will be line 7

          [+|-]n   - this sets the first line to be relative to the
                     top of the screen (if positive or no sign) or
                     relative to the bottom of the screen if negative.
                     eg. +3 or 3 will set tab line to line 3
                         -3 on a 24 line screen will be line 21

If the resulting line is outside the bounds of the screen the position of the
message line will become the middle line on the screen.

DEFAULT

          ON 2 1


ΓòÉΓòÉΓòÉ 2.5.25. SET NUMber ΓòÉΓòÉΓòÉ

turn prefix numbers on or off

SYNTAX

          [SET] NUMber ON|OFF

DESCRIPTION

The NUMBER command allows the user to toggle the display of numbers in the
prefix area.

DEFAULT

          ON


ΓòÉΓòÉΓòÉ 2.5.26. SHOWkey ΓòÉΓòÉΓòÉ

display current key value and command assignation

SYNTAX

          SHOWKey

DESCRIPTION

The SHOWKEY command prompts the user to enter a key and responds with the key
name and associated command (if applicable).  To exit from SHOWKEY, press the
space bar.


ΓòÉΓòÉΓòÉ 2.5.27. SOS DELBAck ΓòÉΓòÉΓòÉ

delete the character to the left of the cursor

SYNTAX

          SOS DELBAck

DESCRIPTION

The SOS DELBACK command moves the cursor one character to the left and deletes
the character now under the cursor.

SEE ALSO

          SOS DELCHAR


ΓòÉΓòÉΓòÉ 2.5.28. SOS DELChar ΓòÉΓòÉΓòÉ

delete character under cursor

SYNTAX

          SOS DELChar

DESCRIPTION

The SOS DELCHAR command deletes the character under the cursor. Text to the
right is shifted to the left.

SEE ALSO

          SOS DELBACK


ΓòÉΓòÉΓòÉ 2.5.29. SOS STARTENDChar ΓòÉΓòÉΓòÉ

move cursor to end/start of focus line

SYNTAX

          SOS STARTENDChar

DESCRIPTION

The SOS STARTENDCHAR command moves the cursor to the first character displayed
in the current window, if the cursor is after the last character displayed in
the current window, or to the position after the last character displayed in
the current window, if the cursor is anywhere else.


ΓòÉΓòÉΓòÉ 2.5.30. SOS UNDO ΓòÉΓòÉΓòÉ

undo changes to the current line

SYNTAX

          SOS UNDO

DESCRIPTION

The SOS UNDO command causes the contents of the focus line (or the command
line) to be reset to the contents before the cursor was positioned there.


ΓòÉΓòÉΓòÉ 2.5.31. TEXT ΓòÉΓòÉΓòÉ

simulate keyboard entry of characters

SYNTAX

          TEXT text

DESCRIPTION

The TEXT command simulates the entry of characters from the keyboard.  This
command is actually called when you enter text from the keyboard.


ΓòÉΓòÉΓòÉ 2.5.32. TOP ΓòÉΓòÉΓòÉ

move to the top of the file

SYNTAX

          TOP

DESCRIPTION

The TOP command moves to the very start of the current file.  The "Top-of-file"
line is set to the current_line.

"TOP" is equivalent to "BACKWARD *".

SEE ALSO

          BACKWARD, BOTTOM


ΓòÉΓòÉΓòÉ 2.5.33. Up ΓòÉΓòÉΓòÉ

move backward in the file a number of lines

SYNTAX

          Up [relative_target]

DESCRIPTION

The UP command moves the current line backwards the number of lines specified
by the relative_target.  This relative_target can only be a positive integer or
the character "*".

DEFAULT

          1

SEE ALSO

          NEXT, DOWN


ΓòÉΓòÉΓòÉ 2.5.34. Xedit ΓòÉΓòÉΓòÉ

edit another file or directory or switch to next file

SYNTAX

          Xedit [filename or directory]

DESCRIPTION

The XEDIT command allows the user to edit another file.  The new file is placed
in the file ring.  The previous file being edited remains in memory and can be
returned to by issuing an XEDIT command without any parameters.  Several files
can be edited at once, and all files are arranged in a ring, with subsequent
XEDIT commands moving through the ring, one file at a time.

SEE ALSO

          EDIT, FLIST


ΓòÉΓòÉΓòÉ 2.6. Profile Support ΓòÉΓòÉΓòÉ

Fl supports profile files.  By default, PROFILE.FL is used, but you can
override it via the (Profile switch.  If you don't want to use a profile, use
the (Noprofile switch.

If present, the profile file should be somewhere along the DPATH, or you can
alternatively specify its complete path.

A profile file is a plain REXX file.  It's called before any user interaction.
It's usually used to redefine keys assignments or colo[u]rs, displaying or
setting some session-dependant data, and so on...


ΓòÉΓòÉΓòÉ 2.7. History ΓòÉΓòÉΓòÉ

0.90.000    Nov 25 1997

 --- Creating Fl history file
 --- New features:
     o SHOWKey shows human-readable name for keys.
     o A-1 and A-X bounded to Xedit by default.


ΓòÉΓòÉΓòÉ 3. Less ΓòÉΓòÉΓòÉ

 If you're using Object REXX (the DEVCON 8/9 edition), the "=" command will be
 disabled, as well as "external" commands.  The first point is due to a
 definition change in the STREAM() built-in function, and will be fixed in a
 future release of Less, but the second point is due to a bug in the
 LINEIN('CON:') built-in function, and will not be fixed by Less.

     What's That?
     Installation
     Starting Less
     Commands
     Known Limitations


ΓòÉΓòÉΓòÉ 3.1. What's That? ΓòÉΓòÉΓòÉ

Less is a file browser.  When used as a MORE.EXE replacement, it provides much
faster displays, the ability to run any program/command and some information
(the elapsed number of lines, mainly).

When used as a command, it provides horizontal and vertical scrolling, the
ability to locate a text string, to jump to a specified line...  and it can
cycles through more than one file.

And less.cmd is small (less than 2Kb).  But if you're new to REXX, this command
file is not necessarily the best place to start with, though :-) [It's nicely
indented - to my taste - but there's not that much comments, and it includes
some cryptic statements...]


ΓòÉΓòÉΓòÉ 3.2. Installation ΓòÉΓòÉΓòÉ

Installing Less is very simple:  just copy LESS.CMD somewhere along your PATH.


ΓòÉΓòÉΓòÉ 3.3. Starting Less ΓòÉΓòÉΓòÉ

Syntax

   less filename [filename ...]
   ... | less
   less <...

Examples

   less *.doc *.txt
   dir | less
   less <config.sys


ΓòÉΓòÉΓòÉ 3.4. Commands ΓòÉΓòÉΓòÉ

[A "*" following a command name denotes a command which can't be used when
less.cmd is called as a filter.]

 "<", Left (*)
           Scroll right 20 columns.

 ">", Right (*)
           Scroll left 20 columns.

 "N", F12 (*)
           Next file in the ring (if available).

 "P", F11 (*)
           Previous file in the ring (if available).

 "." (*)
           Redraws the screen.

 ESC, F3
           Exits less.

 ENTER
           Scroll down one line.

 SPACE, PageDown
           Move down one screen.

 BACKSPACE, PageUp (*)
           Move up one screen.

 +nnn (*)
 -nnn (*)
 nnn (*)
           Use this command to move the current (top) line to another one. It
           can be used in three ways:

                         nnn      Move to line number nnn.
                         +nnn     Move forward (down) nnn number of lines.
                         -nnn     Move backward (up) nnn number of lines.

 "="
           Displays current file information:  file name, current top line
           number, current left column, current position, file size and file
           position in the file ring.

           Example

                         <D:\backup\config.new line=1 col=1 pos=1142/3905 file=1/4>

 /[searchstring] (*)
           Locates the first occurrence of "searchstring" in the current file.
           If "searchstring" is empty, locates the next occurrence of the
           previously defined searchstring.

           The search is case-insensitive.

           Example

                      /REM

           The top-line will be positioned on the first occurrence of 'REM' in
           the current file.  If nothing is found, you will get a new less ":"
           prompt, as in:

                         :/azert
                         :_

                      /

           The top-line will be positioned on the next occurrence of the
           previously defined searchstring (REM in our example).

           If no next occurrence exists, you will get a new less ":" prompt, as
           in:

                         :/
                         :_

 anything else
           Your REXX command is interpreted.

           Warning:  When calling a REXX script, you have to precede its name
           with "call ".

           The following internal variables may be of interest:

                         A        the command line arguments
                         file     the current file name
                         r        the screen height
                         c        the screen width
                         l        the current top-line number
                         d        the current horizontal delta
                         n        the current file position in the ring
                         m        the number of file in the ring
                         t.i      (where i is in 1..m) the ith file name
                         s        the current search string

           Examples

           To display the current directory, enter

                         dir

           [If you want to use jokers chars, you will have to use single or
           double quotes, as in:  dir '*.cmd'.]

           To display the current search string, enter

                         say s

           To edit the currently displayed file with tedit, enter

                         call exc close; tedit file

           and use the "." command to redraw the screen.

           [Well, the "call exc close" is not very, er, intuitive, but it is
           required in order to prevent a file-sharing violation -- that is,
           less is currently reading the file, and so, nobody can change it.
           Automatically closing the file may be implemented in a future
           release, though...]


ΓòÉΓòÉΓòÉ 3.5. Known Limitations ΓòÉΓòÉΓòÉ

Note:  All theses limitations can easily be fixed, but the 2Kb figure please me
       very well, so, I'll try to include them without breaking it...  That
       unfortunately takes a bit more time :-)

     Tabulations are replaced by the symbol "┬╖".  This makes browsing files
      containing mixed space- and tabulation-based indentations a bit strange.

     If the browsed file contains ANSI escape-sequences, you may encounter
      strange results.

     The locate function is case-insensitive.  It's sometime annoying.

     It would be nice to be able to use the horizontal scrolling functions
      while browsing a piped output (that is, when less.cmd is used as a
      filter).  It would be nice to be able to redraw the current screen, too.


ΓòÉΓòÉΓòÉ 4. Query ΓòÉΓòÉΓòÉ

     What's That?
     Installation
     Starting Query
     Environment variables


ΓòÉΓòÉΓòÉ 4.1. What's That? ΓòÉΓòÉΓòÉ

Query (as well as its documentation :-) is in a very early beta stage.  Some
features may be buggy (but non destructive) or incompletely implemented.

QUERY is a command used to extract various data.  It is especially useful if
you are using Ultimedia Mail/Lite as your mail reader or IBM Global Network as
your Internet provider.  It was created to simply obtain data that were
concealed or not otherwise directly available.

If you use IBM Global Network as your Internet provider, you can check your
connect time (it does take into account the minimum 35 seconds connect time) as
well as review the various messages you may have received when you dial in.
You may have to increase your Connect.Log size (see the Logging page of your
Dialer's setting notebook) if you want to be able to query connection
statistics for more than one month or two.  (50K looks like a reasonable figure
as it can hold something like three months of data...)

   QUERY CONNECT TIME
   QUERY THIS YEAR CONNECT TIME FOR USER1
   QUERY DETAILED NOVEMBER CONNECT TIME FOR USER1 USER2
   QUERY LAST CONNECT MESSAGE

If you use Ultimedia Mail/Lite as your mail reader, you can search your mail
folders for messages.

   QUERY MAIL FOR USER1 IN INBOX WHERE SUBJECT CONTAINS "PAGING"

You can also query numerous data, such as system date or time, loaded drivers,
etc.

   QUERY DATE
   QUERY DISK
   QUERY OS VERSION
   QUERY PICTURE DIMENSION FOR header.gif night.jpg
   ...

The complete supported command list follows.

     QUERY Date
     QUERY Time
     QUERY [timeframe] [DETAILED] CONNECT TIME [FOR ...]
     QUERY [timeframe] [LAST] CONNECT MESSAGE [FOR ...]
     QUERY [timeframe] MAIL [FROM ... ] [IN foldername] [WHERE condition]
     QUERY DISK [unit]
     QUERY PICTure DIMension FOR ...
     QUERY OS [Version]
     QUERY [component] Version
     QUERY SYStem (DEVices|DRIVERS|IRQs|MEMory)
     QUERY PROCess ID
     QUERY DIRector(y|ies) STACK

 Where the optional elements values are defined as:

 timeframe           [THIS | LAST] (YEAR | MONTH | monthname) ['S]
 monthname           JANuary | FEBruary | MARch | APRil | MAY | JUNe | JULy |
                     AUGust | SEPtember | OCTober | NOVember | DECember
 foldername          name | "name" | * | foldername, foldername
 condition           element operator value [(OR | AND) condition]
 element             FROM | TO | SUBJECT | SENDER [['S] DOMAIN]
 unit                * | letter[:] | unit unit
 component           REXX | JAVA | OS


ΓòÉΓòÉΓòÉ 4.2. Installation ΓòÉΓòÉΓòÉ

Installing Query is very simple:  just copy QUERY.CMD somewhere along your PATH
and REXXVIO.DLL somewhere along your LIBPATH.

If REXXVIO.DLL is currently in use, close ALL your OS/2 windowed or fullscreen
sessions, and open a bare OS/2 windowed session (that is, one not starting
CmdShl or Fl).  You can then replace REXXVIO.DLL from this session.

If you were using a previous version of MLRXSHL, execute the following code
from an OS/2 command prompt, to allow the new functions defined in REXXVIO to
be registered:

   rexxtry call VioDropFuncs


ΓòÉΓòÉΓòÉ 4.3. Starting Query ΓòÉΓòÉΓòÉ

                        ΓöîΓöÇΓöÇDateΓöÇΓöÇΓöÉ
        ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇTimeΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇDISKΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
        Γöé                       ΓööΓöÇunit ...ΓöÇΓöÿ                    Γöé
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇPICTureΓöÇDIMensionΓöÇFORΓöÇfile ...ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇSYStemΓöÇΓöÇΓöÇΓö¼ΓöÇDEVicesΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
        Γöé                           Γö£ΓöÇDRIVERSΓöÇΓöñ                 Γöé
        Γöé                           Γö£ΓöÇΓöÇIRQsΓöÇΓöÇΓöÇΓöñ                 Γöé
        Γöé                           ΓööΓöÇMEMoryΓöÇΓöÇΓöÿ                 Γöé
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇPROCessΓöÇIDΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
QUERY ΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇDIRectoryΓöÇSTACKΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöñ
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇOSΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
        Γöé                      ΓööΓöÇVersionΓöÇΓöÿ                      Γöé
        Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇJAVAΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇVersionΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
        Γöé            Γö£ΓöÇΓöÇOSΓöÇΓöÇΓöñ                                   Γöé
        Γöé            ΓööΓöÇREXXΓöÇΓöÿ                                   Γöé
        ΓööΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γö¼CONNECTΓöÇΓö¼MESSAGEΓö¼Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γöñ
         Γö£ΓöÇTHISΓöÇΓöñΓö£ΓöÇΓöÇΓöÇMONTHΓöÇΓöÇΓöÇΓöñΓöé        ΓööΓöÇTIMEΓöÇΓöÇΓöÿΓööΓöÇFOR user ...ΓöÇΓöÿΓöé
         ΓööΓöÇLASTΓöÇΓöÿΓö£ΓöÇΓöÇΓöÇYEARΓöÇΓöÇΓöÇΓöÇΓöñΓöé                                 Γöé
                 Γö£ΓöÇΓöÇJANuaryΓöÇΓöÇΓöñΓööMAILΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼Γöÿ
                 :           :     ΓööFROM ...ΓöÿΓööIN ...ΓöÿΓööWHERE ...Γöÿ

Notes  You just have to specify the upper-cased part of an argument to design
       it.  For example 'QUERY DATE' and 'QUERY D' are equivalent.

The 'QUERY SYSTEM MEMORY' command requires RXU.DLL, which is not included in
this package.  You can find it from your favorite FTP site.  If RXU is missing,
you can't use this command, but all others are still available.


ΓòÉΓòÉΓòÉ 4.4. Environment variables ΓòÉΓòÉΓòÉ

Query recognizes the following environment variables:

   HELP.COMMAND
   HELP.SWITCHES

If one or more of those environment variables are not defined, they are
silently ignored.  (They are used to define an optional external help
subsystem.)


ΓòÉΓòÉΓòÉ 4.4.1. HELP.COMMAND ΓòÉΓòÉΓòÉ

If this environment variable is defined, Query will not use its build-in help
messages.  Instead, it will call the script/application defined by this
variable.

For example, if HELP.COMMAND is defined as:

   SET HELP.COMMAND=ECHO Help for

Issuing 'QUERY /?' will give:

   Help for QUERY /?

(In other words, the command is displayed back to the user.)

The syntax of the call is the following:

   call %HELP.COMMAND% QUERY <args>

where <args> being the argument(s) given to the command by the user.


ΓòÉΓòÉΓòÉ 4.4.2. HELP.SWITCHES ΓòÉΓòÉΓòÉ

If this environment variable is defined, it contains a space-delimited list of
switches used to obtain help from the command.

For example:

   SET HELP.SWITCHES=/? -h

If this environment variable is not defined, Query assumes '/?' as its value.


ΓòÉΓòÉΓòÉ 5. SDir ΓòÉΓòÉΓòÉ

     What's That?
     Installation
     Starting SDir
     Environment variables
        -  DIRCLR.ATTRIB
        -  DIRCLR.DATE
        -  DIRCLR.EASIZE
        -  DIRCLR.EXT
        -  DIRCLR.NAME
        -  DIRCLR.SIZE
        -  DIRCLR.USEREXIT
        -  DIRCMD
        -  HELP.COMMAND
        -  HELP.SWITCHES
     Known Limitations
     History


ΓòÉΓòÉΓòÉ 5.1. What's That? ΓòÉΓòÉΓòÉ

Sdir is a CMD.EXE's DIR command replacement.  It is (supposed to be) 100%
compatible with it.  It adds custom coloration to outputs.  It also fixes a
minor but annoying misalignment when the /W option is used

In this typical sample, you can see that the alignment bug is fixed
(REXXvio.zip is just under REXXvio.INF).  Some coloration has been made, too.
The outputs are otherwise identical.

(Files that have been modified in the last 30 days are highlighted. Directories
are colored in green, .CMD files in cyan and .ZIP archives in yellow.  If more
than one coloration apply, and if they can be mixed, it is done so -- for
example, REXXvio.test is a directory, and has been created less than 30 days
ago, so it's both green and highlighted.)

The coloration is completely directed by environment variables.


ΓòÉΓòÉΓòÉ 5.2. Installation ΓòÉΓòÉΓòÉ

Installing SDir is very simple:  just copy SDIR.CMD somewhere along your PATH
and REXXVIO.DLL somewhere along your LIBPATH.

If REXXVIO.DLL is currently in use, close ALL your OS/2 windowed or fullscreen
sessions, and open a bare OS/2 windowed session (that is, one not starting
CmdShl or Fl).  You can then replace REXXVIO.DLL from this session.

If you were using a previous version of MLRXSHL, execute the following code
from an OS/2 command prompt, to allow the new functions defined in REXXVIO to
be registered:

   rexxtry call VioDropFuncs

If you want to automatically use SDIR instead of DIR, you can add an alias, if
your command shell processor recognizes them.  For example, with CmdShl, use:

   ALIAS dir=SDIR %*

You can also add your preferred coloration settings in your CONFIG.SYS.  For
example, mine contains:

   REM Sdir Settings
   SET DIRCLR.ATTRIB=D:GREEN;H,S:ON RED;R:BLINK
   SET DIRCLR.DATE=-30:BRIGHT
   SET DIRCLR.EXT=BAT,EXE,COM,CMD:CYAN;ZIP:YELLOW;INI:MAGENTA
   SET DIRCLR.NAME=PROFILE:MAGENTA


ΓòÉΓòÉΓòÉ 5.3. Starting SDir ΓòÉΓòÉΓòÉ

See the DIR command in the online reference manual.


ΓòÉΓòÉΓòÉ 5.4. Environment variables ΓòÉΓòÉΓòÉ

Sdir recognizes the following environment variables:

   DIRCLR.ATTRIB
   DIRCLR.DATE
   DIRCLR.EASIZE
   DIRCLR.EXT
   DIRCLR.NAME
   DIRCLR.SIZE
   DIRCLR.USEREXIT

   DIRCMD

   HELP.COMMAND
   HELP.SWITCHES

If one or more of those environment variables are not defined, the missing ones
are silently ignored.

The last two environment variables are used to define an optional external help
subsystem.

The order in which coloration is applied is the following:

   1. User exit;
   2. Directory attribute;
   3. Other attributes : Archive, Read only, System, Hidden;
   4. File extension (if any);
   5. File name;
   6. File date;
   7. File size;
   8. Extended attributes size.

 An element of higher priority takes precedence over an element of lower
 priority.  For example, if you specify a green background for directories and
 red background for recent entries, a directory will always have a green
 background, regardless of its last modification date.

 The color specification is of the form:

      [BRIGHT] [BLINK] [color] [ON color]

 color being one of: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN or WHITE.

 The case is not significant.  Depending on your display type, specifying BLINK
 may result in either a blinking character or a high intensity background
 color.


ΓòÉΓòÉΓòÉ 5.4.1. DIRCLR.ATTRIB ΓòÉΓòÉΓòÉ

This environment variable specifies the coloration to be used if an entry
attribute has been set.

   SET DIRCLR.ATTRIB=attrib[,...]:color[;...]

attrib can be one of D, A, R, S or H.  (Case is not significant.)

If an attribute is defined more than once, the last definition is used.

Example

   SET DIRCLR.ATTRIB=D:green;H,S:ON RED;R:BLINK

Directories will be displayed in green, Hidden or System entries will be
displayed on a red background, and read-only ones will be blinking (or, in a
VIO Window, the background will be intensified).


ΓòÉΓòÉΓòÉ 5.4.2. DIRCLR.DATE ΓòÉΓòÉΓòÉ

This environment variable specifies the coloration to be used depending of the
entry's last modification date.

   SET DIRCLR.DATE=[-+=]date:color[;...]

If date is a number, it specifies a number of day. Otherwise, it's a date in
ISO format (yyyy/mm/dd).

If you have specified a number of day, a leading '-' selects files modified in
the last date days.  A leading '+' selects files that have not been modified in
the last date days.  A leading '=' only selects files modified exactly date
days ago (it's not that useful :-) ).

If you have specified a date, a leading '-' selects files that have not been
modified since date.  A leading '+' selects files that have been modified since
date.  A leading '=' only selects files modified on date.

The first matching value is used.  The evaluation order is from left to right.

Example

   SET DIRCLR.DATE=-30:bright

A bright color will be used for files modified in the last 30 days.


ΓòÉΓòÉΓòÉ 5.4.3. DIRCLR.EASIZE ΓòÉΓòÉΓòÉ

Not implemented yet.


ΓòÉΓòÉΓòÉ 5.4.4. DIRCLR.EXT ΓòÉΓòÉΓòÉ

This environment variable specifies the color to be used depending on the entry
extension.

   SET DIRCLR.EXT=ext[,...]:color[;...]

ext is the extension (without the leading dot) to be colored.  It is case
insensitive.  Jocker symbols ('*' and '?') are not allowed.

If an extension is specified more than once, the last specification is used.

Example

   SET DIRCLR.EXT=BAT,EXE,COM,CMD:CYAN;ZIP:YELLOW

Files ending with either .BAT, .EXE, .COM or .CMD will be displayed in cyan
while archive files ending with .ZIP will be in yellow.


ΓòÉΓòÉΓòÉ 5.4.5. DIRCLR.NAME ΓòÉΓòÉΓòÉ

This environment variable specifies the color to be used depending on the entry
name.

   SET DIRCLR.NAME=name[,...]:color[;...]

name is the name to be colored.  It is case insensitive.  Jocker symbols ('*'
and '?') are not allowed.  Neither are null ('') names.

If a name is specified more than once, the last specification is used.

The name of an entry is the part preceding the extension.  For example:

  foo              --> foo
  bar.baz          --> bar
  foo.bar.baz      --> foo.bar

Example

   SET DIRCLR.NAME=PROFILE:magenta

Files whose name is PROFILE will be in magenta.


ΓòÉΓòÉΓòÉ 5.4.6. DIRCLR.SIZE ΓòÉΓòÉΓòÉ

Not implemented yet.


ΓòÉΓòÉΓòÉ 5.4.7. DIRCLR.USEREXIT ΓòÉΓòÉΓòÉ

Not implemented yet.


ΓòÉΓòÉΓòÉ 5.4.8. DIRCMD ΓòÉΓòÉΓòÉ

See the (inexistant :-) description of it in the online reference manual.


ΓòÉΓòÉΓòÉ 5.4.9. HELP.COMMAND ΓòÉΓòÉΓòÉ

If this environment variable is defined, SDir will not use its build-in help
messages.  Instead, it will call the script/application defined by this
variable.

For example, if HELP.COMMAND is defined as:

   SET HELP.COMMAND=ECHO Help for

Issuing 'SDIR /?' will give:

   Help for SDIR /?

(In other words, the command is displayed back to the user.)

The syntax of the call is the following:

   call %HELP.COMMAND% SDIR <args>

where <args> being the argument(s) given to the command by the user.


ΓòÉΓòÉΓòÉ 5.4.10. HELP.SWITCHES ΓòÉΓòÉΓòÉ

If this environment variable is defined, it contains a space-delimited list of
switches used to obtain help from the command.

For example:

   SET HELP.SWITCHES=/? -h

If this environment variable is not defined, SDir assumes '/?' as its value.


ΓòÉΓòÉΓòÉ 5.5. Known Limitations ΓòÉΓòÉΓòÉ

     The EA size is incorrectly reported if it exceeds 32767 bytes. (In fact,
      4OS2 as well as the Workplace Shell also exhibit this behavior.)

     The sort is currently handled by a REXX procedure, so it's quite slow if
      you don't have a fast computer.  (If you don't use the /o option, speed
      will be OK.)

     Some environment variables are not yet recognized: DIRCLR.SIZE,
      DIRCLR.EASIZE and DIRCLR.USEREXIT.

     In DIRCLR.DATE, each month contains 31 days (and hence a year contains
      372 days).


ΓòÉΓòÉΓòÉ 5.6. History ΓòÉΓòÉΓòÉ

0.98.000    Dec 15 1997

 --- Bug fix:
     o lineCount, pause and height were not always exposed when
       needed.

0.97.000    Dec 09 1997

 --- New feature:
     o Optional external help subsystem added (use HELP.COMMAND and
       HELP.SWITCHES if defined).

0.96.000    Nov 26 1997

 --- Bug fix:
     o /o works like CMD.EXE's DIR when used in conjunction with /s.

0.95.000    Nov 23 1997

 --- New feature:
     o /p option added.

0.94.000    Nov 21 1997

 --- Bug fixes:
     o total size no longer displayed if /s is not specified.
     o partial size correctly displayed when using more than one
       specification in a given directory.
     o abend when /w was used with multiple specifications in
       different directories.
 --- New feature:
     o DIRCMD environment variable used if defined.

0.93.000    Jun 17 1997

 --- Bug fix:
     o /s now completely implemented.

0.92.000    May 31 1997

 --- New feature:
     o /v option added.

0.91.000    Mar 14 1997

 --- Bug fix:
     o full path is displayed when /b is used in conjunction with /s.

0.90.000    Sep 24 1996

 --- First public release