summaryrefslogtreecommitdiff
path: root/jam-files/engine/debian/jam.man.sgml
blob: ee21d4d83024b27910bc724e19ff3bb9f6b0bb72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@
  -->

  <!ENTITY dhfirstname "<firstname>Yann</firstname>">
  <!ENTITY dhsurname   "<surname>Dirson</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>mai 23, 2001</date>">
  <!ENTITY dhemail     "<email>dirson@debian.org</email>">
  <!ENTITY dhusername  "Yann Dirson">
  <!ENTITY dhpackage   "jam">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    <refentrytitle>JAM</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>Jam/MR</refname>
    <refpurpose>Make(1) Redux</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>jam</command>

      <arg><option>-a</option></arg>
      <arg><option>-n</option></arg>
      <arg><option>-v</option></arg>

      <arg><option>-d <replaceable/debug/</option></arg>
      <arg><option>-f <replaceable/jambase/</option></arg>
      <arg><option>-j <replaceable/jobs/</option></arg>
      <arg><option>-o <replaceable/actionsfile/</option></arg>
      <arg><option>-s <replaceable/var/=<replaceable/value/</option></arg>
      <arg><option>-t <replaceable/target/</option></arg>

      <arg repeat><option><replaceable/target/</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>Jam is a program construction tool, like make(1).</para>

    <para>Jam recursively builds target files from source files, using
    dependency information and updating actions expressed in the
    Jambase file, which is written in jam's own interpreted language.
    The default Jambase is compiled into jam and provides a
    boilerplate for common use, relying on a user-provide file
    "Jamfile" to enumerate actual targets and sources.</para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option/-a/</term>
        <listitem>
          <para>Build all targets anyway, even if they are up-to-date.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d <replaceable/n/</option></term>
        <listitem>
          <para>Enable cummulative debugging levels from 1 to
	    <replaceable/n/. Interesting values are:

	    <glosslist>
	      <glossentry><glossterm/1/ <glossdef><simpara/Show
	      actions (the default)/</glossdef></glossentry>

	      <glossentry><glossterm/2/ <glossdef><simpara/Show
	      "quiet" actions and display all action
	      text/</glossdef></glossentry>

	      <glossentry><glossterm/3/ <glossdef><simpara>Show
	      dependency analysis, and target/source
	      timestamps/paths</simpara></glossdef></glossentry>

	      <glossentry><glossterm/4/ <glossdef><simpara/Show shell
	      arguments/</glossdef></glossentry>

	      <glossentry><glossterm/5/ <glossdef><simpara/Show rule
	      invocations and variable
	      expansions/</glossdef></glossentry>

	      <glossentry><glossterm/6/ <glossdef><simpara>Show
	      directory/header file/archive
	      scans</simpara></glossdef></glossentry>

	      <glossentry><glossterm/7/ <glossdef><simpara/Show
	      variable settings/</glossdef></glossentry>

	      <glossentry><glossterm/8/ <glossdef><simpara/Show
	      variable fetches/</glossdef></glossentry>

	      <glossentry><glossterm/9/ <glossdef><simpara/Show
	      variable manipulation, scanner
	      tokens/</glossdef></glossentry>
	    </glosslist>
	  </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d +<replaceable/n/</option></term>
        <listitem>
          <para>Enable debugging level <replaceable/n/.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option/-d 0/</term>
        <listitem>
          <para>Turn off all debugging levels. Only errors are not
          suppressed.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-f <replaceable/jambase/</option></term>
        <listitem>
          <para>Read <replaceable/jambase/ instead of using the
          built-in Jambase. Only one <option/-f/ flag is permitted,
          but the <replaceable/jambase/ may explicitly include other
          files.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-j <replaceable/n/</option></term>
        <listitem>
          <para>Run up to <replaceable/n/ shell commands concurrently
          (UNIX and NT only). The default is 1.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option/-n/</term>
        <listitem>
          <para>Don't actually execute the updating actions, but do
          everything else. This changes the debug level default to
          <option/-d2/.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-o <replaceable/file/</option></term>
        <listitem>
          <para>Write the updating actions to the specified file
          instead of running them (or outputting them, as on the
          Mac).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-s <replaceable/var/=<replaceable/value/</option></term>
        <listitem>
          <para>Set the variable <replaceable/var/ to
          <replaceable/value/, overriding both internal variables and
          variables imported from the environment. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t <replaceable/target/</option></term>
        <listitem>
          <para>Rebuild <replaceable/target/ and everything that
          depends on it, even if it is up-to-date.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option/-v/</term>
        <listitem>
          <para>Print the version of jam and exit.</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>Jam is documented fully in HTML pages available on Debian
    systems from
    <filename>/usr/share/doc/jam/Jam.html</filename>.</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was created by &dhusername; &dhemail; from
    the <filename/Jam.html/ documentation, for the &debian; system
    (but may be used by others).</para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
sgml-omittag:t
sgml-shorttag:t
End:
-->