home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d7xx / d743 / frequest.lha / FRequest / FRequest.doc < prev    next >
Text File  |  1992-10-11  |  11KB  |  291 lines
  1.  
  2.  
  3.  
  4.                     Documentation FRequest Version 1.5 ©
  5.  
  6.  
  7.                             written 1992
  8.  
  9.  
  10.                         by H.P.G  FREEWARE
  11.  
  12.  
  13.  
  14. OVERVIEW:
  15.  
  16.         FRequest runs only under OS >= 2.xx.
  17.  
  18.         It is a quiet powerfull tool which  enables  you,  to  select  a
  19.         file by using the ASLFileRequester and then execute almost every
  20.         programm with the selected file or dir name.
  21.         FRequest (FR) uses a lot of OS 2.xx features so it is  not  able
  22.         to run under 1.3 or 1.2.
  23.  
  24.         The requester is full user definable. That means you CAN specify
  25.         a lot of the settings but you don`t HAVE to do this.
  26.  
  27.         There are a lot of PARAMETERS you can specify.  Look  below  for
  28.         further details (Section PARAMETERS).
  29.  
  30.         FR has the ability to start a given command line  as  if  it  is
  31.         typed directly in a shell window. The commandline has  the  same
  32.         syntax as an alias for the AMIGAShell. '[]' are replaced by  the
  33.         selection if there is one.
  34.  
  35.         You can use FR also to start programs on  its  own  without  any
  36.         arguments or parameters.
  37.  
  38. ----------------
  39.  
  40. Legal Stuff:
  41.  
  42.  
  43.         This program and all files come with it also  the  docfiles  are
  44.         released as FREEWARE.
  45.  
  46.         this means:
  47.  
  48.             everybody may use FRequest,
  49.  
  50.             everybody may copy FRequest, if:
  51.  
  52.                 1.  you  copy  all  included  files   see   list   below
  53.                 2. no changes are made , this means the program amd  all
  54.                    included  files  must  stay  in  the  original  form.
  55.  
  56.                    Exception: you may archieve it ; but in this way  you
  57.                    must also archieve the whole package.
  58.                 3. if you recompile it, you have to include a notice  to
  59.                    the  original   author.   if   you   also   want   to
  60.                    (re)distribute this program in the new form you  have
  61.                    to send me a copy.
  62.                 4. you may not sell FRequest
  63.                    Exception: you`re allowed to take a  small  copy  fee
  64.                               which may not extend 5$.
  65.                 5. if you  want  to  include  FRequest  or  one  of  the
  66.                    included files as a part  of  a  commercial  package,
  67.                    you  must  have  written  permission  of  the  author
  68.                    (address see below)
  69.  
  70.  
  71.         I take no warranty or garanty for the function of this  program.
  72.         The whole risk of using it stays by the user.
  73.  
  74.  
  75.  
  76.         This package should include the following files:
  77.  
  78.                 FRequest            [ the Binary  Version 1.5 ]
  79.                 FRequest.doc        [ Docfile ]
  80.                 Examples.doc        [ Docfile for the Example Scripts ]
  81.                 Summary.doc         [ short Doc ]
  82.                 History.doc
  83.                 FRequest.r          [ Info see below (Other from H.P.G)
  84.                     Examples (dir)  [ the whole Examples diretory
  85.                                       containing scripts for the
  86.                                         AmigaDOS and Csh SHELL ]
  87.  
  88. ----------------
  89.  
  90. TECHNICAL:
  91.  
  92.             FR is written in MANX Aztec C  Compiler  Version  5.0d.  Its
  93.             size is relative small  (  unlike  other  programs  of  this
  94.             kind ). This is because of using a  lot  of  System  Library
  95.             calls instead of using C.lib functions.
  96.  
  97.  
  98. FEATURES:
  99.  
  100.             You can specify the Directory displayed in the dir StrGadget
  101.             of the requester. If you do not the current  work  directory
  102.             is inserted.
  103.  
  104.             You can specify the file displayed in the file StrGadget. If
  105.             you do not it stays empty
  106.  
  107.             You can specify patterns displayed in the pattern StrGadget.
  108.             If you do not '#?' is inserted.
  109.  
  110.             You can specify the positive and the  negative  gadget  text
  111.             of the requester. If you do  not  they  content  'OKAY'  and
  112.             'CANCEL'.
  113.  
  114.             You can chose a hail string appearing as the  title  of  the
  115.             requester if you do not it is 'Please Select a File'.
  116.  
  117.             You can specify a commandline that  would  be  sent  to  the
  118.             shell by replacing the '[]'s with the selection. If  you  do
  119.             not inlude a '[]' then the selection simply will be added at
  120.             the end of the specified commandline.
  121.             If you do not specify a commandline the  selection  will  be
  122.             sent to STDOUT e.g. the SHELL  window  but  the  commandline
  123.             will not be executed (this is very useful  for  testing  the
  124.             settings or the  commandline  without  executing  anything).
  125.  
  126.             You can also call FR to start  a  cli  program  without  any
  127.             commandline.
  128.  
  129.             You can switch on the QUIET flag. No information  about  the
  130.             selection will then be putted to STDOUT.
  131.  
  132.  
  133. ----------------
  134.  
  135.  
  136. START and
  137. PARAMETERS:
  138.  
  139.             FR has the following CLI SYNTAX:
  140.             ( look at the AmigaDOS doc for more details about flags)
  141.  
  142. Syntax:       Frequest [HAIL/K][OK/K][CANCEL/K][DIR/K][FILE/K][PAT/K]
  143.                        [QUIET/S][EXE/S|COM/K]
  144.  
  145.  
  146. Description:
  147.  
  148.                 HAIL:   this should be a string. If more than  one  word
  149.                         is given, the string must  be  enclosed  in  "".
  150.                         This is the title of the requester. The  default
  151.                         title is 'Please Select A File'
  152.  
  153.                 OK:     this should  be  a  string  with  at  maximum  8
  154.                         characters length.  This  is  the  text  of  the
  155.                         positive gadget. The  default  text  is  'OKAY'.
  156.  
  157.                 CANCEL: this should  be  a  string  with  at  maximum  8
  158.                         characters length.  This  is  the  text  of  the
  159.                         negative gadget. The default text  is  'CANCEL'.
  160.  
  161.                 DIR:    this is also  a  string.  If  you  specify  this
  162.                         option the requester opens with  displaying  the
  163.                         specified directory. The  default  directory  is
  164.                         the current work directory.
  165.  
  166.                 FILE:   this is also  a  string.  If  you  specify  this
  167.                         option the requester opens with  displaying  the
  168.                         specified  filename  in  the   file   StrGadget.
  169.                         The default Filename is ''
  170.  
  171.                 PAT:    this is also  a  string.  If  you  specify  this
  172.                         option the requester opens  with  the  specified
  173.                         patterns in the patterns StrGadget.
  174.                         The default pattern is '#?'.
  175.  
  176.                 QUIET:  this is a BOOLEAN flag. FR usually displayes the
  177.                         commandline before execution. If you do not want
  178.                         this, you can specify QUIET. (  this  is  useful
  179.                         e.g in batchfiles with an AUTO  shell  window ).
  180.                         The default is FALSE
  181.  
  182.                 EXE:    this is a BOOLEAN flag. If you  do  not  specify
  183.                         COM  (see  below)  and  not  EXE  then  FR  only
  184.                         displays the selection in the Shell  window.  If
  185.                         you specify EXE then FR executes  the  selection
  186.                         without any arguments as a program.
  187.  
  188.                 COM:    this is a  string.  The  length  should  not  be
  189.                         larger than 255 chars. This is  the  commandline
  190.                         that FR tries to execute. You must  enclose  the
  191.                         commandline with '""'s. If  this  Line  includes
  192.                         a '[]', then this will  be  exchanged  with  the
  193.                         selection. If you do not include '[]'  then  the
  194.                         selection simply will be added  at  the  end  of
  195.                         the given commandline.
  196.  
  197.                 OTHERS: In general if you  canceled  the  requester,  no
  198.                         command will be executed and no output  will  be
  199.                         made. If you just  want  to  test  the  settings
  200.                         you`ve  made,  you  can  call  FRequest  without
  201.                         specifying EXE and COM.
  202.  
  203.                         If you specify COM and EXE, FR  just  terminates
  204.                         and displayes a short help text.  This  is  also
  205.                         if there appears any syntax errors.
  206.  
  207.  
  208. INSTALLATION:
  209.  
  210.                 Very simple. Just copy FRequest to your C: directory  or
  211.                 any other directory in your AmigaDOS  searchpath.  done.
  212.  
  213.  
  214. ----------------
  215.  
  216.  
  217. TUTORIAL:
  218.                 1. Here is the simplest example of calling FR
  219.  
  220.                 SHELL 1.> FRequest
  221.  
  222.                 - FR openes the requester with the title
  223.                   'Please  Select  File'  and  displayes  the   contents
  224.                   of  the  current  directory.  The  gadget  texts   are
  225.                   'OKAY'  and  'CANCEL'.  if  you  do  a  selection  the
  226.                   result will  be  prompted  to  the  Cli  window.  e.g.
  227.  
  228.                 Df0:system/setmap
  229.  
  230.                 2. To use FR in an alias to reassign the fonts dir.
  231.  
  232.                 SHELL 1.> alias FAss FRequest HAIL "Please Select the New
  233.                           FONTS: DIR" OK "ASSIGN" CANCEL "STOP" COM
  234.                           "assign fonts:"  <return>
  235.  
  236.                 SHELL 1.> FAss
  237.  
  238.                 - FR opens the requester with the title  'Please  Select
  239.                   the New FONTS: DIR' and displayes the contents of  the
  240.                   current directory.
  241.                   The gadget texts are 'ASSIGN' and 'STOP'. If you do  a
  242.                   selection the result will be added to the  commandline
  243.                   and  be  executed  as   assign    fonts:   <selection>
  244.  
  245.                 3. Specifying all what is to specify. this is  a  script
  246.                    to copy a file or a whole directory  asking  file  by
  247.                    file for confirmation to another one.
  248.  
  249.  
  250.                 .key SRCDIR
  251.                 .ket {
  252.                 .bra }
  253.  
  254.                 ; SRCDIR : this is the dir from which we want to copy
  255.                 ; files
  256.  
  257.  
  258.                 Frequest HAIL "What File should I copy ?" OK "COPY"
  259.                          PAT "#?.(c.h)" DIR {SRCDIR} COM
  260.                          "copy {SRCDIR}/[] to $DSTDIR"
  261.  
  262.                 quit 0
  263.  
  264.  
  265. ------------
  266.  
  267. Address:
  268.  
  269.  
  270.                 Hans-Peter Guenther
  271.                 Gruener Weg 5
  272.                 3501 Fuldatal 2
  273.                 B.R.D (Germany)
  274.  
  275. List of files:
  276.  
  277. (If you miss any of the files below your release is incomplete)
  278.  
  279. FRequest            : The english binary
  280. FRequest.info
  281. FRequest_D          : The german binary
  282. FRequest_D.info
  283. FRequest.doc        : The english manual
  284. FRequest.doc.info
  285. FRequest.dok        : The german manual
  286. FRequest.dok.info
  287.  
  288.  
  289. *******************************************************************************************
  290.  
  291.