home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 357.lha / intuisup_v1.15 / applications / SmallBench.doc < prev    next >
Encoding:
Text File  |  1990-03-10  |  10.1 KB  |  265 lines
  1.  
  2.  
  3.           SmallBench                                            Version 1.0
  4.  
  5.  
  6.  
  7.  
  8.  
  9.           NNAAMMEE
  10.  
  11.                SmallBench - intelligent file browser and loader
  12.  
  13.  
  14.           SSYYNNOOPPSSIISS
  15.  
  16.                smallbench [?] [ [-hpq] [-rotisa <file>|DISABLED] ... ]
  17.  
  18.  
  19.           DDEESSCCRRIIPPTTIIOONN
  20.  
  21.                SmallBench is both an example for the IntuiSup library and a
  22.                stand-alone executable  tool. You must  have iSup.library in
  23.                your libs  directory in  order to  run it. The  program runs
  24.                from the Shell  or WorkBench, and doesn't need the WorkBench
  25.                loaded to run.
  26.  
  27.                SmallBench is  basically a tiny file  browser with automatic
  28.                file  type recognition.  It lets you  walk around  your file
  29.                systems to select files and run, view, edit or play them ac-
  30.                cording to their type. It will run executable programs, load
  31.                text  files into  your favorite  editor, load  pictures into
  32.                your palette  program or just  view them for  instance. Note
  33.                that it will work with ALL files, not only with those having
  34.                an  icon, for  the  file type  recognition is  based on  the
  35.                file's own header analysis and not on the ".info" data.
  36.  
  37.                The program  currently recognizes the  following file types:
  38.                executables,  text files, object  files, IFF  ILBM pictures,
  39.                IFF  8SVX digitized  sound  and IFF  ANIM compressed  bitmap
  40.                animations. Executable files are just launched as background
  41.                processes.  For all  the other types,  a viewer  is launched
  42.                with the selected file  as argument. Each file type has it's
  43.                own  viewer, which  is  set by  default but  can be  changed
  44.                trough a command line option.
  45.  
  46.                The recognition  process used is  not 100% safe,  and errors
  47.                are possible on file types different from those known by the
  48.                program. This  means that  if a  file is not  of any  of the
  49.                types specified  above, the analysis algorithm  might see it
  50.                as a  text file  instead of  sensing an unknown  object. The
  51.                chances for  this are very reduced though,  and in the worst
  52.                case the  file is treated as text which  safe if your editor
  53.                can load binary files. On the other hand, no recognition er-
  54.                ror can  happen on known file types: an  IFF ILBM files will
  55.                *always*  be  sensed as  a  picture. The  -p  option can  be
  56.                toggled on or of to avoid any problems.
  57.  
  58.  
  59.           BBEEFFOORREE RRUUNNNNIINNGG SSMMAALLLLBBEENNCCHH
  60.  
  61.  
  62.  
  63.  
  64.           Utilities                     Page 1                        Amiga
  65.  
  66.  
  67.  
  68.  
  69.           SmallBench                                            Version 1.0
  70.  
  71.  
  72.  
  73.                Before attempting to run SmallBench, make sure that:
  74.  
  75.                     1. you have a copy of iSup.library in your libs: direc-
  76.                     tory.
  77.  
  78.                     2. you use correct arguments - see right below.
  79.  
  80.  
  81.           OOPPEERRAATTIIOONN
  82.  
  83.                To run  the program, enter  "smallbench" at a  CLI prompt or
  84.                doucble-click it's icon.  Browse trough your files until you
  85.                select one  you like, and double-click on  its name, or just
  86.                select it and click the  'Ok' gadget: the file will load. To
  87.                end the program, select the 'CANCEL' gadget. Note that files
  88.                are loaded in  the background, thus several different can be
  89.                loaded at the same time.
  90.  
  91.                SmallBench uses the following arbitrary files by default:
  92.  
  93.                     etc:Less       as the text files viewer
  94.                     etc:Show       as the picture files viewer
  95.                     etc:Play       as the sound files player
  96.                     etc:Movie      as the animation files viewer
  97.  
  98.                Several command line options let you alter the default files
  99.                used and set your  preferences. They are the following - the
  100.                WorkBench arguments are enclosed in brackets:
  101.  
  102.                     -h [not from WorkBench]
  103.  
  104.                          Displays a  quick help list  reminding the options
  105.                          and default settings.
  106.  
  107.                     -p [PROMPT=OFF]
  108.                          Disables  the   file  type   verification  prompt.
  109.                          Default is on,  if you use -p, the requesters will
  110.                          not appear.
  111.  
  112.                     -q [QUOTES=OFF]
  113.                          Disables  double   quotes  around  filenames.   By
  114.                          default, SmallBench will  add double quotes around
  115.                          the file  name you select  when feeding it  to the
  116.                          according  viewer.   This  prevents problems  with
  117.                          filenames containing spaces.  For instance, if the
  118.                          file you  select is 'my file' and if  it is a text
  119.                          file, the program will generate the command 'c:run
  120.                          etc:Less  "my file"'  and ask  the Dos  to execute
  121.                          that. Now,  some old  programs linked with  an old
  122.                          and bugged  version of astartup.obj  will not cor-
  123.                          rectly  handle quotes  around  arguments. If  your
  124.                          viewer is on  of these programs, you may choose to
  125.                          use the  -q option to override  this drawback, but
  126.                          you  will not  be  able to  view files  containing
  127.  
  128.  
  129.  
  130.           Utilities                     Page 2                        Amiga
  131.  
  132.  
  133.  
  134.  
  135.           SmallBench                                            Version 1.0
  136.  
  137.  
  138.  
  139.                          spaces in their names.
  140.  
  141.                     -t <file|DISABLED> [TEXT=<file|DISABLED>]
  142.                          Specifies the text file viewer or editor. The next
  143.                          argument  must  be a  complete  reference to  your
  144.                          favorite  text  viewer/editor.   If  you  want  no
  145.                          action on  text files, use  the keyword 'DISABLED'
  146.                          instead of a file reference.
  147.  
  148.                     -o <file|DISABLED> [OBJECT=<file|DISABLED>]
  149.                          Specifies the object  file processor. Object files
  150.                          are those produced  by compilers or assembler, and
  151.                          are usually used  with a linker. The next argument
  152.                          must be  a complete  reference to the  object file
  153.                          processor, or DISABLED if none is wanted. DISABLED
  154.                          is the default here.
  155.  
  156.                     -i <file|DISABLED> [PICTURE=<file|DISABLED>]
  157.                          Specifies  the IFF ILBM  (picture) file  viewer or
  158.                          editor.  The  next  argument  must be  a  complete
  159.                          reference to  the viewer,  or DISABLED if  none is
  160.                          wanted.  You can  use the display programs Display
  161.                          or  ShowIff here  for  instance, or  you can  call
  162.                          DeluxePaint or another palette.
  163.  
  164.                     -s <file|DISABLED> [SOUND=<file|DISABLED>]
  165.                          Specifies the  IFF 8SVX (digitized  sound) loader.
  166.                          The next argument  must be a complete reference to
  167.                          the loader, or DISABLED if none is wanted.
  168.  
  169.                     -a <file|DISABLED> (ANIM=<file|DISABLED>]
  170.                          Specifies  the  IFF  ANIM  (compressed  animation)
  171.                          player.  The  next  argument  must be  a  complete
  172.                          reference to  the player,  or DISABLED if  none is
  173.                          wanted. The public  domain program PlayAnim can be
  174.                          used here for instance.
  175.  
  176.                If  a file  type is  DISABLED, nothing  happens when  a cor-
  177.                responding name  is selected.  If the loader  fails, nothing
  178.                happens neither.
  179.  
  180.  
  181.           EEXXAAMMPPLLEESS
  182.  
  183.                smallbench -p
  184.  
  185.                     runs SmallBench  with all the  launchers/viewers set to
  186.                     the default values, but without the file type check re-
  187.                     questers.
  188.  
  189.                smallbench -q
  190.  
  191.                     forces  the suppression  of double  quotes  around file
  192.                     names for use with old viewers not supporting quotes in
  193.  
  194.  
  195.  
  196.           Utilities                     Page 3                        Amiga
  197.  
  198.  
  199.  
  200.  
  201.           SmallBench                                            Version 1.0
  202.  
  203.  
  204.  
  205.                     command line arguments.
  206.  
  207.                smallbench -i df0:Display -s df1:PlaySound -a df2:PlayAnim
  208.  
  209.                     uses "df0:Display"  to view  ILBM files instead  of the
  210.                     default  "etc:show"; plays  the 8SVX  sound  files with
  211.                     "df1:PlaySound"  and  view  the  animation  files  with
  212.                     "df2:PlayAnim".
  213.  
  214.  
  215.           CCOOMMPPIILLIINNGG
  216.  
  217.                This version  should compile and link  with the Lattice com-
  218.                piler,  version 5.0  and over. A  makefile is  provided, but
  219.                linking requires  the use of  the IntuiSup library  which is
  220.                not provided.
  221.  
  222.  
  223.           BBUUGGSS
  224.  
  225.                I will  appreciate any comments, or bug  reports if some are
  226.                found.
  227.  
  228.  
  229.           AAUUTTHHOORR
  230.  
  231.                Version 1.0 by Gauthier Groult, June 02, 1989.
  232.  
  233.                     Gauthier Groult
  234.                     33, Blvd Saint Denis
  235.                     92400 Courbevoie
  236.                     France, Europe
  237.                     Tel: (1) 47 89 09 54
  238.                     EMail: groult@germinal.ibp.fr
  239.  
  240.                SmallBench  executable program  and source  code  are public
  241.                domain.   Donations and  contributions are  welcome  but not
  242.                solicited.
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.           Utilities                     Page 4                        Amiga
  263.  
  264.  
  265.