midrange.com code scratchpad
Name:
Help
Scriptlanguage:
Plain Text
Tabwidth:
4
Date:
09/10/2014 07:34:02 pm
IP:
Logged
Description:
Help panel group to provide help data for new command parameters
Code:
  1. :pnlgrp.
  2. .************************************************************************
  3. .*  Help for command BUILD
  4. .************************************************************************
  5. :help name='BUILD'.
  6. Build an object from source - Help
  7. :p.The Build an object from source (BUILD) command scans your source
  8. code for the commands needed to create a program or service program.
  9. .*
  10. :p.The BUILD command scans for the :hp2.*>:ehp2. character sequence.
  11. When this is found, it's considered to be the start of a command
  12. that you want to run to create your program. Everything after the
  13. after the :hp2.*>:ehp2. characters is considered part of the command
  14. command, up until the end of the line is reached, or a :hp2.<*:ehp2.
  15. character sequence is reached. The :hp2.<*:ehp2. sequence designates
  16. the end of a command string.
  17. .*
  18. :p.After executing your command, the BUILD tool will then search
  19. for the next line that contains a :hp2.*>:ehp2. sequence, and will
  20. run that line as a separate command.
  21. .*
  22. :p.You can add the - character as the last character of a command.
  23. When BUILD finds a command that ends with the - character (meaning
  24. that - is the last non-blank character before <* or the end of a
  25. record) it will proceed to read the next command string, and add it
  26. to the end of the current one.  This can be done multiple times
  27. to build a command that's up to 32702 characters long.
  28. .*
  29. :p.The BUILD command can also insert variables into your command
  30. text. If the following values are found, they are replaced with
  31. the corresponding value calculated by the BUILD program:
  32. :dl.
  33. :dt.&O
  34. :dd.Object Library
  35. :dt.&ON
  36. :dd.Object name
  37. :dt.&F
  38. :dd.Source file name
  39. :dt.&L
  40. :dd.Source file library
  41. :dt.&N
  42. :dd.Member name
  43. :dt.&DV
  44. :dd.Debug view value specified when BUILD was run.
  45. :dt.&OV
  46. :dd.OPM debug view (*LSTDBG or *SRCDBG)
  47. :dt.&EV
  48. :dd.The *EVENTF or *NOEVENTF specified when BUILD was run.
  49. :dt.&R
  50. :dd.REPLACE option specified when BUILD was run.
  51. :dt.&X
  52. :dd.Source member text (with single quotes added)
  53. :dt.&YY
  54. :dd.Current year, 2-digit
  55. :dt.&YYYY
  56. :dd.Current year, 4-digit
  57. :edl.
  58. .*
  59. :p.Normally, if a command designated in your source code fails,
  60. the BUILD utility will stop processing and return an error.
  61. However, if a command is prefixed with :hp2.ign::ehp2. then
  62. failure will be ignored, and BUILD will proceed to the next command.
  63. .*
  64. :p.:hp2.Restrictions::ehp2.
  65. :ul.
  66. :li.
  67. The BUILD command runs the commands that were desginated in the
  68. source code. You must have proper authority to run any of the
  69. commands that you list.
  70. :li.
  71. This command has not been tested in a multi-threaded environment,
  72. but should work properly, provided that it is not invoked twice
  73. concurrently.
  74. :eul.
  75. :ehelp.
  76. .*******************************************
  77. .*   Help for parameter OBJ
  78. .*******************************************
  79. :help name='BUILD/OBJ'.
  80. Object Name (OBJ) - Help
  81. :xh3.Object Name (OBJ)
  82. :p.Specifies the name of the object to build. The value you
  83. specify will be used to supply the value for the &O (object library)
  84. and &ON (object name) variables in the commands you execute.
  85. .*
  86. :p.This is a required parameter.
  87. :p.:hp2.Qualifier 1: Object Name:ehp2.
  88. :parml.
  89. :pt.:pv.name:epv.
  90. :pd.
  91. Specify the name of name of the object that you (ostensibly) will
  92. be building.
  93. :eparml.
  94. :p.:hp2.Qualifier 2: Object Library:ehp2.
  95. :parml.
  96. :pt.:pk def.*CURLIB:epk.
  97. :pd.
  98. Specify the current library (or QGPL if you have no current library)
  99. as the location to build objects in.
  100. .*
  101. :pt.:pv.name:epv.
  102. :pd.
  103. Specify the name of name of the library in which to build objects.
  104. .*
  105. :eparml.
  106. :ehelp.
  107. .*******************************************
  108. .*   Help for parameter SRCFILE
  109. .*******************************************
  110. :help name='BUILD/SRCFILE'.
  111. Source File (SRCFILE) - Help
  112. :xh3.Source File (SRCFILE)
  113. :p.Specifies the source file containing the commands to execute.
  114. .* Describe the function provided by the parameter.
  115. :p.:hp2.Qualifier 1: Source File:ehp2.
  116. :parml.:pt.:pk def.QRPGLESRC:epk.
  117. :pd.
  118. Look for commands in the QRPGLESRC file (the default source file
  119. for ILE RPG source code.)
  120. .* Describe the function provided by the default parameter value.
  121. :pt.:pv.name:epv.
  122. :pd.
  123. Specify the name of a source physical file that contains your
  124. source code with the *> and <* strings.
  125. .*
  126. :eparml.
  127. :p.:hp2.Qualifier 2: Library:ehp2.
  128. :parml.
  129. :pt.:pk def.*LIBL:epk.
  130. :pd.
  131. Search the library list for the source file that contains the proper
  132. member.
  133. .*
  134. :pt.:pk.*CURLIB:epk.
  135. :pd.
  136. Expect the source file containing the member to be in your current
  137. library.
  138. .*
  139. :pt.:pv.name:epv.
  140. :pd.
  141. Specify the name of the library that contains your source file.
  142. .*
  143. :eparml.
  144. :ehelp.
  145. .*******************************************
  146. .*   Help for parameter SRCMBR
  147. .*******************************************
  148. :help name='BUILD/SRCMBR'.
  149. Source member (SRCMBR) - Help
  150. :xh3.Source member (SRCMBR)
  151. :p.Specifies the source member containing the *> and <* strings.
  152. .*
  153. :parml.
  154. :pt.:pk def.*OBJ:epk.
  155. :pd.
  156. Use the same name as the OBJ() parameter, above.
  157. .*
  158. :pt.:pv.name:epv.
  159. :pd.
  160. Specify the name of the source member to use.
  161. .*
  162. :eparml.
  163. :ehelp.
  164. .*******************************************
  165. .*   Help for parameter DBGVIEW
  166. .*******************************************
  167. :help name='BUILD/DBGVIEW'.
  168. Debug View (DBGVIEW) - Help
  169. :xh3.Debug View (DBGVIEW)
  170. :p.Specifies the debugging view that will be used to calculate the
  171. &DV and &OV variables in your build script.
  172. .*
  173. :parml.
  174. :pt.:pk def.*LIST:epk.
  175. :pd.
  176. The &DV variable will be set to *LIST for ILE modules and programs,
  177. or *SOURCE for embedded SQL precompiler.  The &OV variable will be
  178. set to *LSTDBG for OPM programs.
  179. .*
  180. :pt.:pk.*SOURCE:epk.
  181. :pd.
  182. The &DV variable will be set to *SOURCE for ILE modules and progams,
  183. as well as the embedded SQL precompiler.  The &OV variable will be
  184. set to *SRCDBG for OPM programs.
  185. .*
  186. :pt.:pk.*STMT:epk.
  187. :pd.
  188. The &DV variable will be set to *STMT for ILE programs.  The &OV
  189. variable will be set to *NOSRCDBG.
  190. .*
  191. :pt.:pk.*NONE:epk.
  192. :pd.
  193. The &DV variable will be set to *NONE, and &OV will be set to *NOSRCDBG
  194. .*
  195. :eparml.
  196. :ehelp.
  197. .*******************************************
  198. .*   Help for parameter REPLACE
  199. .*******************************************
  200. :help name='BUILD/REPLACE'.
  201. Replace object (REPLACE) - Help
  202. :xh3.Replace object (REPLACE)
  203. :p.Specifies whether an existing object should be sent to QRPLOBJ
  204. and replaced (or not.)  The value given is available to the commands
  205. you run using the &R variable.
  206. .*
  207. :parml.
  208. :pt.:pk def.*YES:epk.
  209. :pd.
  210. An existing program (or whatever) should be replaced.
  211. .*
  212. :pt.:pk.*NO:epk.
  213. :pd.
  214. Existing programs should not be replaced.  The BUILD command
  215. does not have any way to enforce this, however -- it assumes
  216. you will make use of &R in your build script.
  217. .*
  218. :eparml.
  219. :ehelp.
  220. .*******************************************
  221. .*   Help for parameter ALWF9
  222. .*******************************************
  223. :help name='BUILD/ALWF9'.
  224. Allow F9=Retrieve on commands (ALWF9) - Help
  225. :xh3.Allow F9=Retrieve on commands (ALWF9)
  226. :p.Specifies whether F9=Retrieve can be used to retrieve the commands
  227. that were included in the source member.  For example, if you had
  228. coded the CRTBNDRPG command in your *> <* tags in the source code,
  229. should F9=Retrieve display the CRTBNDRPG command?  Or should it
  230. display the BUILD command?
  231. .*
  232. :parml.
  233. :pt.:pk.*YES:epk.
  234. :pd.
  235. Pressing F9 will retrieve the commands that were executed by BUILD
  236. .*
  237. :pt.:pk def.*NO:epk.
  238. :pd.
  239. Pressing F9 will retrieve the BUILD command itself, but not any of
  240. the commands that BUILD ran for you.
  241. .*
  242. :eparml.
  243. :ehelp.
  244. .*******************************************
  245. .*   Help for parameter OPTION
  246. .*******************************************
  247. :help name='BUILD/OPTION'.
  248. Compiler Options (OPTION) - Help
  249. :xh3.Compiler Options (OPTION)
  250. :p.Specifies special options sometimes required by the Rational tools
  251. for editing your source.
  252. :parml.
  253. :pt.:pk.*NOEVENTF:epk.
  254. :pd.
  255. The &EV variable will contain *NOEVENTF.
  256. .*
  257. :pt.:pk.*EVENTF:epk.
  258. :pd.
  259. The &EV variable will contain *EVENTF.
  260. .* Describe the function provided by the pre-defined parameter value.
  261. :eparml.
  262. :ehelp.
  263. .*******************************************
  264. .*   Help for parameter USECMD
  265. .*******************************************
  266. :help name='BUILD/USECMS'.
  267. Compiler Options (USECMS) - Help
  268. :xh3.Compiler Options (USECMS)
  269. :p.Specifies special instructions in the tool to look up object
  270. information from your CMS database and then use the CMS create
  271. tool(s) to perform the actual create object function.
  272. :parml.
  273. :pt.:pk.*NO:epk.
  274. :pd.
  275. The BUILD tool will look for a pre-determined CRTxxx command to use.
  276. .*
  277. :pt.:pk.*YES:epk.
  278. :pd.
  279. The BUILD tool will query the CMS database for all the required parameter
  280. values that cannot be had from the Rational LPEX tool / PDM tool by default.
  281. It will then run a pre-determined CMS create command.
  282. :eparml.
  283. :ehelp.
  284. .*******************************************
  285. .*   Help for parameter LIST
  286. .*******************************************
  287. :help name='BUILD/LIST'.
  288. Compiler Options (LIST) - Help
  289. :xh3.Compiler Options (LIST)
  290. :p.Specifies the create command to produce a compile listing for
  291. those types that offer one.  Most do and all of the typical
  292. compile commands included offer a listing.
  293. :parml.
  294. :pt.:pk.*NO:epk.
  295. :pd.
  296. The compile listing will not be retained.
  297. .*
  298. :pt.:pk.*YES:epk.
  299. :pd.
  300. The compile listing will be retained.  This value is most important
  301. for those CMS compiles in which some CMS systems will remove a
  302. good compile listing for the programmer.
  303. :eparml.
  304. :ehelp.
  305. .**************************************************
  306. .*
  307. .* Examples for BUILD
  308. .*
  309. .**************************************************
  310. :help name='BUILD/COMMAND/EXAMPLES'.
  311. Examples for BUILD - Help
  312. :xh3.Examples for BUILD
  313. :p.:hp2.Example 1: Simple Command Example:ehp2.
  314. :xmp.
  315. BUILD OBJ(FOO)
  316. :exmp.
  317. :p.This command builds an object named FOO.  To determine
  318. how to do that, it looks for a source member named FOO in a
  319. QRPGLESRC source file in your library list.
  320. .*
  321. :p.:hp2.Example 2: Complex Command Example:ehp2.
  322. :xmp.
  323. BUILD OBJ(&L/&N) SRCFILE(&L/&F) DBGVIEW(*SOURCE) REPLACE(*YES)
  324.       USECMS(*YES) OPTION(*EVENTF)
  325. :exmp.
  326. :p.This command builds an object named using the PDM style
  327. replacement parameters.  The replacement parameters can be
  328. determined by using F16 or option 9 in PDM.  Or by adding a
  329. custom compile command to the LPEX editor.
  330. There is a list of variable you can insert.
  331. .*
  332. :ehelp.
  333. .**************************************************
  334. .*
  335. .* Error messages for BUILD
  336. .*
  337. .**************************************************
  338. :help name='BUILD/ERROR/MESSAGES'.
  339. &msg(CPX0005,QCPFMSG). BUILD - Help
  340. :xh3.&msg(CPX0005,QCPFMSG). BUILD
  341. :p.Refer to the list of errors for the command(s) in your build
  342. comments for a list of the errors that can be returned by this
  343. utility.
  344. :ehelp.
  345. :epnlgrp.
© 2004-2019 by midrange.com generated in 0.005s valid xhtml & css