Ignore:
Timestamp:
Dec 30, 2008, 5:09:46 PM (17 years ago)
Author:
bird
Message:

kmk-qr: built-in and external commands. rewrote the introduction.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/kBuild/doc/QuickReference-kmk.html

    r2163 r2166  
    293293<div class="document" id="kmk-quick-reference">
    294294<h1 class="title">kmk Quick Reference</h1>
    295 <p>This appendix summarizes the directives, text manipulation functions, and
    296 special variables which <tt class="docutils literal"><span class="pre">kmk</span></tt> understands.</p>
    297 <!-- See section Special Built-in Target Names and Summary of Options, for other
    298 summaries. -->
     295<p>This is an attempt at summarizing all directives, functions, special variables,
     296special targets, built-in commands, external commands, and <tt class="docutils literal"><span class="pre">kmk</span></tt> expressions.
     297Since <em>all</em> the features are included, the quickness of this reference can be
     298disputed. ;-)</p>
    299299<div class="section">
    300300<h1><a id="directives" name="directives">Directives</a></h1>
    … …  
    11101110</div>
    11111111<div class="section">
    1112 <h1><a id="built-in-commands" name="built-in-commands">Built-in Commands</a></h1>
    1113 <p>todo</p>
     1112<h1><a id="commands" name="commands">Commands</a></h1>
     1113<p>Builtin commands all start with <tt class="docutils literal"><span class="pre">kmk_builtin_</span></tt>, so in order to save space
     1114this prefix has been omitted in the table below. All commands comes in an
     1115external edition that can be used by/in the shell, these are prefixed <tt class="docutils literal"><span class="pre">kmk_</span></tt>.</p>
     1116<table border="1" class="docutils">
     1117<colgroup>
     1118<col width="20%" />
     1119<col width="80%" />
     1120</colgroup>
     1121<thead valign="bottom">
     1122<tr><th class="head">Command</th>
     1123<th class="head">Description</th>
     1124</tr>
     1125</thead>
     1126<tbody valign="top">
     1127<tr><td><tt class="docutils literal"><span class="pre">append</span></tt></td>
     1128<td>Append text to a file. The builtin version can output the
     1129value of a variable or the commands of a target.</td>
     1130</tr>
     1131<tr><td><tt class="docutils literal"><span class="pre">cat</span></tt></td>
     1132<td>The BSD <tt class="docutils literal"><span class="pre">cat</span></tt> command.</td>
     1133</tr>
     1134<tr><td><tt class="docutils literal"><span class="pre">chmod</span></tt></td>
     1135<td>The BSD <tt class="docutils literal"><span class="pre">chmod</span></tt> command.</td>
     1136</tr>
     1137<tr><td><tt class="docutils literal"><span class="pre">cmp</span></tt></td>
     1138<td>The BSD <tt class="docutils literal"><span class="pre">cmp</span></tt> command.</td>
     1139</tr>
     1140<tr><td><tt class="docutils literal"><span class="pre">cp</span></tt></td>
     1141<td>The BSD <tt class="docutils literal"><span class="pre">cp</span></tt> command with some twaking.</td>
     1142</tr>
     1143<tr><td><tt class="docutils literal"><span class="pre">echo</span></tt></td>
     1144<td>The BSD <tt class="docutils literal"><span class="pre">echo</span></tt> command.</td>
     1145</tr>
     1146<tr><td><tt class="docutils literal"><span class="pre">expr</span></tt></td>
     1147<td>The BSD <tt class="docutils literal"><span class="pre">expr</span></tt> command.</td>
     1148</tr>
     1149<tr><td><tt class="docutils literal"><span class="pre">install</span></tt></td>
     1150<td>The BSD <tt class="docutils literal"><span class="pre">install</span></tt> command with some tweaking.</td>
     1151</tr>
     1152<tr><td><tt class="docutils literal"><span class="pre">kDepIDB</span></tt></td>
     1153<td>Extract dependencies from a Visual C++ .IDB file.</td>
     1154</tr>
     1155<tr><td><tt class="docutils literal"><span class="pre">ln</span></tt></td>
     1156<td>The BSD <tt class="docutils literal"><span class="pre">ln</span></tt> command.</td>
     1157</tr>
     1158<tr><td><tt class="docutils literal"><span class="pre">md5sum</span></tt></td>
     1159<td>Typical MD5 sum program, custom kBuild version.</td>
     1160</tr>
     1161<tr><td><tt class="docutils literal"><span class="pre">mkdir</span></tt></td>
     1162<td>The BSD <tt class="docutils literal"><span class="pre">mkdir</span></tt> command.</td>
     1163</tr>
     1164<tr><td><tt class="docutils literal"><span class="pre">mv</span></tt></td>
     1165<td>The BSD <tt class="docutils literal"><span class="pre">mv</span></tt> command with some tweaking.</td>
     1166</tr>
     1167<tr><td><tt class="docutils literal"><span class="pre">printf</span></tt></td>
     1168<td>The BSD <tt class="docutils literal"><span class="pre">printf</span></tt> command.</td>
     1169</tr>
     1170<tr><td><tt class="docutils literal"><span class="pre">rm</span></tt></td>
     1171<td>The BSD <tt class="docutils literal"><span class="pre">rm</span></tt> command with some tweaking.</td>
     1172</tr>
     1173<tr><td><tt class="docutils literal"><span class="pre">rmdir</span></tt></td>
     1174<td>The BSD <tt class="docutils literal"><span class="pre">rmdir</span></tt> command with some tweaking.</td>
     1175</tr>
     1176<tr><td><tt class="docutils literal"><span class="pre">sleep</span></tt></td>
     1177<td>Typical <tt class="docutils literal"><span class="pre">sleep</span></tt> program, custom kBuild version.</td>
     1178</tr>
     1179<tr><td><tt class="docutils literal"><span class="pre">test</span></tt></td>
     1180<td>The BSD <tt class="docutils literal"><span class="pre">test</span></tt> program with some tweaking.</td>
     1181</tr>
     1182</tbody>
     1183</table>
     1184<p>Some additional external commands are available in the <tt class="docutils literal"><span class="pre">kmk</span></tt> / <tt class="docutils literal"><span class="pre">kBuild</span></tt>
     1185environment (<tt class="docutils literal"><span class="pre">kSomething</span></tt> command are not prefixed with <tt class="docutils literal"><span class="pre">kmk_</span></tt>):</p>
     1186<table border="1" class="docutils">
     1187<colgroup>
     1188<col width="20%" />
     1189<col width="80%" />
     1190</colgroup>
     1191<thead valign="bottom">
     1192<tr><th class="head">Command</th>
     1193<th class="head">Description</th>
     1194</tr>
     1195</thead>
     1196<tbody valign="top">
     1197<tr><td><tt class="docutils literal"><span class="pre">kDepPre</span></tt></td>
     1198<td>Extract dependencies from the C/C++ preprocessor output.</td>
     1199</tr>
     1200<tr><td><tt class="docutils literal"><span class="pre">kObjCache</span></tt></td>
     1201<td>Simple object file cache program.</td>
     1202</tr>
     1203<tr><td><tt class="docutils literal"><span class="pre">ash</span></tt></td>
     1204<td>Almquist's shell (NetBSD variant).</td>
     1205</tr>
     1206<tr><td><tt class="docutils literal"><span class="pre">gmake</span></tt></td>
     1207<td>Vanilla GNU <tt class="docutils literal"><span class="pre">make</span></tt> from same sources as <tt class="docutils literal"><span class="pre">kmk</span></tt>.</td>
     1208</tr>
     1209<tr><td><tt class="docutils literal"><span class="pre">redirect</span></tt></td>
     1210<td>Shell avoidance tool. Sets up file descriptors, environment
     1211variables and current directory before kicking of program.</td>
     1212</tr>
     1213<tr><td><tt class="docutils literal"><span class="pre">sed</span></tt></td>
     1214<td>GNU <tt class="docutils literal"><span class="pre">sed</span></tt> with some tweaks to avoid involving the shell.</td>
     1215</tr>
     1216<tr><td><tt class="docutils literal"><span class="pre">time</span></tt></td>
     1217<td>Stopwatch utility for measuring program execution time(s).</td>
     1218</tr>
     1219</tbody>
     1220</table>
    11141221</div>
    11151222<div class="section">
Note: See TracChangeset for help on using the changeset viewer.