Helix SwarmHelix Swarm

Jambase.html

  • //
  • guest/
  • grant_glouser/
  • jam/
  • Jambase.html #2
  • View
  • Commits
  • Open Download .zip Download (23 KB) 
  1. <HTML>
  2. <TITLE>
  3. Jambase Reference
  4. </TITLE>
  5. <BODY>
  6. <CENTER>
  7. <a href=http://www.perforce.com/jam/jam.html>
  8. Jam/MR
  9. </a>
  10. <H1>
  11. <A NAME="TOP">
  12. Jambase Reference
  13. </A>
  14. </H1>
  15. </CENTER>
  16. <P>
  17.        Jambase is a base set of Jam/MR rules which
  18.        provide roughly make(1)-like functionality for 
  19.        <a href="Jam.html"><b>jam</b></A>, the Jam/MR executable program.
  20.        This document, which started out as the Jambase(5) man page, 
  21.        is a reference guide to the 
  22.        <A href="#RULES">rules</A>,
  23.        <A href="#PSEUDOTARGETS">pseudotargets</A>,
  24.        and <A href="#VARS">variables</A> 
  25.        defined in Jambase for use in Jamfiles.
  26. <P>
  27. 	For further information see:
  28. <UL>
  29. <LI>
  30. 	<a href="Jamfile.html">Using Jamfiles and Jambase</A>
  31. <LI>
  32. 	<a href="Jam.html">The Jam/MR Executable Program</A>
  33. </UL>
  34. <P>
  35. Jam/MR documentation and source are available from the
  36. <A HREF=http://public.perforce.com/public/index.html>Perforce Public Depot</a>.
  37. For detailed information about any of the rules summarized below,
  38. see the 
  39. <A HREF=http://public.perforce.com/public/jam/src/Jambase>Jambase</a> 
  40. file itself.
  41. <HR>
  42. <H2>
  43. <A NAME="RULES">
  44. Jambase Rules
  45. </A>
  46. </H2>
  47. <P>
  48.        <B>As</B> <I>obj.o</I> : <I>source.s</I> ;
  49. <BLOCKQUOTE>
  50.               Assemble the file <I>source.s.</I>  Called by  the  Object
  51.               rule.
  52. </BLOCKQUOTE>
  53.        <B>Bulk</B> <I>directory</I> : <I>sources</I> ;
  54. <BLOCKQUOTE>
  55.               Copies  <I>sources</I>  into  <I>directory.</I>
  56. </BLOCKQUOTE>
  57.        <B>Cc</B> <I>object</I> : <I>source</I> ;
  58. <BLOCKQUOTE>
  59.               Compile the file <I>source</I> into <I>object,</I>  using  the  C
  60.               compiler  $(CC), its flags $(CCFLAGS) and $(OPTIM),
  61.               and the header file directories $(HDRS).  Called by
  62.               the Object rule.
  63. </BLOCKQUOTE>
  64.        <B>C++</B> <I>obj.o</I> : <I>source.cc</I> ;
  65. <BLOCKQUOTE>
  66.               Compile  the  C++ source file <I>source.cc.</I>  Called by
  67.               the Object rule.
  68. </BLOCKQUOTE>
  69. 	<B>Chmod</B> <I>target</I> ;
  70. <BLOCKQUOTE>
  71. 		<I>(Unix and VMS only.)</I>
  72. 		Change file permissions on <I>target</I> to
  73. 		target-specific $(MODE) value set by Link, File,
  74. 		Install*, and Shell rules.
  75. </BLOCKQUOTE>
  76.  
  77.        <B>Clean</B> <I>clean</I> : <I>targets</I> ;
  78. <BLOCKQUOTE>
  79.               Removes  existing  <I>targets</I>  when  <I>clean</I>  is  built.
  80.               clean is not a dependency of all, and must be built
  81.               explicitly for targets to be removed.
  82. </BLOCKQUOTE>
  83.        <B>File</B> <I>target</I> : <I>source</I> ;
  84. <BLOCKQUOTE>
  85.               Copies <I>source</I> into <I>target.</I>
  86. </BLOCKQUOTE>
  87.        <B>Fortran</B> <I>obj.o</I> : <I>source.f</I> ;
  88. <BLOCKQUOTE>
  89.               Compile the Fortran source file  <I>source.f.</I>   Called
  90.               by the Object rule.
  91. </BLOCKQUOTE>
  92. <P>
  93. 	<B>GenFile</B> <I>target</I> : <I>image</I> <I>sources</I> ;
  94. <BLOCKQUOTE>
  95. 		Runs the command "<I>image</I> <I>target</I> <I>sources</I>"
  96. 		to create <I>target</I> from <I>sources</I> and
  97. 		<I>image</I>. (where <I>image</I> is an
  98. 		executable built by the Main rule.)
  99. </BLOCKQUOTE>
  100.        <B>HardLink</B> <I>target</I> : <I>source</I> ;
  101. <BLOCKQUOTE>
  102.               Makes <I>target</I> a hard link to <I>source,</I> if it isn't one
  103.               already. (Unix only.)
  104. </BLOCKQUOTE>
  105.        <B>HdrRule</B> <I>source</I> : <I>headers</I> ;
  106. <BLOCKQUOTE>
  107.               Arranges the  proper  dependencies  when  the  file
  108.               <I>source</I>  includes  the  files  <I>headers</I>  through  the
  109.               "#include" C preprocessor  directive.   
  110. 	      <P>
  111. 	      This rule is not intended to be called explicitly.
  112. 	      It is called automatically during header scanning on
  113. 	      sources handled by the Object rule (e.g., sources in
  114. 	      Main or Library rules).
  115. </BLOCKQUOTE>
  116.        <B>InstallBin</B> <I>dir</I> : <I>sources</I> ; <BLOCKQUOTE>
  117. 	      Copy <I>sources</I> into <I>dir</I> with mode
  118. 	      $(EXEMODE).  
  119. </BLOCKQUOTE>
  120.        <B>InstallLib</B> <I>dir</I> : <I>sources</I> ; <BLOCKQUOTE>
  121. 	      Copy  <I>sources</I>  into  <I>dir</I>  with  mode
  122. 	      $(FILEMODE).  
  123. </BLOCKQUOTE>
  124.        <B>InstallMan</B> <I>dir</I> : <I>sources</I> ; <BLOCKQUOTE>
  125. 	      Copy  <I>sources</I>  into the appropriate subdirectory
  126. 	      of <I>dir</I> with mode  $(FILEMODE).   The  subdirectory
  127. 	      is man<I>s,</I>  where  <I>s</I>  is  the suffix of
  128. 	      each of sources.  
  129. </BLOCKQUOTE>
  130.        <B>InstallShell</B> <I>dir</I> : <I>sources</I> ; <BLOCKQUOTE>
  131. 	      Copy  <I>sources</I>  into  <I>dir</I>  with  mode
  132. 	      $(SHELLMODE).  
  133. </BLOCKQUOTE>
  134.        <B>Lex</B> <I>source.c</I> : <I>source.l</I> ; <BLOCKQUOTE>
  135. 	      Process  the lex(1) source file <I>source.l</I> and
  136. 	      rename the lex.yy.c to <I>source.c.</I>   Called  by
  137. 	      the  Object rule.
  138. </BLOCKQUOTE>
  139.        <B>Library</B> <I>library</I> : <I>sources</I> ; <BLOCKQUOTE>
  140. 	      Compiles  <I>sources</I>  and  archives them into
  141. 	      <I>library.</I> The  intermediate  <I>objects</I>
  142. 	      are   deleted.    Calls Objects and LibraryFromObjects.
  143. 	      <P>
  144. 	      If Library is invoked with no suffix on <I>library</I>,
  145. 	      the $(SUFLIB) suffix is used.
  146. </BLOCKQUOTE>
  147.        <B>LibraryFromObjects</B> <I>library</I> : <I>objects</I> ; 
  148. <BLOCKQUOTE>
  149. 	      Archives <I>objects</I> into  <I>library.</I>   The
  150. 	      <I>objects</I>  are then deleted.  
  151. 	      <P>
  152. 	      If <I>library</I> has no suffix, the $(SUFLIB) suffix is used.
  153. </BLOCKQUOTE>
  154. 	<B>Link</B> <I>image</I> : <I>objects</I> ;
  155. <BLOCKQUOTE>
  156. 		Links <I>image</I> from <I>objects</I> and sets
  157. 		permissions on <I>image</I> to $(EXEMODE). 
  158. 		 <I>Image</I> must be actual filename; suffix is not
  159. 		 supplied.
  160. 		Called by Main.
  161. 	
  162. </BLOCKQUOTE>
  163.        <B>LinkLibraries</B> <I>image</I> : <I>libraries</I> ;
  164. <BLOCKQUOTE>
  165. 	      Makes  <I>image</I>  depend on <I>libraries</I> and
  166. 	      includes them during the linking.
  167. 	      <P>
  168. 	      <I>Image</I> may be referenced without a suffix in this
  169. 	      rule invocation; LinkLibraries supplies the suffix.
  170. </BLOCKQUOTE>
  171.        <B>Main</B> <I>image</I> : <I>sources</I> ; 
  172. <BLOCKQUOTE>
  173. 	      Compiles <I>sources</I> and links them into <I>image.</I>
  174. 	      Calls Objects and MainFromObjects.  
  175. 	      <P>
  176. 	      <I>Image</I> may be referenced without a suffix in this
  177. 	      rule invocation; Main supplies the suffix.
  178. </BLOCKQUOTE>
  179.        <B>MainFromObjects</B> <I>image</I> : <I>objects</I> ;
  180. <BLOCKQUOTE>
  181. 	      Links <I>objects</I> into <I>image.</I>  Dependency
  182. 	      of exe. MainFromObjects supplies the suffix on <I>image</I>
  183. 	      filename.
  184. </BLOCKQUOTE>
  185. 	<B>MakeLocate</B> <I>target</I> : <I>dir</I> ;
  186. <BLOCKQUOTE>
  187. 	Creates <I>dir</I> and causes <I>target</I> to be built
  188. 	into <I>dir</I>.
  189. </BLOCKQUOTE>
  190. 	<B>MkDir</B> <I>dir</I> ;
  191. <BLOCKQUOTE>
  192. 	Creates <I>dir</I> and its parent directories.
  193. </BLOCKQUOTE>
  194.        <B>Object</B> <I>object</I> : <I>source</I> ; 
  195. <BLOCKQUOTE>
  196. 	      Compiles  a  <I>single</I> source file source into
  197. 	      <I>object.</I> The Main and Library rules use
  198. 	      this rule to compile source files.
  199. 	      <P>
  200. 	      Causes <I>source</I> to be scanned for "#include" 
  201. 	      directives and calls HdrRule to make all included
  202. 	      files dependedencies of <I>object</I>.
  203. <P>
  204. 	      Calls one of the following rules to do the actual
  205. 	      compiling, depending on the suffix of source:
  206. <PRE>
  207. 		     *.c:   Cc 
  208. 		     *.cc:  C++ 
  209. 		     *.cpp: C++
  210. 		     *.C:   C++ 
  211. 		     *.l:   Lex 
  212. 		     *.y:   Yacc
  213. 		     *.*:   UserObject
  214. </PRE>
  215. </BLOCKQUOTE>
  216.        <B>ObjectC++Flags</B> <I>source</I> : <I>flags</I> ; 
  217.        <BR>
  218.        <B>ObjectCcFlags</B> <I>source</I> : <I>flags</I> ; 
  219. <BLOCKQUOTE>
  220. 	      Add   <I>flags</I>   to   the   source-specific
  221. 	      value  of $(CCFLAGS) or $(C++FLAGS) when compiling <I>source.</I>
  222. 	      Any file  suffix on <I>source</I> is ignored.
  223. </BLOCKQUOTE>
  224.        <B>ObjectHdrs</B> <I>source</I> : <I>dirs</I> ; <BLOCKQUOTE>
  225. 	      Add  <I>dirs</I>  to  the source-specific value of
  226. 	      $(HDRS) when scanning and compiling <I>source.</I>
  227. 	      Any file  suffix on <I>source</I> is ignored.
  228. </BLOCKQUOTE>
  229.        <B>Objects</B> <I>sources</I> ; <BLOCKQUOTE>
  230. 	      For  each  source  file in <I>sources,</I> calls
  231. 	      Object to compile the source  file  into  a  similarly
  232. 	      named object file.
  233. </BLOCKQUOTE>
  234.        <B>RmTemps</B> <I>targets</I> : <I>sources</I> ; <BLOCKQUOTE>
  235. 	      Marks <I>sources</I> as temporary with the TEMPORARY
  236. 	      rule, and deletes <I>sources</I> once <I>targets</I>
  237. 	      are  built.  Must be  the  last rule invoked on
  238. 	      <I>targets.</I>  Used internally by LibraryFromObjects rule.
  239. </BLOCKQUOTE>
  240.        <B>Setuid</B> <I>images</I> ; <BLOCKQUOTE>
  241. 	      Sets the setuid bit on each of <I>images</I>  after
  242. 	      linking. (Unix only.)
  243.  
  244. </BLOCKQUOTE>
  245. 	<B>SubDir</B> <I>VAR d1 ... dn</I> ;
  246. <BLOCKQUOTE>
  247. 		Sets up housekeeping for the source files located
  248. 		in <I><CODE>$(VAR)/d1/.../dn</CODE></I>:
  249. 		<UL>
  250. 		<LI>Reads in rules file associated with <I>VAR</I>,
  251. 		    if it hasn't already been read.
  252. 		<LI>Initializes variables for search paths, 
  253. 		    output directories, compiler
  254. 		    flags, and grist, using <I>d1 ... dn</I> tokens.
  255. 		</UL>
  256. 		<P>
  257. 		<I>VAR</I> is the name of a variable; 
  258. 		<I>d1</I> thru <I>dn</I> are elements
  259. 		of a directory path.
  260. </BLOCKQUOTE>
  261. 	<B>SubDirC++Flags</B> <I>flags</I> ;
  262. 	<BR>
  263. 	<B>SubDirCcFlags</B> <I>flags</I> ;
  264. <BLOCKQUOTE>
  265. 	Adds <I>flags</I> to the compiler flags for source files
  266. 	in SubDir's directory.
  267. </BLOCKQUOTE>
  268. 	<B>SubDirHdrs</B> <I>paths</I> ;
  269. <BLOCKQUOTE>
  270. 	Adds <I>paths</I> to the header search paths for source files
  271. 	in SubDir's directory.
  272. </BLOCKQUOTE>
  273. 	<B>SubInclude</B> <I>VAR d1 ... dn</I> ;
  274. <BLOCKQUOTE>
  275. 	Reads the Jamfile in <I><CODE>$(VAR)/d1/.../dn/</CODE></I>. 
  276. </BLOCKQUOTE>
  277.        <B>Shell</B> <I>image</I> : <I>source</I> ; <BLOCKQUOTE>
  278. 	      Copies  <I>source</I>  into  the  executable  sh(1)
  279. 	      script <I>image.</I>  Ensures that the first line of
  280. 	      the  script is  $(SHELLHEADER) (default #!/bin/sh).
  281. </BLOCKQUOTE>
  282.        <B>Undefines</B> <I>images</I> : <I>symbols</I> ; <BLOCKQUOTE>
  283. 		Adds flags to mark <I>symbols</I> as undefined
  284. 		on link command for <I>images</I>.
  285. 		<I>Images</I> may be referenced unsuffixed; the
  286. 		Undefines rule supplies the suffix.
  287. </BLOCKQUOTE>
  288.        <B>UserObject</B> <I>object</I> : <I>source</I> ; <BLOCKQUOTE>
  289. 	      This rule is called by Object for source
  290. 	      files with unknown  suffixes,  and  should  be defined
  291. 	      in Jamrules
  292. 	      with a user-provided rule to handle the source file
  293. 	      types not handled by the Object rule.
  294. 	      The Jambase UserObject rule merely issues a
  295. 	      complaint when it encounters <I>source</I> with
  296. 	      files suffixes it does not recognize.
  297. </BLOCKQUOTE>
  298.        <B>Yacc</B> <I>source.c</I> : <I>source.y</I> ; <BLOCKQUOTE>
  299. 	      Process  the  yacc(1) file <I>source.y</I> and renamed
  300. 	      the resulting y.tab.c and y.tab.h  to  <I>source.c.</I>
  301. 	      Produces a y.tab.h and renames it to <I>source.h.</I>
  302. 	      Called by the <B>Object</B> rule.
  303. </BLOCKQUOTE> 
  304. <P> 
  305. <HR>   
  306. <A NAME="PSEUDOTARGETS">
  307. <H3>
  308. Jambase Pseudotargets
  309. </H3>
  310. </A>
  311. <P>
  312. There are two kinds of Jam targets: file targets and pseudotargets.
  313. File targets are objects that can be found in the filesystem.
  314. Pseudotargets are symbolic, and usually represent other targets.
  315. Most Jambase rules that define file targets also define pseudotargets
  316. which are dependent on types of file targets. The Jambase pseudotargets
  317. are:
  318. <CENTER>
  319. <TABLE CELLPADDING=5%>
  320. <TR><TD>exe
  321. 	<TD>Executables linked by the Main or MainFromObjects rules
  322.  
  323. <TR><TD>lib
  324. 	<TD>Libraries created by the Library or LibraryFromObjects rules
  325.  
  326. <TR><TD>obj
  327. 	<TD>Compiled objects used to create Main or Library targets
  328.  
  329. <TR><TD>dirs
  330. 	<TD>Directories where target files are written
  331.  
  332. <TR><TD>file
  333. 	<TD>Files copied by File and Bulk rules
  334.  
  335. <TR><TD>shell
  336. 	<TD>Files copied by Shell rule
  337.  
  338. <TR><TD>clean
  339. 	<TD>Removal of built targets (except files copied by Install* rules)
  340.  
  341. <TR><TD>install
  342. 	<TD>Files copied by Install* rules
  343.  
  344. <TR><TD>uninstall
  345. 	<TD>Removal of targets copied by Install* rules
  346.  
  347. </TABLE>
  348. </CENTER>
  349. <P> 
  350. In addition, Jambase makes the <b>jam</b> default target "all"
  351. depend on "exe", "lib", "obj", "files", and "shell".
  352. <P> 
  353.  
  354. <HR>
  355. <A NAME="VARS">
  356. <H3>
  357. Jambase Variables 
  358. </H3> 
  359. </A>
  360. <P>
  361. 	Most of the following variables have default values for
  362. 	each platform; refer to the Jambase file to see what those
  363. 	defaults are.
  364. <P>
  365. 	ALL_LOCATE_TARGET
  366. <BLOCKQUOTE>
  367. 		Alternative location of built targets. By default,
  368. 		Jambase rules locate built targets in the source
  369. 		tree. By setting $(ALL_LOCATE_TARGET)
  370. 		in Jamrules, you can cause <b>jam</b>
  371. 		to write built targets to a location outside
  372. 		the source tree.
  373. </BLOCKQUOTE>
  374.  
  375.        AR
  376.  
  377. <BLOCKQUOTE>
  378.               The archive command used to update Library
  379. 	      and LibraryFromObjects targets.
  380. </BLOCKQUOTE>
  381.        AS
  382. <BLOCKQUOTE>
  383.               The assembler for As rule targets.
  384. </BLOCKQUOTE>
  385.  
  386.        ASFLAGS
  387.  
  388. <BLOCKQUOTE>
  389.               Flags handed to the assembler for As.
  390. </BLOCKQUOTE>
  391.  
  392.        AWK
  393.  
  394. <BLOCKQUOTE>
  395.               The  name  of  awk interpreter, used when copying a
  396.               shell script for the Shell rule.
  397. </BLOCKQUOTE>
  398.  
  399. 	BCCROOT
  400. <BLOCKQUOTE>
  401. 		Selects Borland compile and link actions on NT.
  402. </BLOCKQUOTE>
  403.  
  404.  
  405.        BINDIR
  406.  
  407. <BLOCKQUOTE>
  408.               Not longer used. 
  409. 	      (I.e., used only for backward compatibility with the
  410. 	      obsolete INSTALLBIN rule.)
  411. </BLOCKQUOTE>
  412.  
  413.        CC
  414.  
  415. <BLOCKQUOTE>
  416.               C compiler used for Cc rule targets.
  417. </BLOCKQUOTE>
  418.  
  419.        CCFLAGS
  420.  
  421. <BLOCKQUOTE>
  422. 		Compile flags for Cc rule targets.
  423. 		The Cc rule sets target-specific $(CCFLAGS)
  424. 		values on its targets.
  425. </BLOCKQUOTE>
  426.  
  427.        C++
  428.  
  429. <BLOCKQUOTE>
  430.               C++ compiler used for C++ rule targets.
  431. </BLOCKQUOTE>
  432.  
  433.        C++FLAGS
  434.  
  435. <BLOCKQUOTE>
  436. 		Compile flags for C++ rule targets.
  437. 		The C++ rule sets target-specific $(C++FLAGS)
  438. 		values on its targets.
  439. </BLOCKQUOTE>
  440.  
  441.        CHMOD
  442.  
  443. <BLOCKQUOTE>
  444. 		Program (usually chmod(1)) used to set file
  445. 		permissions for Chmod rule.
  446. </BLOCKQUOTE>
  447.  
  448.        CP
  449.  
  450. <BLOCKQUOTE>
  451.               The file copy program, used by File and Install* rules.
  452. </BLOCKQUOTE>
  453.  
  454.        CRELIB
  455.  
  456. <BLOCKQUOTE>
  457. 	      If set, causes the Library rule to invoke the CreLib
  458. 	      rule on the target library before attempting to archive
  459. 	      any members, so that the library can be created if
  460. 	      needed.
  461. </BLOCKQUOTE>
  462.  
  463.        CW
  464.  
  465. <BLOCKQUOTE>
  466. 	      On Macintosh, the root of the Code Warrior Pro 5 directory.
  467. </BLOCKQUOTE>
  468.  
  469.        DOT
  470.  
  471. <BLOCKQUOTE>
  472. 	      The operating system-specific name for the current directory.
  473. </BLOCKQUOTE>
  474.  
  475.        DOTDOT
  476.  
  477. <BLOCKQUOTE>
  478. 	      The operating system-specific name for the parent directory.
  479. </BLOCKQUOTE>
  480.  
  481.        EXEMODE
  482.  
  483. <BLOCKQUOTE>
  484.               Permissions for executables linked with Link, Main,
  485. 	      and MainFromObjects, on platforms with a Chmod action.
  486. </BLOCKQUOTE>
  487.  
  488.        FILEMODE
  489.  
  490. <BLOCKQUOTE>
  491.               Permissions for files copied by File or Bulk,
  492. 	      on platforms with a Chmod action.
  493. </BLOCKQUOTE>
  494.  
  495.        FORTRAN
  496.  
  497. <BLOCKQUOTE>
  498.               The Fortran compiler used by Fortran rule.
  499. </BLOCKQUOTE>
  500.  
  501.        FORTRANFLAGS
  502.  
  503. <BLOCKQUOTE>
  504.               Fortran compiler flags for Fortran rule targets.
  505. </BLOCKQUOTE>
  506.  
  507.        GROUP
  508.  
  509. <BLOCKQUOTE>
  510. 		<I>(Unix only.)</I>
  511.               The  group  owner  for Install* rule targets.
  512. </BLOCKQUOTE>
  513.  
  514.        HDRGRIST
  515.  
  516. <BLOCKQUOTE>
  517. 	      If set, used by the HdrRule to distinguish header files
  518. 	      with the same name in diffrent directories.
  519. </BLOCKQUOTE>
  520.  
  521.        HDRPATTERN
  522.  
  523. <BLOCKQUOTE>
  524.               A  regular expression  pattern that matches
  525. 	      C preprocessor "#include" directives in source files
  526. 	      and returns the name of the included file.
  527. </BLOCKQUOTE>
  528.  
  529.        HDRRULE
  530.  
  531. <BLOCKQUOTE>
  532.               Name of the rule to invoke with the results of header file
  533.               scanning. Default is "HdrRule".
  534. 	      <P>
  535. 	      This is a jam-special variable. If both HDRRULE and HDRSCAN
  536. 	      are set on a target,
  537. 	      that target will be scanned for lines
  538. 	      matching $(HDRSCAN), and $(HDDRULE) will be
  539. 	      invoked on included files found in the matching $(HDRSCAN) lines.
  540. </BLOCKQUOTE>
  541.  
  542.        HDRS
  543.  
  544. <BLOCKQUOTE>
  545.               Directories to be  searched  for  header  files.
  546. 	      This is used by the Object rule to:
  547. 	      <UL>
  548. 	      <LI>set up search paths for finding files returned
  549. 		  by header scans
  550. 	      <LI>add -I flags on compile commands
  551. 	      </UL>
  552. 	      (See STDHDRS.)
  553. </BLOCKQUOTE>
  554.  
  555.        HDRSCAN
  556.  
  557. <BLOCKQUOTE>
  558. 		Regular expression pattern to use for header file
  559. 		scanning. The Object rule sets this to $(HDRPATTERN).
  560.               This is a jam-special variable; see HDRRULE.
  561. </BLOCKQUOTE>
  562.  
  563.        HDRSEARCH
  564.  
  565. <BLOCKQUOTE>
  566. 		Used by the HdrRule to fix the list of directories where
  567. 		header files can be found for a given source file.
  568. </BLOCKQUOTE>
  569.  
  570.        JAMFILE
  571.  
  572. <BLOCKQUOTE>
  573. 		Default is "Jamfile"; the name of the user-written
  574. 		rules file found in each source directory.
  575. </BLOCKQUOTE>
  576.  
  577.        JAMRULES
  578.  
  579. <BLOCKQUOTE>
  580. 		Default is "Jamrules"; the name of a rule definition
  581. 		file to be read in at the first SubDir rule invocation.
  582. </BLOCKQUOTE>
  583.  
  584.        KEEPOBJS
  585.  
  586. <BLOCKQUOTE>
  587. 	      If set, tells the LibraryFromObjects rule not to delete
  588. 	      object files once they are archived.  
  589. </BLOCKQUOTE>
  590.  
  591.        LEX
  592.  
  593. <BLOCKQUOTE>
  594.               The lex(1) command and flags.
  595. </BLOCKQUOTE>
  596.  
  597.        LIBDIR
  598.  
  599. <BLOCKQUOTE>
  600.               Not longer used. 
  601. 	      (I.e., used only for backward compatibility with the
  602. 	      obsolete INSTALLLIB rule.)
  603. </BLOCKQUOTE>
  604.  
  605.        LINK
  606.  
  607. <BLOCKQUOTE>
  608.               The linker. Defaults to $(CC).
  609. </BLOCKQUOTE>
  610.  
  611.        LINKFLAGS
  612.  
  613. <BLOCKQUOTE>
  614.               Flags handed to the linker. Defaults to $(CCFLAGS).
  615. </BLOCKQUOTE>
  616.  
  617.        LINKLIBS
  618.  
  619. <BLOCKQUOTE>
  620.               List of external libraries to link with.  The target  image
  621.               does not depend on these libraries.
  622. </BLOCKQUOTE>
  623.        
  624.        LN
  625.  
  626. <BLOCKQUOTE>
  627.               The hard link command for HardLink rule.
  628. </BLOCKQUOTE>
  629.  
  630. 	LOCATE_SOURCE
  631. <BLOCKQUOTE>
  632. 		Used to set the  location of generated source files.
  633. 		The Yacc, Lex, and GenFile rules set LOCATE on
  634. 		their targets to $(LOCATE_SOURCE).
  635. 		$(LOCATE_SOURCE) is initialized by the SubDir rule
  636. 		to the source directory itself.
  637. 		(Also, see ALL_LOCATE_TARGET.)
  638. </BLOCKQUOTE>
  639.  
  640.        LOCATE_TARGET
  641. <BLOCKQUOTE>
  642. 		Used to set the  location of built binary targets. 
  643. 	      The Object rule, and hence the Main and Library rules,
  644. 	      set LOCATE on their targets to $(LOCATE_TARGET).
  645. 		$(LOCATE_TARGET) is initialized by the
  646. 		SubDir rule to the source directory itself.
  647. 		(See ALL_LOCATE_TARGET.)
  648. </BLOCKQUOTE>
  649.  
  650.  
  651.        MANDIR
  652.  
  653. <BLOCKQUOTE>
  654.               Not longer used. 
  655. 	      (I.e., used only for backward compatibility with the
  656. 	      obsolete INSTALLMAN rule.)
  657. </BLOCKQUOTE>
  658.  
  659.        MKDIR
  660.  
  661. <BLOCKQUOTE>
  662.               The  'create directory' command used for the MkDir
  663.               rule.
  664. </BLOCKQUOTE>
  665.  
  666.        MODE
  667.  
  668. <BLOCKQUOTE>
  669.               The target-specific file mode (permissions) for targets 
  670. 	      of the Shell, Setuid, Link, and Install* rules.
  671. 	      Used by the Chmod action; hence relevant to NT and VMS
  672. 	      only.
  673. </BLOCKQUOTE>
  674. 	
  675. 	MSVC
  676. <BLOCKQUOTE>
  677. 		Selects Microsoft Visual C 16-bit compile & link
  678. 		actions on NT.
  679. </BLOCKQUOTE>
  680.  
  681. 	MSVCNT
  682. <BLOCKQUOTE>
  683. 		Selects Microsoft Visual C NT compile & link
  684. 		actions on NT.
  685. </BLOCKQUOTE>
  686.  
  687.  
  688.        MV
  689.  
  690. <BLOCKQUOTE>
  691.               The file rename command and options.
  692. </BLOCKQUOTE>
  693.  
  694.        NEEDLIBS
  695.  
  696. <BLOCKQUOTE>
  697. 	      The list of libraries used when linking an executable.
  698. 	      Used by the Link rule.
  699. </BLOCKQUOTE>
  700.  
  701.        NOARSCAN
  702.  
  703. <BLOCKQUOTE>
  704. 	      If set, indicates that library members' timestamps can't
  705. 	      be found, and prevents the individual objects from being
  706. 	      deleted, so that their timestamps can be used instead.
  707. </BLOCKQUOTE>
  708.  
  709.        NOARUPDATE
  710.  
  711. <BLOCKQUOTE>
  712. 	      If set, indicates that libraries can't be updated, but only
  713. 	      created whole.
  714. </BLOCKQUOTE>
  715.  
  716.        OPTIM
  717.  
  718. <BLOCKQUOTE>
  719.               The C compiler flag for optimization, used by Cc and C++
  720. 	      rules.
  721. </BLOCKQUOTE>
  722.  
  723.        OSFULL
  724.  
  725. <BLOCKQUOTE>
  726.               The concatenation of $(OS)$(OSVER)$(OSPLAT), used when jam
  727. 	      builds itself to determine the target binary directory.
  728. 	      $(OS) and $(OSPLAT) are determined by jam at its compile
  729. 	      time (in jam.h).  $(OSVER) can optionally be set by the user.
  730.  
  731. </BLOCKQUOTE>
  732.  
  733.        OWNER
  734.  
  735. <BLOCKQUOTE>
  736.               The owner of installed files.  Used by Install* rules.
  737. </BLOCKQUOTE>
  738.  
  739.        RANLIB
  740.  
  741. <BLOCKQUOTE>
  742. 		The name of the ranlib command. If set, causes
  743. 		the Ranlib action to be applied after the
  744. 		Archive action to targets of the Library rule.
  745. </BLOCKQUOTE>
  746.  
  747.        RELOCATE
  748.  
  749. <BLOCKQUOTE>
  750.               If set, tells the Cc rule to move the output object
  751.               file to its target directory because the cc command
  752.               has a broken -o option.
  753. </BLOCKQUOTE>
  754.  
  755.        RM
  756.  
  757. <BLOCKQUOTE>
  758.               The command and options to remove a file.
  759. </BLOCKQUOTE>
  760.  
  761.        SEARCH_SOURCE
  762.  
  763. <BLOCKQUOTE>
  764.               The  directory  to  find  sources listed with Main,
  765.               Library, Object,  Bulk,  File,  Shell,  InstallBin,
  766.               InstallLib,  and  InstallMan  rules.  This works by
  767.               setting the  jam-special  variable  SEARCH  to  the
  768.               value  of  $(SEARCH_SOURCE)  for each of the rules'
  769.               sources. The SubDir rule initializes SEARCH_SOURCE
  770. 	      for each directory.
  771. </BLOCKQUOTE>
  772.  
  773.        SHELLHEADER
  774.  
  775. <BLOCKQUOTE>
  776.               A string inserted to the first line of  every  file
  777.               created by the Shell rule.
  778. </BLOCKQUOTE>
  779.  
  780.        SHELLMODE
  781.  
  782. <BLOCKQUOTE>
  783.               Permissions for files installed by Shell rule.
  784. </BLOCKQUOTE>
  785.  
  786.       SOURCE_GRIST
  787.               
  788. <BLOCKQUOTE>
  789. 	      Set by the SubDir  to  a  value  derived  from  the
  790.               directory  name,  and  used  by Objects and related
  791.               rules as 'grist' to perturb file names.
  792. </BLOCKQUOTE>
  793.  
  794.        STDHDRS
  795.  
  796. <BLOCKQUOTE>
  797.               Directories where  headers  can  be  found  without
  798.               resorting to using the flag to the C compiler.
  799. 	      The $(STDHDRS) directories are used to find
  800. 	      headers during scanning, but are not passed to the
  801. 	      compiler commands as -I paths.
  802. </BLOCKQUOTE>
  803.  
  804.        SUBDIR
  805.  
  806. <BLOCKQUOTE>
  807. 	      The path from the current directory to the directory
  808. 	      last named by the SubDir rule.
  809. </BLOCKQUOTE>
  810.  
  811.        TOP
  812.  
  813. <BLOCKQUOTE>
  814. 	      The path from the current directory to the directory
  815. 	      that has the Jamrules file.  Used by the SubDir rule.
  816. </BLOCKQUOTE>
  817.  
  818.        SUFEXE
  819.  
  820. <BLOCKQUOTE>
  821.               The  suffix for executable files, if none provided.
  822.               Used by the Main rule.
  823. </BLOCKQUOTE>
  824.  
  825.        SUFLIB
  826.  
  827. <BLOCKQUOTE>
  828.               The suffix for libraries.  Used by the Library  and
  829.               related rules.
  830. </BLOCKQUOTE>
  831.  
  832.        SUFOBJ
  833.  
  834. <BLOCKQUOTE>
  835.               The  suffix  for object files.  Used by the Objects
  836.               and related rules.
  837. </BLOCKQUOTE>
  838.  
  839.        UNDEFFLAG
  840.  
  841. <BLOCKQUOTE>
  842.               The flag prefixed to each symbol for the  Undefines
  843.               rule (i.e., the compiler flag for undefined symbols).
  844. </BLOCKQUOTE>
  845.  
  846. 	WATCOM
  847. <BLOCKQUOTE>
  848. 		Selects Watcom compile and link actions on OS2.
  849. </BLOCKQUOTE>
  850.  
  851.        YACC
  852.  
  853. <BLOCKQUOTE>
  854.               The yacc(1) command.
  855. </BLOCKQUOTE>
  856.  
  857.        YACCFILES
  858.  
  859. <BLOCKQUOTE>
  860.               The base filename generated by yacc(1).
  861. </BLOCKQUOTE>
  862.  
  863.        YACCFLAGS
  864.  
  865. <BLOCKQUOTE>
  866.               The yacc(1) command flags.
  867. </BLOCKQUOTE>
  868.  
  869. <P>
  870. <HR>
  871. <A HREF="#TOP">Back to top.</A>
  872. <P>
  873. 	Copyright 1997, 2000 Perforce Software, Inc.
  874. 	<BR>
  875. 	Comments to <A HREF="mailto:info@perforce.com">info@perforce.com</A>
  876. 	<BR>
  877. 	Last updated: Dec 31, 2000
  878. 	<BR>
  879. 	$Id$
  880. </BODY>
  881. </HTML>
# Change User Description Committed
#2 553 Grant Glouser Integrate Jam 2.3 changes. 24 years ago
#1 300 Grant Glouser Branching jam sources to my guest directory. 25 years ago