home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / thesrc15.zip / dos.hlp < prev    next >
Text File  |  1993-11-13  |  23KB  |  557 lines
  1. /***********************************************************************/
  2. /* (dos)            Help file for The Hessling Editor             1.5  */
  3. /***********************************************************************/
  4.  
  5.  Command-line invocation:
  6.  
  7.  the [-h?nms] [-p profile] [-a profile_arg] [-w width] [[dir] [file [...]]]
  8.  
  9.   Where:
  10.     -h or -?      Display usage information and version.
  11.     -n            Do not execute a profile file.
  12.     -m            Force display into mono, ignoring colour support.
  13.     -s            A debugging aid for Unix versions. Turns off signal trapping.
  14.     -p profile    The name of the profile file to use.  If not specified,
  15.                   the file "PROFILE.THE" will be used, unless overridden
  16.                   by the environment variable "THE".
  17.     -a prof-arg   Used to pass a string to the profile file as argument.
  18.                   Only works with REXX macros.
  19.     -w width      Length of longest line THE can handle (default 2048)
  20.     dir           Will display a directory of the specified dir.
  21.     file [..]     Specifications of file(s) to edit.  If multiple files
  22.                   are specified, each will be put in a separate file in
  23.                   the ring.  The first one specified will be displayed.
  24.                   If no files are specified, the current directory will
  25.                   be displayed.
  26.                   Issuing [SOS EDIT] on a file spec will edit that file.
  27.                   [SOS EDIT] on a subdir will display that directory.
  28.  
  29.     Option flags must be specified in LOWER case.
  30.  
  31.  
  32.  Environment variables used:
  33.  --------------------------
  34.  See Appendix 1 of the.man
  35.  
  36.  Notes:
  37.   - The capitalised portion of a command is the minimum abbreviation
  38.     for the command.
  39.   - UP, DOWN, NEXT differ from XEDIT and Kedit in that they do not
  40.     accept numerical arguments abutted to the command name.
  41.     Thus "N3" is not supported.
  42.  
  43.  
  44.                                                                 Allowed
  45. THE Commands:                                                  in Profile
  46. -------------------------------------------------------------------------
  47.  ! [command...]
  48.        Execute host command; pause before returning
  49.  ?
  50.        Retrieve last command from command line
  51.  =                                                                 Y
  52.        Execute the last command issued on the
  53.        command line
  54.  ADD [n]                                                           Y
  55.        insert [n] blank lines below current line
  56.  BAckward [n|*]
  57.        move backward through the file [n] screens
  58.  BOTtom                                                            Y
  59.        got to bottom of file
  60.  CANcel                                                            Y
  61.        Quit out of all files in the ring that do
  62.        not have any pending changes
  63.  CCancel                                                           Y
  64.        Qquit out of all files in the ring ignoring
  65.        files that have pending changes
  66.  Change /string1/string2/ [target] [n] [m]                         Y
  67.        changes n occurrences of string1 to string2
  68.        for target
  69.  CMSG [message]                                                    Y
  70.        display message on command line
  71.  COMMAND command [options]                                         Y
  72.        execute command without synonym or macro transation
  73.  COPY BLOCK [RESET]
  74.        copies marked block after focus line
  75.  DEFine key-name command|nop [parameters]                          Y
  76.        Assigns key to execute command and parameters.
  77.        Cannot be used to define macros.
  78.  DELete [target|BLOCK]                                             Y
  79.        delete specified target or block
  80.  DIRectory|LS [path]
  81.        show list of specified directory/files and
  82.        allow editing
  83.  DOS [command...]
  84.        execute host command; pause before returning
  85.  DOSNowait command
  86.        execute OS command; no pause before returning
  87.  DOSQuiet command
  88.        execute OS command quietly; no pause
  89.  Down [n|*]                                                        Y
  90.        move current line forward [n] lines
  91.  DUPlicate [n] [target|BLOCK]                                      Y
  92.        duplicates, n times, lines in the current target
  93.  Edit [fileid]                                                     Y
  94.        begin editing specified file or switch
  95.        between files
  96.  EMSG [message]                                                    Y
  97.        display error message and ring bell(if BEEP ON)
  98.  EXPand [target]                                                   Y
  99.        expand tabs to spaces within target
  100.  EXTract /item/[...]                                               Y
  101.        extract values on various settings
  102.        (only valid from a REXX macro)
  103.  FFile [fileid]                                                    Y
  104.        write contents of file to disk (overwritng)
  105.        and and remove from ring
  106.  FILE [fileid]                                                     Y
  107.        write contents of file to disk and and remove
  108.        from ring
  109.  FILLbox [char]
  110.        fill the marked block with the supplied character
  111.  FOrward [n|*]
  112.        move forward through file [n] screens
  113.  GET [fileid]                                                      Y
  114.        insert into current file contents of
  115.        specified file
  116.  HELP
  117.        edit file specified by environ variable
  118.        THE_HELP
  119.  Input [line contents]                                             Y
  120.        Add a line after the current line with line
  121.        contents.
  122.  Join [ALigned]
  123.        Joins a line with the following line.
  124.  [Locate] target                                                   Y
  125.        make line identified by target become current
  126.        line
  127.  LOWercase [target]                                                Y
  128.        change the uppercase characters in target
  129.        to lowercase
  130.  LS|DIRectory [path]
  131.        show list of specified directory/files and
  132.        allow editing
  133.  MACRO filename
  134.        The file "filename" will be invoked.
  135.        No default extension.
  136.  MARK Line|Box
  137.        mark focus line block or box block
  138.  MODify set-option
  139.        display current setting for modification
  140.  MOVE BLOCK [RESET]
  141.        move marked block to focus line/column
  142.  MSG [message]                                                     Y
  143.        display message 
  144.  Next [n|*]                                                        Y
  145.        move current line forward [n] lines
  146.  NEXTWindow
  147.        switch between screens or to the next file
  148.        in the ring
  149.  NOMSG command [parameters]                                        Y
  150.        execute command, suppressing messages
  151.  OS [command...]
  152.        execute host command; pause before returning
  153.  OSNowait command
  154.        execute OS command; no pause before returning
  155.  OSQuiet command
  156.        execute OS command quietly; no pause
  157.  OVERLAYBox
  158.        overlay the contents of the marked block over the
  159.        characters at the current cursor position
  160.  PRint [target][n]|LINE [text]|STRING [text]|FORMfeed|CLOSE        Y
  161.        print specifed data to the default printer or print
  162.        spooler
  163.  PUT [target] [fileid]                                             Y
  164.        write targetted lines to fileid
  165.  PUTD [target] [fileid]                                            Y
  166.        write targetted lines to fileid and delete
  167.        targetted lines
  168.  QQuit                                                             Y
  169.        cancel any changes to file (since last
  170.        save/autosave) and remove file from ring
  171.  Query item                                   
  172.        Displays values for the specified item.
  173.  QUIT                                                              Y
  174.        remove file from ring
  175.  RECover [n|*]
  176.        recover deleted or changed lines
  177.  REDRAW
  178.        redraw screen after disturbance
  179.  REFRESH
  180.        repaint screen during macro execution
  181.  Replace [text]                                                    Y
  182.        replaces the current/focus line with the
  183.        specified text.
  184.  RESet Block|Prefix|ALL
  185.        resets the marked block and/or pending prefix
  186.        commands
  187.  SAVE [fileid]                                                     Y
  188.        write changes to file to disk; remain in ring
  189.  SCHange /string1/string2/ [target] [n] [m]
  190.        selectively changes n occurrences of string1
  191.        to string2 for target
  192.  SET [parameter ..]                                                Y
  193.        Detailed below.
  194.  SHift Left|Right [n] [target]                                     Y
  195.        shift text n columns within the target area
  196.  SHOWkey
  197.        show key pressed and command assigned
  198.  SORT target [[[Ascending|Descending] left_col right_col] [...]]   Y
  199.        show key pressed and command assigned
  200.  SOS
  201.        Not implemented as a command in itself,
  202.        but used as a command prefix for other
  203.        commands.
  204.        See ("SOS Function") section below.
  205.  SPlit [ALigned]
  206.        Splits a line into two.
  207.  SPLTJOIN
  208.        split or join focus line and next line
  209.  SSave [fileid]                                                    Y
  210.        write changes to file to disk (overwriting);
  211.        remain in ring
  212.  STATus [filename]                                                 Y
  213.        display a full screen of status information or
  214.        output to filename as SET commands. with [filename]
  215.        valid from profile file.
  216.  SUSPend
  217.        suspend THE and return to operating system
  218.  TABCmd
  219.        move cursor to/from command line and body or
  220.        prefix.
  221.  TABPre
  222.        move cursor between body and prefix
  223.  TEXT text
  224.        simulate keyboard entry of text
  225.  THE [fileid]                                                      Y
  226.        begin editing specified file or switch
  227.        between files
  228.  TOP                                                               Y
  229.        move current line to top of file
  230.  Up [*|n]                                                          Y
  231.        move current line up n lines
  232.  UPPercase [target]                                                Y
  233.        change the lowercase characters in target
  234.        to uppercase
  235.  Xedit [fileid]                                                    Y
  236.        begin editing specified file or switch
  237.        between files
  238.  
  239.  
  240.  SET parameters:
  241.  ---------------
  242.  [SET] ARBchar ON|OFF [char]                                       Y
  243.        sets arbitrary character processing status
  244.        Default: OFF ?
  245.  [SET] AUtosave OFF|[n]                                            Y
  246.        sets frequency of automatic file saves
  247.        Default: OFF
  248.  [SET] BACKup ON|OFF                                               Y
  249.        Toggles generation of "fname.BAK" on and off.
  250.        Default: ON
  251.  [SET] BEEP ON|OFF                                                 Y
  252.        Toggles sounding of bell for error messages.
  253.        Default: OFF
  254.  [SET] CASE Mixed|Lower|Upper [Respect|Ignore] [Respect|Ignore]    Y
  255.                               [Respect|Ignore]
  256.        Control handling of case of characters in
  257.        input, searches, changes, and sorting.
  258.        Default: MIXED IGNORE RESPECT RESPECT
  259.  [SET] CLEARScreen ON|OFF                                          Y
  260.        indicates if screen cleared on exit
  261.        Default: OFF
  262.  [SET] CLOCK ON|OFF                                                Y
  263.        turn on or off display of time
  264.        Default: ON
  265.  [SET] CMDArrows Retrieve|Tab Scroll|Tab Scroll|Tab                Y
  266.        set behaviour of arrow keys
  267.        Default: Retrieve Scroll Scroll
  268.  [SET] CMDline Top|Bottom                                          Y
  269.        set location of command line
  270.        Default: Bottom
  271.  [SET] COLOUR|COLOR area [modifier] [foreground background]        Y
  272.        sets the colour/attribute of the indicated area
  273.        of the screen
  274.        Valid values for 'area':
  275.          Filearea - area containing file lines
  276.          CUrline  - the current line
  277.          Block    - marked block
  278.          CBlock   - current line if in marked block
  279.          Cmdline  - command line
  280.          Idline   - line containing file specific info
  281.          Msgline  - error messages
  282.          Arrow    - command line prompt
  283.          PRefix   - prefix area
  284.          Pending  - pending commands in prefix
  285.          Scale    - line showing scale line (N/A)
  286.          TOfeof   - *** Top of File *** and *** Bottom of File *** lines
  287.          CTofeof  - as above if the same as current line
  288.          Tabline  - line showing tab positions (N/A)
  289.          SHadow   - hidden line marker lines (N/A)
  290.          STatarea - line showing status of editing session
  291.          Divider  - dividing line between vertical split screens
  292.          Reserved - reserved lines
  293.        Valid values for 'foreground' and 'background':
  294.          BLAck,BLUe,Green,Cyan,RED,Magenta,Yellow,White
  295.        Valid values for 'modifier':
  296.          NORmal,BLInk,BOld,BRIght,High,REVerse,Underline
  297.  [SET] CURLine M[+n|-n] | [+|-]n                                   Y
  298.        set current line on screen
  299.        Default: 6
  300.  [SET] DIRInclude *|[Normal][System][Hidden][Readonly][Directory]
  301.        set file mask for subsequent DIR|LS commands
  302.        (only meaningful for DOS or OS/2)
  303.  [SET] EOLOut CRLF|LF                                              Y
  304.        specify line terminating character(s)
  305.        Default: LF (Unix), CRLF (other)
  306.  [SET] ETMODE ON|OFF                                               Y
  307.        indicate if extended ASCII characters displayed
  308.        Default: OFF (Unix), ON (other)
  309.  [SET] HEX ON|OFF                                                  Y
  310.        set behaviour of strings entered as hex
  311.        Default: OFF
  312.  [SET] HEXDISPLay ON|OFF                                           Y
  313.        turn on or off display of character representation
  314.        on status line
  315.        Default: ON
  316.  [SET] IMPcmscp ON|OFF                                             Y
  317.        indicates status of implied operating system command
  318.        processing
  319.        Default: ON
  320.  [SET] IMPMACro ON|OFF                                             Y
  321.        indicates status of implied macro processing
  322.        Default: ON
  323.  [SET] IMPOS ON|OFF                                                Y
  324.        indicates status of implied operating system command
  325.        processing
  326.        Default: ON
  327.  [SET] INSERTMode ON|OFF|TOGGLE                                    Y
  328.        sets insert/overwrite mode beahviour
  329.        Default: TOGGLE
  330.  [SET] LINENd ON|OFF [char]                                        Y
  331.        sets LINEND value to enable multiple commands on 
  332.        command line
  333.        Default: OFF #
  334.  [SET] MACROExt [ext]                                              Y
  335.        sets default file extension for macro files
  336.        Default: .the
  337.  [SET] MACROPath [path]                                            Y
  338.        sets directory for searching for macros
  339.        Default: (current directory)
  340.  [SET] MARGins left right [indent]                                 Y
  341.        sets margins for wordwrap
  342.        Default: 1 72 +0
  343.  [SET] MSGMode ON|OFF                                              Y
  344.        turn display of messages on or off
  345.        Default: ON
  346.  [SET] NEWLines Aligned|Left                                       Y
  347.        set position of cursor after blank line added
  348.        Default: Aligned
  349.  [SET] NONDisp char                                                Y
  350.        specify character to display for non-displayed
  351.        characters
  352.        Default: #
  353.  [SET] NUMber ON|OFF                                               Y
  354.        indicate if numbers are to appear in prefix area
  355.        Default: ON
  356.  [SET] PENDing ON|OFF|BLOCK [string]                               Y
  357.        set status of pending prefix commands
  358.  [SET] Point .name [OFF]                                           Y
  359.        assign a name to a line
  360.  [SET] PREfix ON|OFF [Left|Right]                                  Y
  361.  [SET] PREfix Synonym newname oldname                              Y
  362.        define if and where prefix area to be displayed or
  363.        define a prefix synonym
  364.        Default: ON LEFT
  365.  [SET] PRINTER name                                                Y
  366.        specify command used to print lines
  367.  [SET] REPROFile ON|OFF                                            Y
  368.        indicate if profile command to be reexecuted
  369.        for each file edited
  370.        Default: OFF
  371.  [SET] REXXOUTput File|Display n                                   Y
  372.        indicate if REXX output to be displayed or
  373.        captured to a file, and set line limit
  374.        Default: DISPLAY 1000
  375.  [SET] STAY ON|OFF                                                 Y
  376.        control how current line is determined after
  377.        CHANGE
  378.        Default: ON
  379.  [SET] TABKey Tab|Character Tab|Character                          Y
  380.        set action of TAB key in different input modes
  381.        Default: Tab Character
  382.  [SET] TABS INCR n                                                 Y
  383.        control width of tabs
  384.        Default: 8
  385.  [SET] TABSIn ON|OFF [n]                                           Y
  386.        control handling of tabs when reading in file
  387.        contents
  388.        Default: OFF 8
  389.  [SET] TABSOut ON|OFF [n]                                          Y
  390.        control handling of tabs when writing out
  391.        file contents
  392.        Default: OFF 8
  393.  [SET] Verify n [m|*]                                              Y
  394.        set columns to display
  395.        Default: 1 *
  396.  [SET] WORDWrap ON|OFF                                             Y
  397.        sets wordwrap on or off
  398.        Default: 1 72 +0
  399.  [SET] Zone n [m]                                                  Y
  400.        control target columns for locates and changes
  401.        Default: 1 *
  402.  
  403.  
  404.  SOS functions:
  405.  --------------
  406.  These functions are more effective if assigned to a key.
  407.  
  408.  SOS ADDline
  409.        insert line after focus line
  410.  SOS CURSORAdj
  411.        move first non-blank character of line to cursor position
  412.  SOS DELBAck
  413.        delete character to left of cursor
  414.  SOS DELChar
  415.        delete character under cursor
  416.  SOS DELEnd
  417.        delete all characters to right of cursor
  418.  SOS DELLine
  419.        delete focus line
  420.  SOS DELWord
  421.        delete word at or to right of cursor
  422.  SOS DOPREfix
  423.        When invoked, will cause commands in the
  424.        prefix area to be executed.
  425.  SOS EDIT
  426.        edit file in DIR.DIR list
  427.  SOS ENDChar
  428.        move cursor to end or start of line
  429.  SOS MAKECURR
  430.        makes the command line the same line as
  431.        the focus line
  432.  SOS TABf
  433.        move cursor to next tab stop
  434.  SOS TABWORDB
  435.        move cursor to start of previous word
  436.  SOS TABWORDf
  437.        move cursor to start of next word
  438.  SOS UNDO
  439.        restore contents of line to original
  440.  
  441.  
  442.  Other key-only commands:
  443.  -----------------------
  444.  Commands that are all lower case CANNOT be used
  445.  on the command line, but MUST be assigned to a
  446.  key in order to function.
  447.  
  448.  cmatch
  449.        find matching bracket/brace/parenthesis
  450.        '<>{}[]()'
  451.  control_char
  452.        allows the user to enter control characters
  453.  down_arrow
  454.        move cursor down one line, scrolling if
  455.        necessary
  456.        (next command displayed if on command line)
  457.  enter
  458.        execute command on command line or next line
  459.  left_arrow
  460.        move cursor left one column scrolling if
  461.        necessary
  462.  right_arrow
  463.        move cursor right one column scrolling if
  464.        necessary
  465.  up_arrow
  466.        move cursor up one line, scrolling if
  467.        necessary
  468.        (prev command displayed if on command line)
  469.  
  470.  
  471.  THE prefix commands:
  472.  -------------------
  473.  a      - add blank line
  474.  i
  475.  /      - make line current line
  476.  c      - copy line
  477.  m      - move line
  478.  d      - delete line
  479.  "      - duplicate line
  480.  p      - target for c and m - prior to line
  481.  f      - target for c and m - following line
  482.  >      - shift line right
  483.  <      - shift line left
  484.  cc     - copy line block
  485.  mm     - move line block
  486.  dd     - delete line block
  487.  ""     - duplicate line block
  488.  >>     - shift line block right
  489.  <<     - shift line block left
  490.  .xxxxx - give name to line
  491.  
  492.  
  493.  THE Targets:
  494.  -----------
  495.  Absolute line target:   :12
  496.  Relative line target:   12  -4  *
  497.  String target:          /string/   -/string/
  498.  All lines in file:      ALL
  499.  
  500.  
  501.  Default Key Assignments:
  502.  ------------------------
  503.  The first column is the name of the key in its normal state. Shifted
  504.  keys have a 'S-' prefix, control keys have a 'C-' prefix and Alt keys
  505.  have a 'A-' prefix. Thus key names for F1 are: F1,S-F1,C-F1 and A-F1.
  506.  The key names are the same as displayed by the showkeys command.
  507.  
  508.  ---------+-------------------+-----------+--------------+-------------
  509.  Key Name | Normal            | Shifted   | Control      | Alt
  510.  ---------+-------------------+-----------+--------------+-------------
  511.  F1       | help              | locate    |              |
  512.  F2       | nextwindow        |           |              |
  513.  F3       | file              | qquit     |              |
  514.  F4       | sos addline 1     |           |              |
  515.  F5       | sos makecurr      |           |              |
  516.  F6       |                   |           |              |
  517.  F7       | cmatch            |           |              |
  518.  F8       | recover           |           |              |
  519.  F9       | sos delline 1     |           |              |
  520.  F10      | spltjoin          |           |              |
  521.  F11      |                   |           | point .a     |
  522.  F12      | control_char      |           | locate .a    |
  523.  CURU     | up_arrow          |           |              |
  524.  CURD     | down_arrow        |           |              |
  525.  CURL     | left_arrow        |           | sos tabwordb |
  526.  CURR     | right_arrow       |           | sos tabwordf |
  527.  INS      | insertmode toggle |           |              |
  528.  DEL      | sos delchar       |           |              |
  529.  HOME     | tabcmd            |           |              |
  530.  END      | sos endchar       |           | sos delend   |
  531.  PGUP     | backward 1        |           | top          |
  532.  PGDN     | forward 1         |           | forward *    |
  533.  BKSP     | sos delback       |           |              |
  534.  ENTER    | enter             |           |              |
  535.  PLUS     | tabpre            |           |              |
  536.  NUMENTER | sos doprefix      |           |              |
  537.  ESC      | sos undo          |           |              |
  538.  TAB      | sos tabf          |           |              |
  539.  A        |                   |           | sos cursoradj|
  540.  B        |                   |           |              | mark box
  541.  C        |                   |           |              | copy block reset
  542.  D        |                   |           |              | duplicate 1 block
  543.  F        |                   |           |              | fillbox
  544.  G        |                   |           |              | delete block
  545.  J        |                   |           |              | join aligned
  546.  K        |                   |           |              | copy block
  547.  L        |                   |           |              | mark line
  548.  M        |                   |           |              | move block
  549.  O        |                   |           |              | overlaybox
  550.  R        |                   |           | redraw       |
  551.  S        |                   |           |              | split aligned
  552.  U        |                   |           |              | reset block
  553.  W        |                   |           |              | sos delword
  554.  X        |                   |           |              | sos edit
  555.  Z        |                   |           | suspend      |
  556.  ---------+-------------------+-----------+--------------+-------------
  557.