home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / systools / enved / enved.doc < prev    next >
Encoding:
Text File  |  1993-12-09  |  11.9 KB  |  570 lines
  1.  
  2.  
  3.                                                                 EnvE-v110-0
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.         ===================================================================
  35.         ENVED
  36.         An Environment Editor
  37.         Version 1.10
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.         (C) Copyright IBM Corporation 1987, 1993
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.         (C) Copyright IBM Corporation 1987, 1993
  68.  
  69.  
  70.  
  71.         -------------------------------------------------------------------
  72.         Version 1.10, December 1993
  73.  
  74.         This program was written by:
  75.  
  76.         Tim Baldwin
  77.  
  78.         IBM UK Laboratories
  79.         Hursley Park
  80.         Winchester
  81.         Hampshire, SO21 2JN
  82.  
  83.         BALDWINT at WINVMB
  84.         baldy@vnet.ibm.com
  85.  
  86.  
  87.         (C) Copyright IBM Corporation 1987, 1993.  All Rights Reserved.
  88.         -------------------------------------------------------------------
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                     Page  i
  129.  
  130.         (C) Copyright IBM Corporation 1987, 1993
  131.  
  132.  
  133.  
  134.         CONTENTS
  135.  
  136.  
  137.           1.0 Introduction  . . . . . . . . . . . . . . . . . . . . . . . 1
  138.           1.1 What Is ENVED?    . . . . . . . . . . . . . . . . . . . . . 1
  139.           1.2 What You Need   . . . . . . . . . . . . . . . . . . . . . . 1
  140.           1.3 Using ENVED   . . . . . . . . . . . . . . . . . . . . . . . 2
  141.             1.3.1 Installing The Editor   . . . . . . . . . . . . . . . . 2
  142.             1.3.2 Starting The Editor   . . . . . . . . . . . . . . . . . 2
  143.             1.3.3 Making Changes  . . . . . . . . . . . . . . . . . . . . 2
  144.             1.3.4 Ending The Editor   . . . . . . . . . . . . . . . . . . 3
  145.           1.4 Keyboard Summary  . . . . . . . . . . . . . . . . . . . . . 3
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.                                                                Contents  ii
  192.  
  193.         (C) Copyright IBM Corporation 1987, 1993
  194.  
  195.  
  196.  
  197.         1.0 INTRODUCTION
  198.  
  199.  
  200.  
  201.         1.1 WHAT IS ENVED?
  202.  
  203.         ENVED is program to allow you to edit the environment strings
  204.         associated with an OS/2 process.  The environment consists of a set
  205.         of variable names each variable having a simple text string value.
  206.         Programs running in that OS/2 process may examine the environment
  207.         and obtain the value of one or more of these environment variables.
  208.         Such programs often use the values they obtain to tailor their
  209.         behaviour for an individual user.
  210.  
  211.         Many environment variables are established and given initial values
  212.         as OS/2 starts up and processes its CONFIG.SYS file.  The
  213.         environment can be displayed by issuing the SET command from and
  214.         OS/2 command prompt, the result shows the variables and their
  215.         associated values and looks something like this:
  216.  
  217.         COMPSEC=C:\OS2\CMD.EXE
  218.         PATH=C:\OS2;C:\OS2\SYSTEM;D:\TOOLS
  219.         DPATH=C:\OS2;C:\OS2\SYSTEM
  220.         etc.
  221.  
  222.  
  223.         The SET command can also be used to add new environment variables,
  224.         to remove variables and to replace an existing variable's value.
  225.         However these values are often quite lengthy and rather than
  226.         replacing the entire value you may just want to make a few small
  227.         changes, this is where an Environment Editor such as ENVED proves
  228.         useful.
  229.  
  230.         ENVED may be particularly useful to program developers, since most
  231.         compilers make extensive use of environment variables to control
  232.         the characteristics of the compilation process.  ENVED makes
  233.         altering those environment variables for debugging, testing or
  234.         experimentation very simple.
  235.  
  236.  
  237.         1.2 WHAT YOU NEED
  238.  
  239.         ENVED will run under IBM's OS/2 2.0 or any later version and
  240.         requires that REXX is installed (which is the default).  It should
  241.         also run under IBM's OS/2 1.3 or 1.2 Extended Edition, but these
  242.         older systems have not been fully tested.
  243.  
  244.         ENVED is supplied as a single file ENVED.ZIP.  This should be
  245.         unpacked using PKUNZIP to give:
  246.  
  247.         ENVED.CMD    This is a REXX program to run the editor.
  248.  
  249.         ENVED.DLL    This a library of functions required by the REXX
  250.                      program.
  251.  
  252.  
  253.  
  254.                                                             Introduction  1
  255.  
  256.         (C) Copyright IBM Corporation 1987, 1993
  257.  
  258.  
  259.  
  260.         ENVED.DOC    This is the full documentation in a plain ASCII
  261.                      printable format.
  262.  
  263.         In addition the package will contain the following important file:
  264.  
  265.         LICENSE.TXT  This contains the terms and conditions under which IBM
  266.                      makes this program available.
  267.  
  268.  
  269.  
  270.         1.3 USING ENVED
  271.  
  272.  
  273.  
  274.         1.3.1 INSTALLING THE EDITOR
  275.  
  276.         Simply ensure that ENVED.CMD is placed in a subdirectory that is
  277.         listed in your PATH and that ENVED.DLL is placed in a subdirectory
  278.         that is listed in your LIBPATH.
  279.  
  280.  
  281.         1.3.2 STARTING THE EDITOR
  282.  
  283.         From an OS/2 full screen or windowed command session enter the
  284.         following command at the OS/2 prompt:
  285.  
  286.         ENVED <var1> <var2> ...
  287.  
  288.  
  289.         You can put any number, including zero, of environment variable
  290.         names after the ENVED command.  Each variable that you specify will
  291.         be presented in a full screen edit panel (one variable per line)
  292.         together with its current value.  If any of the variables are
  293.         currently not set they will be displayed with a blank value.  If
  294.         you do not specify any variable names the a complete copy the the
  295.         current environment will be displayed.  The list of environment
  296.         variables is always initially displayed sorted into alphabetical
  297.         order.
  298.  
  299.  
  300.         1.3.3 MAKING CHANGES
  301.  
  302.         You may move the cursor anywhere between the "Top of Environment"
  303.         and "End of Environment" markers using the cursor control keys and
  304.         you may make any changes you wish.  The editor starts in "replace"
  305.         mode whereby any characters you type overwrite those already
  306.         present, you may toggle to "insert" mode by pressing the Ins or
  307.         Insert key.  The current mode is indicated by the size of the
  308.         cursor.
  309.  
  310.         You may change the value of any environment variable by altering
  311.         the text to the right of the "=" sign, or you may change the name
  312.         of the variable to the left of the "=" sign (or you may change
  313.         both).  If you change a variable's name this will effectively add
  314.         a new variable leaving the old one unchanged.
  315.  
  316.  
  317.                                                             Introduction  2
  318.  
  319.         (C) Copyright IBM Corporation 1987, 1993
  320.  
  321.  
  322.  
  323.         To add a new environment variable either press Ctrl-Enter to add a
  324.         blank line and the type both the variable name and its value, or
  325.         choose the existing variable that most closely matches the new one,
  326.         press Alt-R to duplicate it, then make the required changes.
  327.  
  328.         To remove an environment variable you must set its value to
  329.         nothing, like this:
  330.  
  331.         VARIABLE=
  332.  
  333.  
  334.         The Alt-T (truncate line) key is useful for doing this.
  335.  
  336.         Note: Pressing Ctrl-Backspace (delete line) simply removes a
  337.         variable from the list currently being edited; it does not delete
  338.         the variable or its value from the environment.
  339.  
  340.  
  341.         1.3.4 ENDING THE EDITOR
  342.  
  343.         To end ENVED and return to the OS/2 command prompt press either F3
  344.         or F10.
  345.  
  346.         -  F3 will discard any changes you made, leaving the environment
  347.            settings exactly as they were before ENVED was invoked.
  348.  
  349.         -  F10 will update the current environment with all the changes you
  350.            made.
  351.  
  352.  
  353.  
  354.         1.4 KEYBOARD SUMMARY
  355.  
  356.         The following lists all the editing key actions that are available
  357.         in ENVED.  These keys are similar to those used by the TINYED
  358.         editor, although only a subset of TINYED's keys are provided.
  359.  
  360.         Right            Move the cursor one character to the right.
  361.  
  362.         Left             Move the cursor one character to the left.
  363.  
  364.         Up               Move the cursor up one line.
  365.  
  366.         Down             Move the cursor down one line.
  367.  
  368.         Ctrl-Right       Move the cursor forward to the start of the next
  369.                          word.
  370.  
  371.         Ctrl-Left        Move the cursor back to the start of the previous
  372.                          word.
  373.  
  374.         Tab              Move the cursor forward to the next tab position
  375.                          (tabs are every eight columns).
  376.  
  377.         Shift-Tab        Move the cursor back to the previous tab position
  378.  
  379.  
  380.                                                             Introduction  3
  381.  
  382.         (C) Copyright IBM Corporation 1987, 1993
  383.  
  384.  
  385.  
  386.                          (tabs are every eight columns).
  387.  
  388.         Home             Move the cursor to the start of the current line.
  389.  
  390.         End              Move the cursor to the end of the current line.
  391.  
  392.         Ctrl-Home        Move the cursor to the top of the list of
  393.                          environment variables.
  394.  
  395.         Ctrl-End         Move the cursor to the end of the list of
  396.                          environment variables.
  397.  
  398.         Page Up          Scroll the list of environment variables up by one
  399.                          screenful.
  400.  
  401.         Page Down        Scroll the list of environment variables down by
  402.                          one screenful.
  403.  
  404.         Enter            Move the cursor down one one and back to the start
  405.                          of the line.
  406.  
  407.         Ctrl-Enter       Add a new blank line to the list of environment
  408.                          variables.
  409.  
  410.         Backspace        Delete the character to the left of the cursor.
  411.  
  412.         Ctrl-Backspace   Remove the current environment variable from the
  413.                          list being edited.
  414.  
  415.         Delete           Delete the character at the cursor position.
  416.  
  417.         Insert           Toggle between "replace" "insert" typing mode.
  418.  
  419.         Alt-J            Join the next line to the end of the current line.
  420.  
  421.         Alt-R            Repeat the current line (insert a new copy of the
  422.                          current environment variable into the list).
  423.  
  424.         Alt-S            Split the current line at the cursor position.
  425.  
  426.         Alt-T            Truncate the current line (delete all the
  427.                          characters from the cursor position to the end of
  428.                          the line).
  429.  
  430.         F1               Display some help information; press Esc to remove
  431.                          the help panel.
  432.  
  433.         F3               Quit the editor without making any changes.
  434.  
  435.         F10              Update the environment will all the changes made.
  436.  
  437.         Others           You can also enter any ASCII character by holding
  438.                          down the Alt key, typing the character's ASCII
  439.                          value (in decimal, from 1 to 255) on the numeric
  440.                          keypad and releasing the Alt key.
  441.  
  442.  
  443.                                                             Introduction  4
  444.  
  445.         (C) Copyright IBM Corporation 1987, 1993
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.                                                             Introduction  5
  507.  
  508.         ===================================================================
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.         ===================================================================
  525.  
  526.         (C) Copyright IBM Corporation 1987, 1993
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.                                                         Printed in the U.K. 
  570.