Home Explore Help
Sign In
KylePDavis
/
RIGAL
mirror of https://github.com/RiveraGroup/RIGAL.git
1
0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
RIGAL
/
rigsc.446
/
doc
/
rigalman.html

rigalman.html 11 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142 
  1. <HR><H2>RIGAL manual page</H2>
    2. 

  2. 

  3. <UL>
    4. 

  4. <UL>
    5. 

  5. <UL>
    6. 

  6. <A HREF="#HDR0">NAME</A>
    7. 

  7. <BR>
    8. 

  8. 

  9. <A HREF="#HDR1">SYNOPSIS</A>
    10. 

  10. <BR>
    11. 

  11. 

  12. <A HREF="#HDR2">COMPILATION TARGET (Pascal and C)</A>
    13. 

  13. <BR>
    14. 

  14. 

  15. <A HREF="#HDR3">DESCRIPTION OF rc</A>
    16. 

  16. <BR>
    17. 

  17. 

  18. <A HREF="#HDR4">OPTIONS</A>
    19. 

  19. <BR>
    20. 

  20. 

  21. <A HREF="#HDR5">DESCRIPTION OF <I>executable</I> file (compilation result)</A>
    22. 

  22. <BR>
    23. 

  23. 

  24. <A HREF="#HDR6">OPTION</A>
    25. 

  25. <BR>
    26. 

  26. 

  27. <A HREF="#HDR7">DESCRIPTION OF ic</A>
    28. 

  28. <BR>
    29. 

  29. 

  30. <A HREF="#HDR8">OPTIONS</A>
    31. 

  31. <BR>
    32. 

  32. 

  33. <A HREF="#HDR9">DESCRIPTION of v</A>
    34. 

  34. <BR>
    35. 

  35. 

  36. <A HREF="#HDR10">DESCRIPTION of rig_crf</A>
    37. 

  37. <BR>
    38. 

  38. 

  39. <A HREF="#HDR11">DESCRIPTION of rig_lint</A>
    40. 

  40. <BR>
    41. 

  41. 

  42. <A HREF="#HDR12">ERROR MESSAGES</A>
    43. 

  43. <BR>
    44. 

  44. 

  45. <A HREF="#HDR13">ENVIRONMENT</A>
    46. 

  46. <BR>
    47. 

  47. 

  48. <A HREF="#HDR14">INSTALLATION of RIGAL from sources</A>
    49. 

  49. <BR>
    50. 

  50. 

  51. <A HREF="#HDR15">FILES</A>
    52. 

  52. <BR>
    53. 

  53. 

  54. <A HREF="#HDR16">PRINTED DOCUMENTATION</A>
    55. 

  55. <BR>
    56. 

  56. 

  57. <A HREF="#HDR17">AUTHORS</A>
    58. 

  58. </UL>
    59. 

  59. </UL>
    60. 

  60. </UL>
    61. 

  61. 

  62. 

  63. <HR><! - This file was created with the fm2html filter.The filter is copyright Norwegian Telecom Research and was programmed by Jon Stephenson von Tetzchner.   -><H4><A NAME="HDR0">NAME</A></H4>
    64. 

  64. <DT> <B>rc</B>  - checks and compiles RIGAL file </DT><BR>
    65. 

  65. <DT> <B>ic</B>  - interprets intermediate RIGAL code  </DT><BR>
    66. 

  66. <DT><B>v</B>  - viewer for RIGAL data saved in file  </DT><BR>
    67. 

  67. <DT><B>rig_crf</B>   -  RIGAL cross -referencer  </DT><BR>
    68. 

  68. <DT><B>rig_lint</B>  - RIGAL Lint (data type checker) </DT><BR>
    69. 

  69. <H4><A NAME="HDR1">SYNOPSIS</A></H4>
    70. 

  70. <DT> <B>rc</B>  <I>filename</I> <B> [-c] [ -D] [ -P </B> parameter]... </DT><BR>
    71. 

  71. <DT> <B>ic</B> <I>codefilename</I> <B> [ -p</B> <I>printfilename</I>]<B> [ -d][</B> parameter...] </DT><BR>
    72. 

  72. <DT> <B>v</B>  <I>filename</I>  </DT><BR>
    73. 

  73. <DT><B>rig_crf</B>  <I>filename</I>  </DT><BR>
    74. 

  74. <DT><B>rig_lint</B>  <I>filename</I>  <I>executable</I> <B> [ -p </B><I>printfilename</I>] [ parameter...]  <B> </B></DT><BR>
    75. 

  75. <DT><B>(!) </B> the options and parameters must be separated by one or more spaces. </DT><BR>
    76. 

  76. <H4><A NAME="HDR2">COMPILATION TARGET (Pascal and C)</A></H4>
    77. 

  77. <DT>     There are two variants of RIGAL implementation: RIGAL/Pascal in UNIX Pascal and RIGAL/C in UNIX C. The differences between them are mentioned below. </DT><BR>
    78. 

  78. <H4><A NAME="HDR3">DESCRIPTION OF rc</A></H4>
    79. 

  79. <DT>  <B>rc</B>  <I>filename</I> <B> [ -c] [ -D] [ -P </B> parameter]... </DT><BR>
    80. 

  80. <DT>  <B>rc</B>  - checks source file written in RIGAL language. The source code file  must have suffix <B>.rig</B>, but in the command <I>filename</I> is specified without the suffix.   <B>rc</B> reports error messages if any appear; file name, row, column and message text are  reported to standard output.   <B>rc</B> creates intermediate code <I>filename</I><B>.rsc</B> which can be used for interpretation. </DT><BR>
    81. 

  81. <H4><A NAME="HDR4">OPTIONS</A></H4>
    82. 

  82. <DT><B> -c</B> <BR>
    83. 

  83. creates an executable file <I>filename</I> (without suffix). In RIGAL/Pascal variant an intermediate Pascal code is generated and then Pascal compiler (<B>pc</B>) and linker are invoked. In RIGAL/C variant an intermediate C code is generated and then C compiler (<B>cc</B>) and linker are invoked. Some intermediate files, among them script file <B>xd</B>, also appear. </DT><BR>
    84. 

  84. <DT><B> -D</B>    does not remove intermediate files after the compilation. </DT><BR>
    85. 

  85. <DT><B> -P</B><I>parameter</I> <BR>
    86. 

  86. passes option to Pascal or C compiler. You can use <B> -P</B> several times or use  <B> -P </B><I> 'param1 param2' </I> syntax. Typically you may be need to compile with statically linked standard libraries, e.g.  <B>$rig/rc rigcrf -c -P -Bstatic</B> </DT><BR>
    87. 

  87. <H4><A NAME="HDR5">DESCRIPTION OF <I>executable</I> file (compilation result)</A></H4>
    88. 

  88. <DT>     <I>executable</I><B> [ -p</B> <I>printfilename</I>] [parameter...]    </DT><BR>
    89. 

  89. <DT> The parameters are passed to RIGAL program and can be received through #PARM built -in rule which returns list of parameters. The execution is identical to the interpreted program. </DT><BR>
    90. 

  90. <H4><A NAME="HDR6">OPTION</A></H4>
    91. 

  91. <DT>   <B> -p</B> <I>printfilename</I>    - name of file for statement PRINT output. By default output is written to standard output. </DT><BR>
    92. 

  92. <H4><A NAME="HDR7">DESCRIPTION OF ic</A></H4>
    93. 

  93. <DT> <B>ic</B> <I>codefilename</I> [<B> -p</B> <I>printfilename</I>] [<B> -d</B>] [parameter...] </DT><BR>
    94. 

  94. <DT> <B>ic</B>    - interprets the intermediate code, created by  <B>rc</B>.  The intermediate code must have suffix <B>.rsc</B>, but in the command  it is specified without the suffix. Other parameters are passed  to RIGAL program and can be received through #PARM built -in rule which returns list of parameters.The execution is identical to  the compiled program. </DT><BR>
    95. 

  95. <H4><A NAME="HDR8">OPTIONS</A></H4>
    96. 

  96. <DT><B> -p</B><I>printfilename</I> <BR>
    97. 

  97. name of file for statement PRINT output.  By default output is written to standard output. </DT><BR>
    98. 

  98. <DT><B> -d</B><I></I>    tracing mode is turned on. Trace of rules and branches,  rule arguments and success/unsuccess messages is written to file  specified by <B> -p</B> option and is mixed with output from PRINT  statements. If <B> -p</B> option is absent trace is written to standard  output. </DT><BR>
    99. 

  99. <H4><A NAME="HDR9">DESCRIPTION of v</A></H4>
    100. 

  100. <DT> <B>v</B> <I>filename</I>  </DT><BR>
    101. 

  101. <DT><B>v</B>    writes the contents of RIGAL code saved in file to standard output. The structure of code is written with indentation, in  well -readable form. If the depth of some element of the structure  is more than 15 levels, then  characters '..' appear instead of the  element.     The <I>filename</I> must contain data saved by RIGAL statement           SAVE $<I>var  'filename</I>'  </DT><BR>
    102. 

  102. <H4><A NAME="HDR10">DESCRIPTION of rig_crf</A></H4>
    103. 

  103. <DT> <B>rig_crf</B> <I>filename</I> </DT><BR>
    104. 

  104. <DT> <B>rig_crf</B> creates cross reference table for given RIGAL program <I>filename</I>. The program file  must have suffix <B>.rig</B>, but in the command  <I>filename</I> is specified without the suffix. The result is written  to file <I>filename</I><B>.crf</B>. For every rule the following is reported:  rules calling this one, rules called by this one, variables, use  of global variables. </DT><BR>
    105. 

  105. <H4><A NAME="HDR11">DESCRIPTION of rig_lint</A></H4>
    106. 

  106. <DT> <B>rig_lint</B> <I>filename</I>   </DT><BR>
    107. 

  107. <DT><B>rig_lint</B>   creates warning table for given RIGAL program <I>filename</I>. The program file  must have suffix <B>.rig</B>, but in the command  <I>filename</I> is specified without the suffix. The result is written  to file <I>filename</I><B>.lnt</B>.    <B>rig_lint</B> checks type compatibility and cases when values of  different types can be assigned to the same variable. </DT><BR>
    108. 

  108. <H4><A NAME="HDR12">ERROR MESSAGES</A></H4>
    109. 

  109. <DT><B>  Error in file</B> <I>filename</I> <B>   Line=</B><I>nn</I><B>  Message=</B><I>text</I><B>   Column=</B><I>mm</I>    - checker found syntax error in your RIGAL file. Intermediate code is not created, compilation failed. <B> </B></DT><BR>
    110. 

  110. <DT><B> *** ERROR</B> <I> nn xxx</I>   - runtime warnings about dangerous manipulations with RIGAL data structures or runtime input/output errors. <B>  </B></DT><BR>
    111. 

  111. <DT>rig:undefined variable   </DT><BR>
    112. 

  112. <DT><B>pc:command not found</B>    - see ENVIRONMENT  section of this manual <B>  </B></DT><BR>
    113. 

  113. <DT>ERROR:COMPILATION </DT><BR>
    114. 

  114. <DT><B>ERROR IN RIGAL, rule #</B><I>name</I>      - internal compilation message, normally does not appear;  try to simplify this rule. <B>    </B></DT><BR>
    115. 

  115. <DT><B>ld() errors  or warnings </B>      - try command <B>       ranlib $rig/lib/riglib.a</B>       to remove errors. </DT><BR>
    116. 

  116. <H4><A NAME="HDR13">ENVIRONMENT</A></H4>
    117. 

  117. <DT>   For running RIGAL/Pascal you must have Sun Pascal release 2.1 (or higher). Command <B>pc</B> (Pascal compiler) must be available.      </DT><BR>
    118. 

  118. <DT>For running RIGAL/C  you must have a C compiler (command <B>cc</B>) available.    You must have environment variable <B>rig</B> set to the name of directory where RIGAL system binary files are located.    You can set it by command         <B>setenv rig </B><I>full_path</I><B>/bin</B>    in your <B>.login</B> file    It is recommended to include this directory at the start of path list by command      <B> set path=( $rig ... )</B>    in your <B>.login</B> file. Then you can use RIGAL commands  <B>rc</B>, <B>ic</B> etc. from any directory. </DT><BR>
    119. 

  119. <H4><A NAME="HDR14">INSTALLATION of RIGAL from sources</A></H4>
    120. 

  120. <DT>   All files are packed and compressed in file   <B>rigs</B><I>variant.system_version.</I><B>tar.Z</B> (e.g. rigsp.444.tar.Z). Here <B>rigsp</B> denotes Pascal sources, <B>rigsc</B> - C sources.  <B>uncompress</B>  file   (without suffix <B>.Z</B>)  <B>tar  -xvf</B>   file  execute instructions in ENVIRONMENT section. </DT><BR>
    121. 

  121. <DT> Go to RIGAL source directory (<B>/src</B>)  and execute <B> make</B> ; it takes 3-5 minutes to  compile all sources  by Sun  Pascal (or C) compiler and perform self-test. The result is in  <B>/bin</B> </DT><BR>
    122. 

  122. <H4><A NAME="HDR15">FILES</A></H4>
    123. 

  123. <DT> <B> bin/rc, bin/ic, bin/rig_crf, bin/rig_lint, bin/v</B>   basic RIGAL system executable files  </DT><BR>
    124. 

  124. <DT><B> lib/riglib.a</B>         RIGAL compiler runtime library. If you move it from one directory to another, execute command <B>ranlib</B><I> new_directory</I><B>/riglib.a</B>  </DT><BR>
    125. 

  125. <DT> <B>include/</B><I>file</I>.<B>inc</B>,  <B>include/</B><I>file</I>.<B>h</B> m  include files for compilation  </DT><BR>
    126. 

  126. <DT><B> bin/anrig, bin/genrig</B>     parts of RIGAL compiler  <B> </B></DT><BR>
    127. 

  127. <DT><B>doc/rigal.1     </B>         this manual  <B> </B></DT><BR>
    128. 

  128. <DT><B>doc/langdesc.txt </B>        RIGAL language description  </DT><BR>
    129. 

  129. <DT><B> doc/impl.txt     </B>        User's guide  <I>file</I><B>.rig</B>  source programs in RIGAL  </DT><BR>
    130. 

  130. <DT><I>file</I><B>.rsc</B> intermediate code for interpreter  </DT><BR>
    131. 

  131. <DT><B>xcrg*.pas,</B> <I>file</I>.<B>RC2</B>, <I>file</I>.<B>RC4</B>, <I>file</I>.<B>TMP</B> intermediate files, appear and by default are removed during compilation. </DT><BR>
    132. 

  132. <H4><A NAME="HDR16">PRINTED DOCUMENTATION</A></H4>
    133. 

  133. <DT>    The documentation is in <B>doc</B> subdirectory.     </DT><BR>
    134. 

  134. <DT>Use     <B>troff -man -t rigal.1 | lpr -h -t</B>        to print manual page    </DT><BR>
    135. 

  135. <DT> <B>nroff -man -t rigal.1 &gt; rigal.man</B>        to prepare readable manual page file    </DT><BR>
    136. 

  136. <DT> <B>troff -ms -t langdesc.txt | lpr -h -t</B>    to print language description    </DT><BR>
    137. 

  137. <DT> <B>troff -ms -t impl.txt | lpr -h -t</B>        to print the programmer's guide </DT><BR>
    138. 

  138. <H4><A NAME="HDR17">AUTHORS</A></H4>
    139. 

  139. <DT> Mikhail Auguston and Vadim Engelson, Inst. of Math. and Comp.Sci, University of Latvia, Rainis blvd. 29, Riga, LV-1459, Latvia (Lettland). Currently (1994-1995) Vadim Engelson is at IDA, S-58183, Linkoping University, Linkoping, Sweden. e -mail:  vadim@mii.lu.lv , vaden@ida.liu.se. </DT><BR>
    140. 

  140. <DT>Some info and  pointers to papers are  available from <A HREF="http://www.ida.liu.se/labs/pelab/members/vaden/rigal.html"> Rigal home page </A> </DT><BR>
    141. 

  141. <DT>Rigal and papers about it available by ftp from <A HREF="ftp://ftp.ida.liu.se/pub/labs/pelab/rigal"> RIGAL FTP directory  </A>   </DT><BR>
    142. 

  142. <A NAME="ENDFILE"><PRE> </PRE></A>
    143.