home *** CD-ROM | disk | FTP | other *** search
/ OpenStep 4.2 / Openstep-4.2-Intel-User.iso / NextLibrary / Documentation / ManPages / man1 / shader.1 < prev    next >
Encoding:
Text File  |  1994-09-08  |  5.1 KB  |  175 lines
  1. .\"     @(#)shader.1    1.17 (Pixar) 8/14, 1991
  2. .\"
  3. .\"---------------------------------------------------------------------
  4. .\"                 Copyright (c) 1989 Pixar
  5. .\"
  6. .\"   These coded statements,  instructions,  computer programs, and
  7. .\"   listings are protected by Federal copyright law and are not to
  8. .\"   be disclosed to unauthorized  persons without the written con-
  9. .\"   sent of Pixar.
  10. .\"---------------------------------------------------------------------
  11. .\"
  12. .if '\nO'0' .nr O 1
  13. .if '\nO'1' .TH SHADER 1 "August 14, 1991" "Release 3.\nv" "\fIPhotoRealistic RenderMan\fP (\s-1NEXTSTEP\s+1)"
  14. .if '\nO'2' .TH SHADER 1 "August 14, 1991" "Release 3.\nv" "\fIPhotoRealistic RenderMan\fP (\s-1MS-DOS\s+1)"
  15. .if '\nO'3' .TH SHADER 1 "August 14, 1991" "Release 3.\nv" "\fIPhotoRealistic RenderMan\fP (Macintosh)"
  16. .SH NAME
  17. .ta 1.5i
  18. shader - compile shading language source into run-time shaders
  19. .SH SYNOPSIS
  20. .B /usr/prman/shader
  21. [\ \fB\-I\fP\fIincdir\fP\ ]
  22. [\ \fB\-o\fP \fIoutputfile\fP\ ]
  23. [\ \fB\-s\fP \fIsrcfilename\fP\ ]
  24. [\ \fB\-v\fP\ ]
  25. [\ \fB\-q\fP\ ]
  26. [\ \fB\-U\fIname\|\fP\ ]
  27. [\ \fB\-D\fIname\|\fP\ ]
  28. [\ \fB\-D\fIname\fB=\fIdef\|\fP\ ]
  29. \fIfiles ... \fP
  30. .SH DESCRIPTION
  31. .I shader
  32. translates shading language source statements into modules
  33. suitable for execution in the \fBRenderMan\fP run-time environment.
  34. .if '\nO'1' \{If the \fIfiles\fP specification is missing, \fIshader\fP
  35. looks for input on \fIstdin\fP.\}
  36. Unless overridden with the \fB\-q\fP
  37. option, the compiler prints the name of each shader module
  38. as it is compiled.
  39. .LP
  40. .SH OPTIONS
  41. .LP
  42. The following options are supported by \fIshader\fP.
  43. .TP
  44. .ie !'\nO'3' .B \-I\fIincdir\fP
  45. .el .B \-I \fIincdir\fP
  46. This option is actually passed to and interpreted by \fIcpp\fP,
  47. the C pre-processor.
  48. It specifies the directory in which to search for
  49. \fI#include\fP files.
  50. Several such options may be given to \fIshader\fP and directories
  51. are searched in the order specified.
  52. 'ie !'\nO'3' The default directory, \fI/usr/prman/lib/shaders\fP will be
  53. 'el The default directory, \fI{PRMan}Shaders:\fP will be
  54. searched last.
  55. .TP
  56. .BI \-U \ name\|
  57. This option is passed to and interpreted by \fIcpp\fP.
  58. It removes any initial definition of
  59. .IR name ,
  60. where
  61. .I name\|
  62. is a reserved symbol that is predefined by the particular version of
  63. .IR cpp (1).
  64. See
  65. .IR cpp (1)
  66. for the implementation-dependent
  67. list of these possibly reserved symbols.
  68. .TP
  69. .BI \-D \ name\|
  70. This option is passed to and interpreted by \fIcpp\fP.
  71. It defines
  72. .I name\|
  73. as 1 (one). This is the same as if a
  74. .BI \-D name=1
  75. option appeared on the 
  76. .I shader
  77. command line, or as if a
  78. \fB#define\fP   \fIname\fP  \fB1\fP
  79. line appeared in the source file that 
  80. .I shader
  81. is processing.
  82. .TP
  83. .BI \-D \ name=def\|
  84. This option is passed to and interpreted by \fIcpp\fP.
  85. It defines
  86. .I name\|
  87. as if by a
  88. .B #define
  89. directive. This is the same as if a
  90. \fB#define\fP   \fIname\fP  \fIdef\fP
  91. line appeared in the source file that 
  92. .I shader
  93. is processing.
  94. The
  95. .B \-D
  96. option has lower precedence than the
  97. .B \-U
  98. option.
  99. That is, if the same name is used in both a
  100. .B \-U
  101. option and a
  102. .B \-D
  103. option, the name will be undefined regardless of the order of the options.
  104. .TP
  105. .BI \-o " outputfile"
  106. By default, \fIshader\fP places its output in a file named
  107. "\fIshader_name.slo\fP" where \fIshader_name\fP is the name
  108. of the shader as specified in the shader definition statement
  109. in the source file.
  110. Note that this is not necessarily the same as the source
  111. file name.
  112. The \fI-o\fP option allows the user to override this default
  113. naming convention.
  114. It should be used with care since the run-time system looks
  115. for shader executables according to the default naming convention.
  116. The \fIoutputfile\fP specification may be either a file name,
  117. in which case output is written to the specified file, or one
  118. of the following special names:
  119. .RS
  120. .TP 10n
  121. .B \-
  122. Write the output to \fIstdout\fP
  123. .TP 10n
  124. .B \-src
  125. Derive an output filename from the source filename by
  126. removing any directory prefix and a \fI.sl\fP suffix
  127. and appending a \fI.slo\fP suffix.
  128. .TP 10n
  129. .B \-shader
  130. Derive the output filename from the name of the shader
  131. and the \fI.slo\fP suffix.
  132. This is the default.
  133. .RE
  134. .TP
  135. .BI \-s " srcfilename"
  136. This allows specification of the original source file
  137. name in those cases where it may be difficult or impossible
  138. to infer it otherwise
  139. .if '\nO'1' \{(e.g., when the source file is being \fIcat\fPed to \fIstdin\fP).\}
  140. .TP
  141. .B \-v
  142. The \fIverbose\fP option produces more output from
  143. the compiler.
  144. .TP
  145. .B \-q
  146. The \fIquiet\fP option suppresses the normal
  147. printing of the shader module names as they are compiled.
  148. .LP
  149. .if '\nO'1' \{.SH FILES
  150. .ta \w'/usr/prman/lib/shadecom  'u+4n
  151. /lib/cpp    pre-processor
  152. .br
  153. /NextLibrary/Shaders    default include directory
  154. .br
  155. /usr/prman/shader    shell front end
  156. .br
  157. /usr/prman/lib/shadecom    compiler executable
  158. .br
  159. .if '\nO'2' \{.SH FILES
  160. .ta \w'\eRMAN\eBIN\eSHADECOM  'u+4n
  161. .br
  162. \eRMAN\eLIB\eSHADERS    default include directory
  163. .br
  164. \eRMAN\eBIN\eSHADER    shader front end
  165. .br
  166. \eRMAN\eLIB\eSHADECOM    compiler executable\}
  167. .if '\nO'3' \{.SH FILES
  168. .ta \w'/usr/prman/lib/shadecom  'u+4n
  169. {PRMan}Shaders    default include directory
  170. .br
  171. {PRMAN}Tools:shader    shell front end
  172. .br
  173. {PRMAN}Tools:shadecom    compiler executable\}
  174. .xx
  175.