home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / misc / reqchang.run / ReqChange / Extra / GetFile.Man < prev    next >
Encoding:
Text File  |  1992-08-23  |  3.7 KB  |  122 lines
  1.  
  2.  
  3.     GetFile V1.2                User manual                 GetFile V1.2
  4.  
  5.  
  6.     NAME 
  7.         GetFile 
  8.  
  9.     SYNOPSIS 
  10.          GetFile [[DIR] Dir] [[FILE] File] [[TITLE] Titlestring] [[VAR]
  11.                 Variablename] [[PATTERN] Pattern] [GLOBAL] [NOFILES]
  12.                 [SAVE] [MULTISELECT] 
  13.  
  14.     DESCRIPTION 
  15.         NOTE: This program only works with OS 2.04! 
  16.  
  17.         GetFile  is  a  little  command  intended  to be used in scripts
  18.         (Shell  or ARexx), where an input from the user in the form of a
  19.         filename  or  a directory name is needed.  The requester used is
  20.         the  OS2.0  standard requester in ASL.  If no file was selected,
  21.         the  WARN  flag  will be set. It is fully re-entrant, and can be
  22.         made  resident.  Beware for environment variable name colissions
  23.         if you use the GLOBAL flag.  
  24.  
  25.     OPTIONS 
  26.         There  are  no  required arguments. The keywords (see below) are
  27.         only  required  if  you do not enter the strings in the ordering
  28.         as  above.  Strings  only  need  to  be  quoted  if they contain
  29.         spaces.  
  30.  
  31.     DIR 
  32.         This  lets  you  specify  the  default  directory.  If  none  is
  33.         specified,   the   current   directory   will   be  the  default
  34.         directory.  
  35.  
  36.     FILE 
  37.         This lets you specify the default filename, if any.  
  38.  
  39.     TITLE 
  40.         This  optional  string  specifies  the  title  in  the requester
  41.         window. It defaults to "Select a file" if none is specified.  
  42.  
  43.     VAR 
  44.         This  string lets you specify in which local variable the result
  45.         will  be stored (with full path specification). The default name
  46.         is GetFileResult.  
  47.  
  48.     PATTERN 
  49.         This  string  specifies  the  pattern to use. Only the filenames
  50.         that  matches  the  pattern will be shown. It also implies for a
  51.         pattern   gadget.  Default  pattern  is  "#?"  (i.e.  match  all
  52.         files).  
  53.  
  54.     GLOBAL 
  55.         By   default,   GetFile   will  place  the  answer  in  a  local
  56.         environment  variable.   But  this  has  one drawback: You can't
  57.         access  the result easily from ARexx. If you have set this flag,
  58.  
  59.  
  60.                                    Page 1
  61.  
  62.  
  63.     GetFile V1.2                User manual                 GetFile V1.2
  64.  
  65.  
  66.         it will be quite easy. Simply peek in the ENV: directory. :) 
  67.  
  68.     NOFILES 
  69.         If  this  keyword  is present, then the user will not be able to
  70.         select  any  files, only directories will be shown. Very nice if
  71.         the   user  should  select  a  destination  directory  for  e.g.
  72.         harddisk installation.  
  73.  
  74.     SAVE 
  75.         If  this  keyword is present, the requester will operate in save
  76.         mode,  which is a bit different. First of all, double-clicking a
  77.         file  will  have  no  effect  (except  from  selecting that file
  78.         ofcourse),  and  if  the  user  enters a directory which doesn't
  79.         exist,  there  will  be  a  requester asking if the directory in
  80.         question  should  be  created. The look of the requester will be
  81.         somewhat different.  
  82.  
  83.     MULTISELECT 
  84.         If  this  keyword  is  present,  the user will be able to select
  85.         multiple  files  (if  the  SAVE switch is used at the same time,
  86.         this   keyword  does  nothing).  The  returned  string  will  be
  87.         space-separated  filenames  with  full  path specification. If a
  88.         filename  contains  spaces,  it  will be quoted. This keyword is
  89.         mostly  intended  to  be  used  from  ARexx-scripts (since it is
  90.         quite easy to process the result in ARexx).  
  91.  
  92. EXAMPLE 
  93.     GetFile TITLE "Select destination directory" NOFILES 
  94.     Echo "Files will be placed in $GetFileResult"
  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.                                    Page 2
  121.  
  122.