@DATABASE environment2.2
@$VER: Env 2.25 (04.04.94)
@(C) Copyright 1991-1994 by Stefan Otto. All rights reserved.
@AUTHOR Stefan Otto
@WIDTH 80
@WORDWRAP
@INDEX Index
 This program is Freeware.

@Node Index "Index"
Index:
   @{"About" link envAbout}
   @{"AddWin Cancel" link envaddc}
   @{"AddWin contents" link envaddcon}
   @{"AddWin Name" link envaddname}
   @{"AddWin Save" link envadds}
   @{"AddWin Use" link envaddu}
   @{"Ask before Delete" link envAskDel}
   @{"Ask before Quit" link envAskQuit}
   @{"commands" link COMMANDS}
   @{"Copy to ENV:" link envCopyEnv}
   @{"Copy to ENVARC:" link envCopyEnvArc}
   @{"DAU" link DAU}
   @{"Delete Env" link envDelete}
   @{"don`t appear under Mouse" link envUnderMouse}
   @{"enhancements" link ENHANCEMENTS}
   @{"Env Help!" link envhelp}
   @{"Get Env" link envGet}
   @{"GetWin Cancel" link envgetc}
   @{"GetWin contents" link envgetcon}
   @{"GetWin Save", link envgets}
   @{"GetWin User" link envgetu}
   @{"important notice" link  NOTICE}
   @{"Listview Gadget" link envList}
   @{"menus" link MENUS}
   @{"New Env" link envNew}
   @{"options" link OPTIONS}
   @{"overview" link OVERVIEW }
   @{"Quit" link envQuit}
   @{"Rename Cancel" link envrenc}
   @{"Rename Env" link envRename}
   @{"Rename Save" link envrens}
   @{"Rename Use" link envrenu}
   @{"RenWin contents" link envrencon}
   @{"requirements"  link REQUIREMENTS}
   @{"return codes" link RETURN_CODES}
   @{"Save as Defaults" link envSavePrefs}
   @{"shell" link SHELL}
   @{"String" link envlistst}
   @{"tool types" link TOOL_TYPES}
@endnode
@node Main "environment/main"
                               @{b}Env V2.25@{ub}             (04.04.94)

                            © 1991-1994 Stefan Otto


@{u}Contents :@{uu}

       @{"Overview" link OVERVIEW }
       @{"System Requirements" link REQUIREMENTS }
       @{"Commands" link COMMANDS }
       @{"Options" link OPTIONS }
       @{"Menus" link MENUS }
       @{"Shell Options" link SHELL }
       @{"Tool Types" link TOOL_TYPES }
       @{"Return Codes" link RETURN_CODES }
       @{"Enhancements " link ENHANCEMENTS }
       @{"Copyrigh notice" link NOTICE }

@endnode
@node OVERVIEW "environment/overview"

@{u}OVERVIEW@{uu}

    Env is a user-friendly tool to edit your "environments". You can
    change, add, copy, rename and delete them with a new OS2.x intuition
    GUI, instead of using DOS SetEnv/GetEnv:

    · All windows and @{"Gadgets" link COMMANDS } open up "font-sensitiv"!
    · Window opens on default or specified @{"public screen" link TOOL_TYPES }.
    · Includes a "window appears under mouse-pointer" feature.
    · All custom @{"Gadgets" link COMMANDS } have a keyboard shortcut for "power users"
      (look at the underlined character in the labels).
    · Your can cancel all windows with the ESC-key.
    · Additionally all windows have intuition pull-down @{"Menus" link MENUS } .
    · All @{"settings" link OPTIONS } can be saved (as environment of course).
    · Doubleclick in listview is supported.
    · @{"Shell" link SHELL } command line support
    · @{"Help" link envhelp} support by AmigaGuide®
    · read @{"ToolTypes" link TOOL_TYPES }
    · nice icon :-)
    · @{"DAU" link DAU } - tested

@endnode
@node REQUIREMENTS "environment/requirements"

@{u} SYSTEM REQUIREMENTS @{uu}

   AmigaOS 2.x or higher
      Because of heavy use of 2.0 functions it would be hard to do
      the same under old 1.3 OS.

   gadtools.library V37.xx or higher
      According to some features not been supported by previous
      versions of gadtools.library Env needs V37.xx

   graphics.library  V36
   intuition.library V36
   diskfont.library  V36
   amigaguide.library V33

   about 60k Byte of free memory.

   Assigns "ENV:" and "ENVARC:"

@endnode
@node COMMANDS "environment/commands"

@{u}COMMANDS@{uu}

   @{u}New Env...@{uu}  (shortcut: 'N',  menu: right Amiga 'N')
   Opens a new window asking for the new name of the new environment and
   its contents. Your must give at least the name - without I can`t create
   a file and the only way to leave is to cancel it. This window has also
   its own menu.

    Save            (shortcut: 'S',  menu: right Amiga 'S')
       The "Save" command saves the file to "ENV:" AND also to "ENVARC:",
       so that it will not be lost even if your reset or switch off your
       computer.

    Use             (shortcut: 'U',  menu: right Amiga 'U')
       The "Use" command saves the file only to "ENV:". Normally "ENV:"
       is in your RAM Disk, so it will be lost is you reset or switch
       off your computer!!!

    Cancel        (shortcut: 'C',  menu: right Amiga 'C')
       "Cancel" cancels this window. Clicking on the system's Close-
       Window-Gadget or pressing ESC will do the same.


   @{u}Get Env...@{uu}  (shortcut: 'G',  menu: right Amiga 'G')
   You see the value of the selected environment. To leave this window use:

      Save          (shortcut: 'S',  menu: right Amiga 'S')
        Saves the file to "ENV:" AND also to "ENVARC:".

      Use           (shortcut: 'U',  menu: right Amiga 'U')
        "Use" saves the file only to "ENV:". normally "ENV:" is in your
        RAM Disk, so that it will be lost if you reset or switch off
        your computer.

      Cancel        (shortcut: 'C',  menu: right Amiga 'C')
        "Cancel" cancels creating a new environment. Clicking on the
        gadget "Cancel" or the system's Close-Window-Gadget or pressing
        ESC or just "C" will do the same.


   @{u}Rename Env...@{uu}  (shortcut: 'R',  menu: right Amiga 'R')
   You rename the selected environment. To leave this window use:

      Save          (shortcut: 'S',  menu: right Amiga 'S')
        Rename the file in "ENV:" and also in "ENVARC:".

      Use           (shortcut: 'U',  menu: right Amiga 'U')
        "Use" renames the file only in "ENV:". normally "ENV:" is in
        your RAM Disk, so that it will be lost if you reset or switch
        off your computer!

      Cancel        (shortcut: 'C',  menu: right Amiga 'C')
        "Cancel" cancels this window. Clicking on the system's Close-
        Window-Gadget or pressing ESC will do the same.


   @{u}Delete Env@{uu}  (shortcut: 'D',  menu: right Amiga 'D')
   Deletes the selected environment. If the option @{"ask before Delete" link OPTIONS }
   has been turned on, Env will ask:

      "Warning: you cannot get back what you delete!"
            OK! Delete          No! Cancel

   Otherwise "Env" doesn't`t ask and deletes directly.


   @{u}About...@{uu}
      Any suggestions? @{"*" link notice}


   @{u}Quit@{uu}  (shortcut: 'Q',  menu: right Amiga 'Q')
   Clicking on gadget "Quit" will quit Env. Using the system's Close-
   Window-Gadget or pressing the Key "q" or even ESC will do the same.
   If the option "ask before Quit" is checked I will ask:

         Quit?
     OK       Cancel


   @{u}Copy to ENVARC:@{uu}  (shortcut: 'U',  menu: right Amiga 'U')
   This function will copy all environments (without subdirectories!!!)
   from the volatile "Env:" to EnvArc:, which is located for example
   on your Harddisk.


   @{u}Copy to ENV:@{uu}     (shortcut: 'C',  menu: right Amiga 'C')
   Just the same as "Copy to ENVARC:" but in the opposite direction.


   @{u}Prefs@{uu}
      ask before Delete            (right Amiga '?')
      ask before Quit              (right Amiga 'A')
      don`t appear under Mouse     (right Amiga 'M')
         see @{"Options" link OPTIONS}.

      Save as Defaults             (right Amiga 'E')
         Save the current @{"settings" link OPTIONS } to "ENVARC:".

@endnode
@node  OPTIONS "environment/options"
@{u}OPTIONS@{uu}

   ask before Delete   (right Amiga '?')
      If this option is checked I ask before deleting an environment.
      By default this option is turned off.

   ask before Quit     (right Amiga 'A')
      If this option is checked I ask before quitting the program.
      By default this option is turned off.

   don`t appear under Mouse  (right Amiga 'M')
      If this option is checked I open all windows at the same location
      on the screen (about 10,10) and NOT under your mouse pointer, which
      is the default setting.

   case senitive Sort
      This option has no menu item. The default setting of this option is
      off, but if you wish to change, create an environment named
      "EnvEnv" and fill in the keyword "CASE". Next time you start Env
      the Listview of environments will be sorted case-sensitiv.

@endnode
@node MENUS "environment/menus"

@{u}THE MENUS@{uu}

(see @{"Commands" link COMMANDS } for more information)
    Project
        @{"New Env..." link envnew}                   (right Amiga 'N')
        @{"Get Env..." link envget}                   (right Amiga 'G')
        @{"Rename Env..." link envrename}                (right Amiga 'R')
        @{"Delete Env" link envdelete}                   (right Amiga 'D')
        @{"About..." link envabout}
        @{"Quit" link envquit}                         (right Amiga 'Q')

    Update
        @{"Copy to ENVARC:" link  envcopyenvarc}              (right Amiga 'U')
        @{"Copy to ENV:" link  envcopyenv }                 (right Amiga 'C')

    Prefs
        @{"Ask before Delete" link  envaskdel}            (right Amiga '?')
        @{"Ask before Quit" link    envaskquit }              (right Amiga 'A')
        @{"don`t appear under Mouse" link  envundermouse}     (right Amiga 'M')
        @{"Save as Defaults" link   envsaveprefs}             (right Amiga 'E')

@endnode
@node SHELL "environment/shell"

@{u}SHELL OPTIONS@{uu}

   <no option>
      Opens the main window including the environment listview.

   ?
      Prompts for further arguments (see below). You can cancel
      now by simply pressing RETURN (DOS return code is set to 5).

   NAME
      The first (or only) name you specify will be interpreted by Env
      as the name of an environment. If you don't specify any other
      argument Env will come up with its "Get Env..." requester where
      you can edit the environment's value. Especially Env will NOT
      open its main window with the listview and it will end immediately
      after finishing the "Get Env..." requester.

   CONTENTS
      ALL following arguments will be copied into the environment
      specified by the first NAME argument!!!! No window will show up,
      no message printed out. Only changes the environment in "ENV:"!

   Examples:
      env Username foo bar
      - Sets the environment "Username" to its value "foo bar".

      env Workbench
      - Brings up the "Get Env..." requester for environment "Workbench".

@endnode
@node TOOL_TYPES "environment/tool types"

@{u}TOOL TYPES@{uu}

    FONTNAME=<.font>
        Open up all windows with the specified font.

    FONTSIZE=<size>
        Open up all windows with the specified font size.

    PUBSCREEN=<public screen name>
        Open up all windows on specified public screen.

@endnode
@node RETURN_CODES "environment/return codes"

@{u}RETURN CODES@{uu}

   In critical situations (No free memory, ENV: not assigned) Env will
   set both Shell return codes, Result1 to a value above 0 and Result2
   the according DOS error code.

   Example:
      assign env: remove
      env
      - No window will be opened.
        Result1: 25
        Result2: 218  (Volume not mounted)


@endnode
@node ENHANCEMENTS "environment/enhancements"

@{u}ENHANCEMENTS@{uu}

   Today Env doesn't support subdirectories in ENV: which means that
   subdirectories will not be listed and for that can nor be entered,
   renamed or removed.

@endnode
@node DAU "environment/DAU"

     D ümmster          (most stupid)
     A nzunehmender     (supposeabel)
     U ser              (user)

@endnode
@node NOTICE "environment/important notice"

 Send flames, bug reports, requests to :

@{b} Stefan Otto
 Uhlandstr. 21
 D-65189 Wiesbaden - Germany @{ub}

 email: stefan.otto@web.de
 http://home.arcor.de/ghostfire/

@{b}COPYRIGHT NOTICE:@{ub} This is program Freeware, but copyrighted by
Stefan Otto. It can be freely distributed, providing that the
following rules  are respected :

 · The program cannot be distributed in any commercial product without the
   written consent of the author.
 · No change is made to the program or to the accompaning documentation.
 · The package is always distributed in its complete form consisting of
   3 files: "Env", "Env.guide" and "Env.doc".
 · Every form of distribution is allowed and encouraged, but no fee can
   be charged for this program exept for, possibly, the cost of magnetic
   media and/or disk duplication and shipping.
   The cost is limited to   5 EU ,or equal, for one Floppy Disk
                      and  60 EU ,or equal, for one CD-ROM.
 · Inclusion in PD software libraries such as Fish Disks is allowed.

 @{b}By copying, distributing and/or using the program you indicate your
 acceptance of the above rules. In no event will the author be liable for
 direct or indirect damage or loss resulting from the use of this program.@{ub}

@endnode
@node envNew "environment/New Env"

   @{u}New Env...@{uu}  (shortcut: 'N',  menu: right Amiga 'N')

   Opens a new window asking for the new name of the new environment and
   its contents. Your must give at least the name - without I can`t create
   a file and the only way to leave is to cancel it. This window has also
   its own menu.

   @{"Save" link envadds }        @{"Use" link envaddu }        @{"Cancel" link envaddc }
@endnode
@Node  envadds "environment/AddWin Save"

    Save            (shortcut: 'S',  menu: right Amiga 'S')

       The "Save" command saves the file to "ENV:" AND also to "ENVARC:",
       so that it will not be lost even if your reset or switch off your
       computer.
@endnode
@Node   envaddu "environment/AddWin Use"

    Use             (shortcut: 'U',  menu: right Amiga 'U')

       The "Use" command saves the file only to "ENV:". normally "ENV:"
       is in your RAM Disk, so it will be lost is you reset or switch
       off your computer!!!
@endnode
@Node   envaddc "environment/AddWin Cancel"

    Cancel        (shortcut: 'C',  menu: right Amiga 'C')

       "Cancel" cancels this window. Clicking on the system's Close-
       Window-Gadget or pressing ESC will do the same.

@endnode
@node envGet  "environment/Get Env"

   @{u}Get Env...@{uu}  (shortcut: 'G',  menu: right Amiga 'G')

    This is a requester of the contents of a selected environment.
    The value is shown in the string gadget. A string gadget can only
    show ASCI Charaters. Env can`t edit binary files - of you load binary data
    into this gadget non charaters will be filtered out. If you press @{"Save" link envgets }
    or @{"Use" link envgetu } the file will be over written with filtered data, but if you press
    @{"Cancel" link envgets} no file will be touched.

                                @{u}To leave this window use:@{uu}
    · right Amiga 'S'
    same as @{"Save" link envgets}. Replace the contents of the selected environment with the contents
    of the string gadget. Make this environment ready to use, until its deleted.

    · right Amiga 'U'
    same as @{"Use" link envgetu}. Replace the contents of the selected environment with the contents
    of the string gadget. Make this environment ready to use, but only @{b}volatile@{ub}.

    · right Amiga 'C'
    same as @{"Cancel" link envgetc } or Esc-Key

    · Esc-Key
    cancel you new contents - don`t touch any files (same as @{"Cancel" link envgetc } )

@endnode
@Node   envgets "environment/GetWin Save",

      Save          (shortcut: 'S',  menu: right Amiga 'S')

        Saves the file to "ENV:" AND also to "ENVARC:".
@endnode
@Node   envgetu "environment/GetWin User"

      Use           (shortcut: 'U',  menu: right Amiga 'U')

        "Use" saves the file only to "ENV:". normally "ENV:" is in your
        RAM Disk, so that it will be lost if you reset or switch off
        your computer.
@endnode
@Node   envgetc "environment/GetWin Cancel"

      Cancel        (shortcut: 'C',  menu: right Amiga 'C')

        "Cancel" cancels creating a new environment. Clicking on the
        gadget "Cancel" or the system's Close-Window-Gadget or pressing
        ESC or just "C" will do the same.
@endnode
@Node   envgetcon "environment/GetWin contents"

    @{u}String gadget of contents@{uu}

    This is a String-Gadget with the contents of a environment. A string gadget
    can only show ASCI Charaters. Env can`t edit binary files - of you load binary data
    into this gadget non charaters will be filtered out. If you press @{"Save" link envgets }
    or @{"Use" link envgetu } the file will be over written with filtered data, but if you press
    @{"Cancel" link envgets} no file will be touched.

@endnode
@node envRename  "environment/Rename Env"

   @{u}Rename Env...@{uu}  (shortcut: 'R',  menu: right Amiga 'R')

   You rename the selected environment. To leave this window use:

@{"Save" link envrens }        @{"Use" link envrenu }        @{"Cancel" link envrenc }
@endnode
@Node   envrens "environment/Rename Save"

      Save          (shortcut: 'S',  menu: right Amiga 'S')

        Rename the file in "ENV:" and also in "ENVARC:".
@endnode
@Node   envrenu "environment/Rename Use"

      Use           (shortcut: 'U',  menu: right Amiga 'U')

        "Use" renames the file only in "ENV:". normally "ENV:" is in
        your RAM Disk, so that it will be lost if you reset or switch
        off your computer!
@endnode
@Node   envrenc "environment/Rename Cancel"

      Cancel        (shortcut: 'C',  menu: right Amiga 'C')

        "Cancel" cancels this window. Clicking on the system's Close-
        Window-Gadget or pressing ESC will do the same.
@endnode
@node envDelete  "environment/Delete Env"

   @{u}Delete Env@{uu}  (shortcut: 'D',  menu: right Amiga 'D')

   Deletes the selected environment. If the option "ask before Delete"
   has been turned on, Env will ask:

      "Warning: you cannot get back what you delete!"
            OK! Delete          No! Cancel

   Otherwise "Env" doesn't`t ask and deletes directly.

@endnode
@node envAbout  "environment/About"

   @{u}About...@{uu}

      Any suggestions? look at @{"copyright notice" link notice}

@endnode
@node envQuit  "environment/Quit"

   @{u}Quit@{uu}  (shortcut: 'Q',  menu: right Amiga 'Q')

   Clicking on gadget "Quit" will quit Env. Using the system's Close-
   Window-Gadget or pressing the Key "q" or even ESC will do the same.
   If the option @{"ask before Quit" link envAskQuit} is checked a
   requester  appear and ask:

         Quit?
     OK       Cancel
@endnode
@node envCopyEnvArc  "environment/Copy to ENVARC:"

   @{u}Copy to ENVARC:@{uu}  (shortcut: 'U',  menu: right Amiga 'U')

   This function will copy all environments (without subdirectories!!!)
   from the volatile "Env:" to EnvArc:, which is located for example
   on your Harddisk.
@endnode
@node envCopyEnv  "environment/Copy to ENV:"

   @{u}Copy to ENV:@{uu}     (shortcut: 'C',  menu: right Amiga 'C')

   Just the same as @{"Copy to ENVARC:" link envCopyEnvArc} but in the opposite direction.
@endnode
@node envAskDel  "environment/Ask before Delete"

  @{u}ask before Delete@{uu}   (right Amiga '?')

      If this option is checked I ask before deleting an environment.
      By default this option is turned off.

@endnode
@node envAskQuit  "environment/Ask before Quit"

   @{u}ask before Quit@{uu}     (right Amiga 'A')

      If this option is checked I ask before quitting the program.
      By default this option is turned off.

@endnode
@node envUnderMouse  "environment/don`t appear under Mouse"

   @{u}don`t appear under Mouse@{uu}  (right Amiga 'M')

      If this option is checked I open all windows at the same location
      on the screen (about position 10,10) and NOT under your mouse pointer,
      which is the default setting.
@endnode
@node envSavePrefs  "environment/Save as Defaults"

      @{u}Save as Defaults@{uu}             (right Amiga 'E')

         Save the current @{"settings" link OPTIONS } to "ENVARC:".

@endnode
@Node    envList  Listview Gadget

   @{u}List of environment names@{uu}

    This Gadget shows a List of environments in your system. User the Arrow
    or slider Gadgets to scroll up and down. You can also user your Keyboard
    to scroll. Keys are:

    Arrow up        to scroll up
    Arrow down        to scroll down

    numeric Keypad "8"    to scroll up
    numeric Keypad "2"    to scroll down
    numeric Keypad "7"    to scroll top of list
    numeric Keypad "1"    to scroll end of list
    numeric Keypad "9"    to scroll one page up
    numeric Keypad "3"    to scroll one page down

    The selected name of a environment is shown in the @{"sting gadget" link envlistst} underneath.
    On Kickstart 3.0 and newer the selected name is also shown with a inverted
    barrel on the listview gadget. double Click on one name force a pop-up
    the  @{"Getenv requester" link envget}.

@endnode
@Node   envlistst "environment/String"

    @{u}Name string gadget@{uu}

    This gadget shows the name of the selected environment. You can select a env-
    ironment by one click on listview gadget.

    If you click on string gadget you can enter Charaters from your Keyboard.
    When finished press <RETURN> or <ENTER>, if this environment already exists
    the program force the @{"Getenv requester" link envget}, if not the @{"AddNew requester" link envadd}.

@endnode
@Node   envaddname "environment/AddWin Name"

    This is a String-Gadget with the name of a environment.
    To leave this window use:

   @{"Save" link envadds }        @{"Use" link envaddu }        @{"Cancel" link envaddc }
@endnode
@Node   envaddcon "environment/AddWin contents"

    This is a String-Gadget with the contents of a environment.
    To leave this window use:

   @{"Save" link envadds }        @{"Use" link envaddu }        @{"Cancel" link envaddc }
@endnode
@Node envrencon "environment/RenWin contents"
    This is a String-Gadget with the new name for a environment.
    To leave this window use:

   @{"Save" link envrens }        @{"Use" link envrenu }        @{"Cancel" link envrenc }

@endnode
@NODE envhelp "Env Help!"
    No Help for help-file jet.
@endnode
@endnode