Mercurial > hg > Members > kono > nitros9-code
changeset 920:cfed0d7751f3
Added basic09, cc and runb to the user's guide
author | roug |
---|---|
date | Sun, 19 Jan 2003 12:02:27 +0000 |
parents | 35aaf7ec1c07 |
children | 617c1b90e623 |
files | docs/nitros9guide/basic09.refentry docs/nitros9guide/cc.refentry docs/nitros9guide/chap7.chapter docs/nitros9guide/os9guide.docbook docs/nitros9guide/runb.refentry |
diffstat | 5 files changed, 216 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/basic09.refentry Sun Jan 19 12:02:27 2003 +0000 @@ -0,0 +1,48 @@ +<refentry id="basic09"> +<refnamediv> +<refname>BASIC09</refname> +<refpurpose>Basic language package</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>BASIC09</command> +<arg choice="opt">&replstart;filename&replend;</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +The Auto-run feature allows BASIC09 to get the name of a file to load and +run from the same command line used to call BASIC09. The file loaded and run +can be either a SAVED file (in the data directory), or a PACKED file (in the +execution directory). The file may contain several procedures; the one +executed is the one with the same name as the file. Parameters may be +passed following the pathname specified. +</para> +<para> +Once one or more BASIC09 procedures are debugged to the programmer's +satisfaction, they can be "packed" or converted permanently to +bytecode form. Comments and names of local variables are discarded during +packing, so that in BASIC09, +comments and intelligible variable names are not considered +a burden to be avoided in the name of efficiency. +</para> +</refsect1> +<refsect1><title>Examples</title> +<screen> +OS9: BASIC09 +READY +B:bye + +OS9: BASIC09 printreport("Past Due Accounts") + +OS9: BASIC09 evaluate(COS(7.8814)/12.075,-22.5,129.055) +</screen> +</refsect1> +<refsect1><title>See Also</title> +<para> +BASIC09 Programming Language Reference Manual +</para> +</refsect1> +</refentry>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/cc.refentry Sun Jan 19 12:02:27 2003 +0000 @@ -0,0 +1,129 @@ +<refentry id="cc"> +<refnamediv> +<refname>CC</refname> +<refpurpose>C Compiler</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>CC</command> +<arg>options</arg> +<arg rep="repeat" choice="plain"><replaceable>file</replaceable></arg> +<arg>options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +The are two commands which invoke distinct versions of the +compiler. "cc1" is for OS-9 Level I which uses a two pass compiler, +and, "cc2" is for Level II which causes a single pass version. Both +versions of the compiler works identically, the main difference is +that cc1 has been divided into two passes to fit the smaller memory +size of OS-9 Level I systems. In the following text, "cc" refers to +either "cc1" or "cc2" as appropiate for your system. +</para> +</refsect1> +<refsect1><title>Options</title> +<para> +Recognized options: (UPPER and lower case is equiv.) +</para> +<informaltable frame="none"> +<tgroup cols="2"> +<colspec colwidth="0.9in"/> +<colspec colwidth="3.0in"/> +<tbody> +<row> + <entry>-a</entry> + <entry>Suppress assembly. Leave output in ".a" file.</entry> +</row> +<row> + <entry>-e=n</entry> + <entry>Edition number (n) is supplied to c.prep for + inclusion in module psect and/or to c.link for + inclusion as the edition number of the linked + module.</entry> +</row> +<row> + <entry>-o</entry> + <entry>Inhibits assembly code optimizer pass.</entry> +</row> +<row> + <entry>-p</entry> + <entry>Invoke compiler function profiler.</entry> +</row> +<row> + <entry>-r</entry> + <entry>Suppress link step. Leave output in ".r" file.</entry> +</row> +<row> + <entry>-m=<replaceable>size</replaceable></entry> + <entry>Size in pages (in kbytes if followed by a K) of +additional memory the linker should allocate to +object module.</entry> +</row> +<row> + <entry>-l=<replaceable>path</replaceable></entry> + <entry>Library file for linker to search before the standard library.</entry> +</row> +<row> + <entry>-f=<replaceable>path</replaceable></entry> + <entry>Override other output naming. Module name (in +object module) is the last name in the pathlist. +-f is not allowed with -a or -r.</entry> +</row> +<row> + <entry>-c</entry> + <entry>Output comments in assembly language code.</entry> +</row> +<row> + <entry>-s</entry> + <entry>Suppress generation of stack-checking code.</entry> +</row> +<row> + <entry>-d<replaceable>NAME</replaceable></entry> + <entry>Is equivalent to #define <replaceable>NAME</replaceable> 1 in the +preprocessor. -d<replaceable>NAME</replaceable>=<replaceable>STRING</replaceable> +is equivalent +to #define <replaceable>NAME</replaceable> <replaceable>STRING</replaceable>.</entry> +</row> +<row> + <entry>-n=<replaceable>name</replaceable></entry> + <entry>output module name. <replaceable>name</replaceable> is used to override + the -f default output name.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +<para> +CC1 only: +</para> +<informaltable frame="none"> +<tgroup cols="2"> +<colspec colwidth="0.9in"/> +<colspec colwidth="3.0in"/> +<tbody> +<row> + <entry>-x</entry> + <entry>Create, but do not execute c.com command file.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +<para> +CC2 only: +</para> +<informaltable frame="none"> +<tgroup cols="2"> +<colspec colwidth="0.9in"/> +<colspec colwidth="3.0in"/> +<tbody> +<row> + <entry>-q</entry> + <entry>Quiet mode. Suppress echo of file names.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</refsect1> +</refentry>
--- a/docs/nitros9guide/chap7.chapter Sun Jan 19 06:10:15 2003 +0000 +++ b/docs/nitros9guide/chap7.chapter Sun Jan 19 12:02:27 2003 +0000 @@ -81,8 +81,10 @@ &attrref; &backupref; +&basic09ref; &binexref; &buildref; +&ccref; &chdref; &cmpref; &cobblerref; @@ -119,6 +121,7 @@ &procsref; &pwdref; &renameref; +&runbref; &saveref; &setimeref; &setprref;
--- a/docs/nitros9guide/os9guide.docbook Sun Jan 19 06:10:15 2003 +0000 +++ b/docs/nitros9guide/os9guide.docbook Sun Jan 19 12:02:27 2003 +0000 @@ -23,8 +23,10 @@ <!ENTITY attrref SYSTEM "attr.refentry"> <!ENTITY backupref SYSTEM "backup.refentry"> + <!ENTITY basic09ref SYSTEM "basic09.refentry"> <!ENTITY binexref SYSTEM "binex.refentry"> <!ENTITY buildref SYSTEM "build.refentry"> + <!ENTITY ccref SYSTEM "cc.refentry"> <!ENTITY chdref SYSTEM "chd.refentry"> <!ENTITY cmpref SYSTEM "cmp.refentry"> <!ENTITY cobblerref SYSTEM "cobbler.refentry"> @@ -61,6 +63,7 @@ <!ENTITY procsref SYSTEM "procs.refentry"> <!ENTITY pwdref SYSTEM "pwd.refentry"> <!ENTITY renameref SYSTEM "rename.refentry"> + <!ENTITY runbref SYSTEM "runb.refentry"> <!ENTITY saveref SYSTEM "save.refentry"> <!ENTITY setimeref SYSTEM "setime.refentry"> <!ENTITY setprref SYSTEM "setpr.refentry">
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/runb.refentry Sun Jan 19 12:02:27 2003 +0000 @@ -0,0 +1,33 @@ +<refentry id="runb"> +<refnamediv> +<refname>RUNB</refname> +<refpurpose>BASIC09 run time package</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>Runb</command> +<arg choice="plain">&replstart;i-code module&replend;</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +BASIC09 run time package +</para> +<para> +Once one or more BASIC09 procedures are debugged to the programmer's +satisfaction, they can be "packed" or converted permanently to the +bytecode form. +</para> +<para> +Packed BASIC09 procedures are in fact OS-9 modules, and the OS-9 shell +recognizes them as I-code and passes them off to the virtual machine +emulator RunB for execution. RunB avoids a great deal of the overhead of +the typical interpreted BASICs of the day -- not to mention that one can do +integer calculations where appropriate rather than doing everything in +floating point -- so that BASIC09 programs run very quickly in comparison +with interpreted BASICs. +</para> +</refsect1> +</refentry>