home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 620.lha / Env_v2.08 / Env.doc.pp / Env.doc
Text File  |  1992-03-01  |  10KB  |  292 lines
  1.       *
  2.     * Copyright 1991 by "Soft from the Wood" and Stefan Otto
  3.     * All rights reserved.
  4.     *
  5.     * This programm is in the Pulic Domain.
  6.     *
  7.     * Send flames, bug reports, requests to :
  8.     *
  9.     * Stefan Otto
  10.     * Uhlandstr. 21
  11.     * W-6200 Wiesbaden - Germany
  12.     *
  13.     * You may pass the program around as long as this doc file
  14.     * remains a part of it.
  15.     *
  16.     * If you would like to distribute this program with your
  17.     * software, you must contact me first.
  18.     *
  19.     * The entire risk as to the quality and performance
  20.     * of this program is with you.
  21.     *
  22.     * Hey distributors !
  23.     * Please read "IMPORTANT NOTICE" at the end of this text.
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                  Env V2.08
  30.  
  31.                       © 1991 by "Soft from the Wood"
  32.                              and Stefan Otto
  33.  
  34.  
  35.  OVERVIEW
  36. ==========
  37.     Env is a user-friendly tool to edit your "environments". You can
  38.     change, add, copy, rename and delete them with a new OS2.x intuition
  39.     GUI, instead of using DOS SetEnv/GetEnv:
  40.  
  41.     - All windows and gadgets open up "font-sensitiv"!!!
  42.     - Window opens on default publicscreen.
  43.     - Includes a "window appears under mouse-pointer" feature.
  44.     - All custom gadgets have a keyboard shortcut for "power users"
  45.       (look at the underlined character in the labels).
  46.     - Your can cancel all windows with the ESC-key.
  47.     - Additionally all windows have intuition pull-down menus.
  48.     - All settings can be saved (as environment of course).
  49.     - Doubleclick in listview is supported.
  50.     - shell command line support
  51.     - nice icon :-)
  52.     - DAU - tested (*1)
  53.  
  54.  
  55.  SYSTEM REQUIREMENTS
  56. =====================
  57.    AmigaOS 2.x
  58.       Because of heavy use of 2.0 functions it would be hard to do
  59.       the same under old 1.3 OS.
  60.  
  61.    gadtools.library V37.xx or higher
  62.       According to some features not been supported by previous
  63.       versions of gadtools.library Env needs V37.xx
  64.  
  65.    graphics.library  V36
  66.    intuition.library V36
  67.    diskfont.library  V36
  68.  
  69.    about 50k Byte of free memory.
  70.  
  71.    Assigns ENV: and ENVARC:
  72.  
  73.  
  74.  COMMANDS
  75. ==========
  76.    New Env...  (shortcut: 'N',  menu: right Amiga 'N')
  77.    Opens a new window asking for the new name of the new environment and
  78.    its contents. Your must give at least the name - without I can`t create
  79.    a file and the only way to leave is to cancel it. This window has also
  80.    its own menu.
  81.  
  82.     Save            (shortcut: 'S',  menu: right Amiga 'S')
  83.        The "Save" command saves the file to "ENV:" AND also to "ENVARC:",
  84.        so that it will not be lost even if your reset or switch off your
  85.        computer.
  86.  
  87.     Use             (shortcut: 'U',  menu: right Amiga 'U')
  88.        The "Use" command saves the file only to "ENV:". Normaly "ENV:"
  89.        is in your RAM Disk, so it will be lost is you reset or switch
  90.        off your computer!!!
  91.  
  92.     Cancel        (shortcut: 'C',  menu: right Amiga 'C')
  93.        "Cancel" cancels this window. Clicking on the system's Close-
  94.        Window-Gadget or pressing ESC will do the same.
  95.  
  96.  
  97.    Get Env...  (shortcut: 'G',  menu: right Amiga 'G')
  98.    You see the value of the selected environment. To leave this window use:
  99.  
  100.       Save          (shortcut: 'S',  menu: right Amiga 'S')
  101.         Saves the file to "ENV:" AND also to "ENVARC:".
  102.  
  103.       Use           (shortcut: 'U',  menu: right Amiga 'U')
  104.         "Use" saves the file only to "ENV:". Normaly "ENV:" is in your
  105.         RAM Disk, so that it will be lost if you reset or switch off
  106.         your computer.
  107.  
  108.       Cancel        (shortcut: 'C',  menu: right Amiga 'C')
  109.         "Cancel" cancels creating a new environment. Clicking on the
  110.         gadget "Cancel" or the system's Close-Window-Gadget or pressing
  111.         ESC or just "C" will do the same.
  112.  
  113.  
  114.    Rename Env...  (shortcut: 'R',  menu: right Amiga 'R')
  115.    You rename the selected environment. To leave this window use:
  116.  
  117.       Save          (shortcut: 'S',  menu: right Amiga 'S')
  118.         Rename the file in "ENV:" and also in "ENVARC:".
  119.  
  120.       Use           (shortcut: 'U',  menu: right Amiga 'U')
  121.         "Use" renames the file only in "ENV:". Normaly "ENV:" is in
  122.         your RAM Disk, so that it will be lost if you reset or switch
  123.         off your computer!
  124.  
  125.       Cancel        (shortcut: 'C',  menu: right Amiga 'C')
  126.         "Cancel" cancels this window. Clicking on the system's Close-
  127.         Window-Gadget or pressing ESC will do the same.
  128.  
  129.  
  130.    Delete Env  (shortcut: 'D',  menu: right Amiga 'D')
  131.    Deletes the selected environment. If the option "ask before Delete"
  132.    has been turned on, Env will ask:
  133.       "Warning: you cannot get back what you delete!"
  134.             OK! Delete          No! Cancel
  135.    Otherwise "Env" doesn`t ask and deletes directly.
  136.  
  137.  
  138.    About...
  139.       Any suggestions?
  140.  
  141.  
  142.    Quit  (shortcut: 'Q',  menu: right Amiga 'Q')
  143.    Clicking on gadget "Quit" will quit Env. Using the system's Close-
  144.    Window-Gadget or pressing the Key "q" or even ESC will do the same.
  145.    If the option "ask before Quit" is checked I will ask:
  146.           Quit?
  147.       OK       Cancel
  148.  
  149.  
  150.    Copy to ENVARC:  (shortcut: 'U',  menu: right Amiga 'U')
  151.    This function will copy all environments (without subdirectories!!!)
  152.    from the volatile "Env:" to EnvArc:, which is located for example
  153.    on your Harddisk.
  154.  
  155.  
  156.    Copy to ENV:     (shortcut: 'C',  menu: right Amiga 'C')
  157.    Just the same as "Copy to ENVARC:" but in the opposite direction.
  158.  
  159.  
  160.    Prefs
  161.       ask before Delete            (right Amiga '?')
  162.       ask before Quit              (right Amiga 'A')
  163.       don`t appear under Mouse     (right Amiga 'M')
  164.          see OPTIONS.
  165.  
  166.       Save as Defaults             (right Amiga 'E')
  167.          Save the currend settings to "ENVARC:".
  168.  
  169.  
  170.  OPTIONS
  171. =========
  172.    ask before Delete   (right Amiga '?')
  173.       If this option is checked I ask before deleting an environment.
  174.       By default this option is turned off.
  175.  
  176.    ask before Quit     (right Amiga 'A')
  177.       If this option is checked I ask before quiting the program.
  178.       By default this option is turned off.
  179.  
  180.    don`t appear under Mouse  (right Amiga 'M')
  181.       If this option is checked I open all windows at the same location
  182.       on the screen (about 10,10) and NOT under your mouse pointer, which
  183.       is the default setting.
  184.  
  185.    case senitive Sort
  186.       This option has no menu item. The default setting of this option is
  187.       off, but if you wish to change, create an environment named
  188.       "EnvEnv" and fill in the keyword "CASE". Next time you start Env
  189.       the Listview of environments will be sorted case-sensitiv.
  190.  
  191.  
  192.  THE MENUS
  193. ===========
  194. (see COMMANDS for more information)
  195.     Project
  196.         New Env...                   (right Amiga 'N')
  197.         Get Env...                   (right Amiga 'G')
  198.         Rename Env...                (right Amiga 'R')
  199.         Delete Env                   (right Amiga 'D')
  200.         About...
  201.         Quit                         (right Amiga 'Q')
  202.  
  203.     Update
  204.         Copy to ENVARC:              (right Amiga 'U')
  205.         Copy to ENV:                 (right Amiga 'C')
  206.  
  207.     Prefs
  208.         Ask before Delete            (right Amiga '?')
  209.         Ask before Quit              (right Amiga 'A')
  210.         don`t appear under Mouse     (right Amiga 'M')
  211.         Save as Defaults             (right Amiga 'E')
  212.  
  213.  
  214.  SHELL OPTIONS
  215. ===============
  216.    <no option>
  217.       Opens the main window including the environment listview.
  218.  
  219.    ?
  220.       Prompts for further arguments (see below). You can cancel
  221.       now by simply pressing RETURN (DOS return code is set to 5).
  222.  
  223.    NAME
  224.       The first (or only) name you specify will be interpreted by Env
  225.       as the name of an environment. If you don't specify any other
  226.       argument Env will come up with its "Get Env..." requester where
  227.       you can edit the environment's value. Especially Env will NOT
  228.       open its main window with the listview and it will end immediatly
  229.       after finishing the "Get Env..." requester.
  230.  
  231.    CONTENTS
  232.       ALL following arguments will be copied into the environment
  233.       specified by the first NAME argument!!!! No window will show up,
  234.       no message printed out. Only changes the environment in "ENV:"!
  235.  
  236.    Examples:
  237.       env Username foo bar
  238.       - Sets the environment "Username" to its value "foo bar".
  239.  
  240.       env Workbench
  241.       - Brings up the "Get Env..." requester for environment "Workbench".
  242.  
  243.  
  244.  RETURN CODES
  245. ==============
  246.    In critical situations (No free memory, ENV: not assigned) Env will
  247.    set both Shell return codes, Result1 to a value above 0 and Result2
  248.    the according DOS error code.
  249.  
  250.    Example:
  251.       assign env: remove
  252.       env
  253.       - No window will be opened.
  254.         Result1: 25
  255.         Result2: 218  (Volume not mounted)
  256.  
  257.  
  258.  ENHANCEMENTS
  259. ==============
  260.    Today Env doesn't support subdirectories in ENV: which means that
  261.    subdirectories will not be listed and for that can nor be entered,
  262.    renamed or removed.
  263.  
  264.    The Help! gadget and the Help key are both not supported today.
  265.  
  266.    Localiced software version :-)
  267.  
  268.  
  269.  
  270. (*1)
  271.      D ümmster          (most stupid)
  272.      A nzunehmender     (supposeabel)
  273.      U ser              (user)
  274.  
  275. -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
  276.  IMPORTANT NOTICE:  This program is copyrighted by Stefan Otto, but can
  277.  be freely distributed, providing that the following rules are respected.
  278.  - No change is made to the program or to the accompaning documentation
  279.  - The package is always distributed in its complete form consisting of
  280.    2 files: "Env" and "Env.doc".
  281.  - Every form of distribution is allowed and encouraged, but no fee can
  282.    be charged for this program exept for, possibly, the cost of magnetic
  283.    media and/or disk duplication and shipping.
  284.  - Inclusion in PD software libraries such as Fish Disks is allowed.
  285.  - The program cannot be distributed in any commercial product without the
  286.    written consent of the author.
  287.  By copying, distributing and/or using the program you indicate your
  288.  acceptance of the above rules.
  289.  In no event will the author be liable for direct or indirect damage or
  290.  loss resulting from the use of this program.
  291. -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
  292.