home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Languages / RLaB 1.15c / doc / rlab.1 < prev    next >
Encoding:
Text File  |  1994-09-24  |  4.2 KB  |  180 lines  |  [TEXT/????]
  1. .TH RLAB 1  "1 June 1994" "Version 1.11" "USER COMMANDS"
  2. .\" strings
  3. .ds ex \fIexpr\fR
  4. .SH NAME
  5. rlab \- matrix oriented, interactive programming environment
  6.  
  7. .SH SYNOPSIS
  8. .B rlab
  9. [\-\fBVdhlmnpqr]
  10. [file(s)]
  11. [\-]
  12. .SH DESCRIPTION
  13. .B rlab
  14. is an interpreter for the RLaB Programming Language/Environment. 
  15. The RLaB language is useful for matrix or array oriented numerical
  16. analyses. RLaB is especially useful for prototyping and experimenting 
  17. with algorithms.
  18.  
  19. .B rlab
  20. also provides a convenient
  21. interface to many of the LAPACK,
  22. FFTPACK, and RANLIB subroutines. 
  23.  
  24. .SH OPTIONS
  25.  
  26. .TP
  27. \-\fBV
  28. Prints the version number to stderr and exits.
  29. .TP
  30. \-\fBd
  31. causes a readable form of the internal stack machine's compiled program
  32. to be output to stderr. This option should be used in conjunction with
  33. `-qln' options. This option is not intended for general use.
  34. .TP
  35. \-\fBh
  36. prints the usage message to the screen and exits.
  37. .TP
  38. \-\fBl
  39. prevents loading of the rlab library of rfiles.
  40. .TP
  41. \-\fBm
  42. prevents printing of the greeting message.
  43. .TP
  44. \-\fBn
  45. prevents line number and file name information from being used in the
  46. internal stack machine codes. This option should only be used with the
  47. `-dlnq'. This option is not intended for general use.
  48. .TP
  49. \-\fBp
  50. prevents rlab from using the specified pager for all output.
  51. .TP
  52. \-\fBq
  53. prevents loading of the startup file
  54. .TP
  55. \-\fBr
  56. prevents usage of the GNU readline library for 
  57. command line editing. 
  58. .TP
  59. \fBfile(s)
  60. are loaded and executed by rlab after the `.rlab' file, and after the
  61. library files.
  62. .TP
  63. \-\fB
  64. forces rlab to go interactive after all the files on the command line
  65. have been executed.
  66.  
  67. .SH ENVIRONMENT
  68.  
  69. .B rlab
  70. checks the values of several environment variables upon
  71. startup, and uses them to overide the compiled in defaults. If a
  72. particular environment variable has not been set, the default value is
  73. used.
  74.  
  75. .B RLAB_RC0
  76. Startup rfile.
  77.  
  78. .B RLAB_HELP_DIR
  79. The principle directory of help files.
  80.  
  81. .B RLAB_LIB_DIR
  82. The directory of rfiles to load on startup.
  83.  
  84. .B RLAB_PAGER
  85. The pager to use for paging help 
  86. files to the screen. If 
  87. .B RLAB_PAGER 
  88. is not set, then the environment is checked for 
  89. .B PAGER .
  90. If neither exists, then the pager specified at compile time
  91. is used.
  92.  
  93. .B RLAB_SEARCH_PATH
  94. A colon separated list of directories to search when
  95. attempting to load rfiles. This directory list should contain the 
  96. .B RLAB_LIB_DIR 
  97. and the RLaB toolbox directory. If 
  98. .B RLAB_LIB_DIR
  99. is not in the
  100. .B RLAB_SEARCH_PATH
  101. , then there may be unresolved function variables.
  102.  
  103. .SH EXECUTION
  104. .B rlab 
  105. is normally executed from a shell command line. Upon startup
  106. .B rlab 
  107. .nf
  108. .sp
  109. Processes the command line options.
  110.  
  111. Executes the `.rlab' file.
  112.  
  113. Executes any `.r' files in the library directory.
  114.  
  115. Executes any files specified on the command line.
  116.  
  117. Goes into interactive mode if no files are specified on the 
  118. command line, or if the `-' option is used.
  119. .sp
  120. .fi
  121. .B rlab
  122. can also be invoked by using the `#!' convention employed by exec(2).
  123. A 
  124. .B rlab
  125. script that begins with a line of the form:
  126. .nf
  127. .sp
  128.     #! pathname [arg]
  129. .sp
  130. .fi
  131. where \fIpathname\fR is the full pathname to the
  132. .B rlab
  133. executable, and \fIarg\fR is optional argument(s). Note that if the
  134. `-' option is not specified
  135. .B rlab
  136. will not go interactive after the script has been executed.
  137.  
  138. .SH DOCUMENTATION
  139. .B rlab
  140. has an on-line help system, which can be accessed by typing `help'. A
  141. tutorial and a reference manual are currently being worked on.
  142.  
  143. This man-page was not intended to provide a description of
  144. the language, or rlab's features. Please refer to the manuals, or the
  145. on-line help.
  146.  
  147. .SH BUGS
  148. Paged output gets hosed after an `out of memory' message. 
  149.  
  150. .B rlab
  151. implements fprintf(), printf() and sprintf() using the 
  152. C library functions, fprintf, printf and sprintf, so 
  153. .B rlab
  154. inherits any bugs or limitations of the library functions.
  155.  
  156. Send bug reports to: ians@eskimo.com. 
  157.  
  158. Bug reports should include the rlab version number, a short rfile that
  159. exercises the bug, and a description of the host operating system and
  160. hardware. 
  161.  
  162. .SH AUTHORS
  163. Ian Searle (ians@eskimo.com)
  164.  
  165. Phillip Musumeci and Ian Searle are the authors of the RLaB Primer
  166.  
  167. Brad Hards is the author of the RLaB Reference Manual
  168.  
  169. Mike Brennan has contributed some code from mawk.
  170.  
  171. .SH SEE ALSO
  172. .I sh
  173. (1)
  174. .I more
  175. (1)
  176. .I exec
  177. (2)
  178. .PP
  179.  
  180.