home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / shellc / !ShellC / !ReadMe < prev    next >
Encoding:
Text File  |  1992-07-24  |  6.4 KB  |  163 lines
  1. > !ShellC.!ReadMe  0.20  (11-Mar-1992)
  2.  
  3. Contents:
  4.   
  5.   1.) What is ShellC ?
  6.   2.) What is a CLI shell ?
  7.   3.) How can I compile C programs using ShellC ?
  8.   4.) Controlling C compiler features
  9.   5.) Before starting ...
  10.   6.) Advanced features of ShellC
  11.   7.) The 'claim all' option
  12.   8.) How are file compiled ?
  13.   
  14. 1.) What is ShellC ?
  15.  
  16. This program serves two purposes:
  17.   
  18. -  It is a window-based CLI shell, you may type *commands and examine their
  19.    output in the window (try e.g. MODULES).
  20.    
  21. -  It gives easy desktop access to the Acorn C compiler, and gives you the
  22.    opportunity to examine the output of the compiler in a window.
  23.  
  24.  
  25. 2.) What is a CLI shell ?
  26.  
  27. A CLI shell is a user interface to operating system commands (under RISC OS
  28. called *commands). Unfortunately, the CLI shell of RISC OS is not
  29. multitasking and does not run in a window. ShellC is a pre-version of a
  30. window-based CLI_Shell. It is similar to the TaskWindow of !Edit, but it
  31. executes commands as a whole and displays their output in its window after
  32. the command has been executed. Edit's TaskWindow, however, gains control
  33. while the command is executed, so it is much slower and it needs !Edit to be
  34. loaded.
  35.  
  36.                      
  37. 3.) How can I compile C programs using ShellC ?
  38.  
  39. ShellC provides easy desktop access to the Acorn C compiler Release 3. A C
  40. file may be compiled by dragging it (or the c directory containing it) on
  41. the !ShellC icon on the icon bar. The output of the Ccompiler is then
  42. displayed in the shell window and can be examined using the scroll bars of
  43. the window. The shell checks if a directory or file dragged to its icon is
  44. valid (i.e. if it is either a directory called 'c' containing a source file
  45. or if it is a source file in a directory called 'c'), compiles it and
  46. displays the output of the compiler in its window.
  47.  
  48. To recompile the file, simply press F2, click on the ShellC icon with Adjust
  49. or choose recompile from the shell window's menu.
  50.  
  51.  
  52. 4.) Controlling C compiler features
  53.  
  54. The shell uses a MakeFile to compile C source files. All compiler and linker
  55. flags are controlled by the ConfigC application that is started by choosing
  56. 'Configure' from ShellC's iconbar menu.
  57. It gives you access to almost all compiler and linker flags and you may
  58. specify the filename of the output file either as an explicit name (e.g.
  59. !RunImage) or to be the same as the source filename.
  60. The 'Memory allocation' options give you control over the amount of memory
  61. that is allocated to the next slot before the compiler is started. If you
  62. select 'all memory', all but 32k are allocated to the next slot. 
  63.  
  64. Note that any changes only come into effect if you click on the Save button.
  65.  
  66. 5.) Before starting ...
  67.   
  68. ***************************************************************************
  69. *                                                                         *
  70. * Before you can use the shell to compile C programs, you must set the    *
  71. * variable C$Place in ShellC's !Run file to the directory containing your *
  72. * compiler (Acorn C Release 3) (this is the directory containg e.g. the   *
  73. * directories CLib, Library, ...).                                        *
  74. *                                                                         *
  75. ***************************************************************************
  76.  
  77.  
  78. 6.) Advanced features of ShellC
  79.  
  80.  Using *ShellObey <command> you can send a command string to the shell. It
  81. is executed as if it was typed in.
  82.  If you supply the -a flag (i.e. ShellObey -a <command>), all free memory is
  83. allocated to the 'next slot' before executing the command.
  84.  If you supply the -s flag, the memory specified by the last *ShellSlot
  85. command is allocated to the 'next slot' before executing the command. So,
  86.  e.g. *ShellSlot 64
  87.       *ShellObey -s HelloWorld
  88. runs the HelloWorld program with 64kB memory in the shell window.
  89.  *ShellSlot <size> gives the size in kB to allocate to the 'next slot' if
  90. ShellObey -s is used.
  91.  
  92.  
  93. 7.) The 'claim all' option
  94.  
  95.  If 'claim all' is switched off, only the output of *commands is displayed
  96. in the window and if a non-wimp task is started, it gets a RISC OS standard
  97. task-window.
  98.  If 'claim all' is selected, the output of tasks is claimed, too. This
  99. means, that e.g. the output of the C compiler is displayed in the shell
  100. window and not in a RISC OS command window.
  101.  
  102. 8.) How are files compiled ?
  103.  
  104. The compilation of a file is done as follows:
  105.   The shell module task gets a message if a file is dragged to its icon.
  106. It starts !CompFile, giving the name of the file as parameter. !CompFile
  107. sets the slot for the BASIC program CompFile, which reads the !Options file
  108. created by ConfigC and works out the command string to pass to the amu
  109. (Acorn Make Utility), which is used to compile the source file. CompFile
  110. then issues a *ShellObey command to pass the amu command to the shell. A
  111. Makefile is used to compile the source file and most of the Makefile
  112. consists of macros, which are defined in the command string created by
  113. CompFile.
  114.   It sounds quite complicated, but the filename processing etc. needs not to
  115. be done in ARM code. In addition to that, the shell is a standalone program
  116. and if someone should want to use it with a different compiler, it can be
  117. modified easily.  If a file is dragged to its icon the shell simply starts
  118. the obey file !CompFile quoting the filename of the source file as a
  119. parameter. If configure is chosen from the menu, the file !Configure is
  120. started.
  121.  
  122. 9.) Shortcuts
  123.  
  124. F1: repeat last command (should not be used if last command was the
  125.     compilation of a C source file)
  126. F2: repeat last compilation
  127.  
  128. If you drag a file to the shell window, its full path name appears in the
  129. window as if it was typed in.
  130.  
  131. 10.) Changes
  132.  
  133. Version 0.20:
  134.   
  135. - <CLI$Prompt> is now evaluated to give you the real command-line-feeling
  136.   (if you should have changed it)
  137. - Repeat and Recompile option added
  138. - The pathname of a file can be obtained by dragging it to the shell window
  139.  
  140. 11.) Things to be done
  141.  
  142. - Sorry, there are no editing facilities yet ... I will do that as soon as I
  143.   have the time
  144. - The screen is redrawn after a command has been processed. This is an
  145.   operating-system problem but could be solved
  146.  
  147.  
  148.  
  149. ----------------------------------------------------------------------------
  150.  
  151. This program is freeware, i.e. it may be copied freely, provided that no
  152. part of it is changed and that it is not sold for profit.
  153.  
  154. © 1992,   Martin Wuerthner
  155.           Jahnstrasse 18 
  156.  
  157.           W-7034 Gaertringen
  158.           
  159.           (Germany)
  160.  
  161. ----------------------------------------------------------------------------
  162.  
  163.