home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / prog-asm / easyexpr.lzh / EasyExpress / EasyExpress.doc < prev    next >
Text File  |  1991-12-31  |  11KB  |  270 lines
  1. 3m*****************************************************************************
  2. *                                                                           *
  3. *                                                                           *
  4. *                             EasyExpress V1.0                              *
  5. *                              Compiler Tool                                *
  6. *                                                                           *
  7. *                     (C) Copyright Juha Lindfors 1991                      *
  8. *                           All rights reserved                             *
  9. *                                                                           *
  10. *                                                                           *
  11. *****************************************************************************
  12.  
  13.  
  14.  
  15. 3m
  16.      DISCLAIMER:
  17.  
  18. 1m
  19.     The  author  is  NOT  responsible  for  the  suitability or accuracy  of
  20. this  documentation  or  program.  Any  damage  sustained  by  this  program
  21. is  the  responsibility  of  the  user  himself.
  22.  
  23.  
  24. 3m
  25.      COPYRIGHT:
  26.  
  27. 1m
  28.     Anyone  may   FREELY   distribute  this  program,  providing   that  the
  29. program,   documentation   and    EasyExpress.o   file   remain   in   their
  30. original   state.   You  may   not  charge  any  money  for   this  programs
  31. distribution,  except  for  a  nominal  media  fee.   For   commercial   use
  32. you  MUST  have  permission  from  the  author  in   writing.  This  program
  33. is  'FREEWARE',  so  no  donation  is  necessary,  but  1mVERY1m  welcome.
  34.  
  35.  
  36. 3m
  37.      CONTENTS OF THIS FILE:
  38.  
  39. 1m
  40.              - REQUIREMENTS
  41.              - OVERVIEW
  42.              - HOW TO START EASYEXPRESS
  43.              - EASYEXPRESS STRINGS
  44.              - GADGETS
  45.              - SETTING DEFAULTS
  46.              - NOTES
  47.  
  48.  
  49. 3m
  50.      REQUIREMENTS:
  51.  
  52. 1m
  53.      EasyExpress  was  programmed  in  Charlie  Gibbs'   A68k  V2.42  on  an
  54. Amiga  500   Kickstart  1.3   with  3  Meg  memory  and  20  Meg  Hard  Disk
  55. but   it   should  run  on  standard  Amiga  500.  EasyExpress  is  made  to
  56. use  with  Charlie Gibbs'  A68k  assembler  and  The  Software  Distillery's
  57. BLink.  You  need  both  of  these  programs  and   Run   command  in   your
  58. C  directory  to  get  EasyExpress  work.
  59.  
  60.  
  61. 3m
  62.      OVERVIEW:
  63.  
  64. 1m
  65.      EasyExpress is  a program  which makes  compiling  and  linking  easier
  66. to  the  users  of  Charlie  Gibbs'  A68k  assembler.  
  67.      I  created  this  program, because  I was  sick  and  tired  of  typing
  68. those  long  command  lines for compiling  and  linking  my  programs.  It's
  69. especially  tiring,  when  you  have  to  compile  several  files  and  then
  70. link  them  all  together.  I tried  to  make  the  use  of  EasyExpress  as
  71. simple and  easy  as  possible. You can  select  many  options  by  gadgets,
  72. but  you  still  have to type  the  names of  files  to  compile  and  link.
  73. You  can  make it easier  by  setting  defaults  in   EasyExpress.defs  file
  74. so that  EasyExpress  always  writes  directory  path  automaticly  to point
  75. to the directory  where  you  usually  keep  your  source and object  files.
  76. Maybe  I'll  add  a filerequester  in  my  program  sometime  in  future, so
  77. you  don't  have to write  anything  at  all!  But that's  only  if  you let
  78. me  know that  you  like  this  program  and  it's  useful  to  you.
  79.       (So, send lots  of  mail to  me,  please.  My address  is  at  the end
  80. of  this file.)
  81.  
  82.  
  83. 3m
  84.      HOW TO START EASYEXPRESS:
  85.  
  86. 1m
  87.      EasyExpress  V1.0   runs   under  CLI  only.  You  just  have  to  type
  88. 'EasyExpress',  or  'Run  EasyExpress'  if  you   want  to  use   same   CLI
  89. after  you  have  started  EasyExpress.   
  90.      When  you  start  EasyExpress,  it  opens  a  window   which   contains
  91. some  strings  and  gadgets.   If  you  look  strings,   you  can  see  that
  92. they are  set to compile EasyExpress.o  and  EasyExpress.defs  files. That's
  93. for  setting  your  own  defaults  to  EasyExpress.   How  to  set  defaults
  94. is  explained   below  in   section  'Setting  defaults'.
  95.  
  96.  
  97. 3m
  98.      EASYEXPRESS STRINGS:
  99. 1m
  100.  
  101.       EasyExpress  have  8  strings  where  you  can  type  text.  Depending
  102. on  how  you  have  set defaults, these  strings  can contain  text  already
  103. when  you  start  EasyExpress. How  to  set defaults  is  descripted  below.
  104.       First  two strings  are  paths  to  compiler  and  linker. You  should
  105. definitely  set   deafults  to  these  two  paths,   because  your  compiler
  106. and  linker  will  probably  be  always  in   same   place.   If  you  don't
  107. put   defaults  to  these  strings,   you  have  to  always  type  paths for
  108. linker  and  compiler  when  you  start  EasyExpress.
  109.      Next  string  contains  the  header  file  for  your  program.  If  you
  110. keep   your   sources   in   same   directory,   you   can   write   it   to 
  111. EasyExpress.defs   file  and  you'll  save  your  fingers  from  typing same 
  112. directory  path  all  the  time.
  113.      Next  five  strings  contains  the  object  files.  Actually,  this  is
  114. the  part   where   EasyExpress'  advantage  comes  forward.  It's  easy  to
  115. make  batch  file  which  compiles  and  links  one  file,  but  if  you use
  116. object   files   often,   and   sometimes   they  are   ready  to  link  and
  117. sometimes   you   have  to  compile  them  first,   you'll   find  out  that
  118. program  like  EasyExpress  becomes  very  handy.
  119.  
  120. 1m
  121.   'Compiler Path' String
  122. 1m
  123.  
  124.       This  string   contains  path  where  EasyExpress  searches  compiler.
  125. After   you   have  typed   compiler's   path,  you  can  write  options  to
  126. assembler.   These  can  be,  for  example,  options   which   tells   where
  127. assembler  can  find  include  files  or  where  it  should  create  a  list
  128. file.
  129.  
  130. Ex.
  131.      AmigaLibDisk314:a68k/a68k -iIncludes -q100
  132.  
  133.  
  134.       Read  A68k  documentation  to  get  more  specific  instructions  to
  135. A68k  assembler  and  it's  options.
  136.      
  137.  
  138. :31m
  139.   'Linker Path' String
  140. 1m
  141.  
  142.       Here  is  path  to  linker.  It's  used  same  way  as  Compiler  path
  143. and  it  also  can  have  options  to  linker.
  144.  
  145. Ex.
  146.      BLink SMALLCODE NODEBUG
  147.  
  148.  
  149.      You  should also read  BLink's documentation  to  get  more information
  150. about  BLink's  options. 
  151.      EasyExpress creates executable file to ram disk for same name as source
  152. file.   If  you  don't  want  this  file  to  ram disk or you want it to  be
  153. in  a  different  name,  you  can  write  following  line  to 'Linker Path':
  154.  
  155.  
  156.      BLink to DF0:C/MyFile
  157.  
  158.  
  159.      This  way  your  program  goes to  DF0:C  directory  and  it's  name is
  160. changed  to  MyFile
  161.  
  162.  
  163. 1m
  164.      'Header File Path' String
  165.  
  166. 1m
  167.       In  here  you  can  type  path  to  your  source  code.   Only  option
  168. you  can  write  in  this  string  is  '-o'  which  is  used  by A68k.  When
  169. EasyExpress  compiles   your   source  code,   it  creates  object  file  to
  170. ram disk for same  name  as source file  and  adds  '.o'  at the end. If you
  171. want  this  file  to  be  in  another  directory  with  different  name, you
  172. can  use  '-o'  option.
  173.  
  174. Ex.
  175.      Source/Myfile.asm -oDF0:Objects/MyObject.o
  176.  
  177.  
  178.  
  179.      Next  five  strings  are  paths  for  object  files  which  are  linked
  180. to  header  file.   If  you  have  to  use  more  than  five  objects,   you
  181. can   write  two  object  files  in  one  string.   You  can  do  this  only
  182. if  gadget  at  left  is  set  to  'OBJ'.  Gadgets  are  explained  in  next
  183. section.
  184.  
  185. Ex.
  186.      Object1.o+Object2.o
  187.  
  188.  
  189.       If   OBJ/ASM  gadget  in  left  of  object  string  is  set  to  'ASM'
  190. you  can  use  '-o'  option  same  way  as  in  'Header  File  Path'  string
  191. which  is  descripted  above.
  192.  
  193.  
  194. 3m
  195.      GADGETS:
  196.  
  197. 1m
  198.      There  are  four  different  kind  of  gadgets  in  EasyExpress.  First
  199. is  Window  size  gadget  at  the  left  top  corner  of  window. I did this
  200. gadget  myself,  because the usual  window  size  gadget  left  an ugly blue
  201. box to  window's  right  border. 
  202.      Under  window  sizing  gagdet is  FAST/CHIP  gadget, next  are  ASM/OBJ
  203. gadgets  and  finally at the bottom  of  window is  START  gadget. FAST/CHIP
  204. gadget  tells  to  BLink   either  link  your  program  to  FAST  memory  or
  205. CHIP  memory. I added this gagdet to EasyExpress because I use  CHIP  option
  206. often.  ASM/OBJ toggle  gadget let's  you  select  source  or  object  file.
  207. If  this  gadget is set to  'ASM'  position, EasyExpress  tries  to  compile
  208. file  first  and  then  link  it with  other  object files.  If  the  gadget
  209. is  in  'OBJ'  position, EasyExpress skips  compiling  part and links  file.
  210. So just  put  the gadget  to  'ASM'  position  if you  have source  file and
  211. to  'OBJ'  position if  your  file  is  already  compiled  to  object  file.
  212.  
  213.  
  214. 3m
  215.      SETTING DEFAULTS:
  216.  
  217. 1m
  218.       When  you  start  EasyExpress  you  can  see  that  the  defaults  are
  219. set  to  compile  EasyExpress.o  and   EasyExpress.defs  files.  But  before
  220. you  press  'START'  gadget,  you  should  edit  EasyExpress.defs  file.  In
  221. this  file  are  all  default  paths you  can  set. You  can  put  your  own
  222. deafults to  compiler, linker, header file (main program) and five different
  223. object defaults. If  you  don't  want  to  use  all  defaults just put  zero
  224. in  default  path.  After  you  have  written  your  own  defaults, save the
  225. file  and  start  EasyExpress. Click  once  on  'FAST' gadget  so  that text
  226. changes  to  'CHIP'.  That's  one  of  BLink's  options.  You  have  to  do
  227. that, because all  EasyExpress'  image data  MUST  be in  CHIP memory.  Then
  228. press  once  'ASM'  gadget,  which  is  on  the  left  side  of 'Header File
  229. Path'. Text should  change  to 'OBJ'. After that  press  'OBJ' gadget  which
  230. belongs  to  first  object  file  and  text  changes  to  'ASM'.   When  all
  231. this  has  been  done  just  press  the  'START'  gadget,  and  wait.  After
  232. a  while  you  should  have  new  EasyExpress  with  your  defaults  in  it.
  233.  
  234.  
  235. 3m
  236.      NOTES:
  237.  
  238. 1m
  239.      First  I'd  like  to  thanks  Charlie  Gibbs  for  his  A68k  assembler
  240. and  The Software Distillery  for  their BLink.  Notice that latest versions
  241. of  BLink are commercial,  NOT Public Domain.
  242.      If  you  have any bug reports,  flames, ideas, etc.  or  you  just want
  243. to  write  to  me,  send  all  mail  to  following  address:
  244.  
  245.  
  246.                               Juha Lindfors
  247.                               Jyratie 6 B 24
  248.                               13500  Hameenlinna
  249.                               FINLAND
  250.  
  251.  
  252.  
  253.  
  254.    A68k   (C) Brian R. Anderson, Amiga version by  Charlie Gibbs
  255.    BLink  (C) The Software Distillery
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.