qi.html 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 2019-2023 Matias Andres Fonzo, Santiago del Estero,
  4. Argentina.
  5. Permission is granted to copy, distribute and/or modify this document
  6. under the terms of the GNU Free Documentation License, Version 1.3 or
  7. any later version published by the Free Software Foundation; with no
  8. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -->
  9. <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
  10. <head>
  11. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  12. <title>Qi user guide</title>
  13. <meta name="description" content="Qi user guide">
  14. <meta name="keywords" content="Qi user guide">
  15. <meta name="resource-type" content="document">
  16. <meta name="distribution" content="global">
  17. <meta name="Generator" content="makeinfo">
  18. <link href="#Top" rel="start" title="Top">
  19. <link href="#Index" rel="index" title="Index">
  20. <style type="text/css">
  21. <!--
  22. a.summary-letter {text-decoration: none}
  23. blockquote.indentedblock {margin-right: 0em}
  24. div.display {margin-left: 3.2em}
  25. div.example {margin-left: 3.2em}
  26. div.lisp {margin-left: 3.2em}
  27. kbd {font-style: oblique}
  28. pre.display {font-family: inherit}
  29. pre.format {font-family: inherit}
  30. pre.menu-comment {font-family: serif}
  31. pre.menu-preformatted {font-family: serif}
  32. span.nolinebreak {white-space: nowrap}
  33. span.roman {font-family: initial; font-weight: normal}
  34. span.sansserif {font-family: sans-serif; font-weight: normal}
  35. ul.no-bullet {list-style: none}
  36. -->
  37. </style>
  38. </head>
  39. <body lang="en">
  40. <h1 class="settitle" align="center">Qi user guide</h1>
  41. <span id="Top"></span><div class="header">
  42. <p>
  43. Next: <a href="#Introduction-to-Qi" accesskey="n" rel="next">Introduction to Qi</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  44. </div>
  45. <span id="SEC_Top"></span>
  46. <p>This user guide is for Qi (version 2.12-rc2,
  47. 11 Apr 2023).
  48. </p>
  49. <table class="menu" border="0" cellspacing="0">
  50. <tr><td align="left" valign="top">&bull; <a href="#Introduction-to-Qi" accesskey="1">Introduction to Qi</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description and features of qi
  51. </td></tr>
  52. <tr><td align="left" valign="top">&bull; <a href="#Invoking-qi" accesskey="2">Invoking qi</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Command-line options
  53. </td></tr>
  54. <tr><td align="left" valign="top">&bull; <a href="#The-qirc-file" accesskey="3">The qirc file</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Configuration file
  55. </td></tr>
  56. <tr><td align="left" valign="top">&bull; <a href="#Packages" accesskey="4">Packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Managing packages
  57. </td></tr>
  58. <tr><td align="left" valign="top">&bull; <a href="#Recipes" accesskey="5">Recipes</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Building packages
  59. </td></tr>
  60. <tr><td align="left" valign="top">&bull; <a href="#Order-files" accesskey="6">Order files</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Handling build order
  61. </td></tr>
  62. <tr><td align="left" valign="top">&bull; <a href="#Creating-packages" accesskey="7">Creating packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Making Qi packages
  63. </td></tr>
  64. <tr><td align="left" valign="top">&bull; <a href="#Examining-packages" accesskey="8">Examining packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Debugging purposes
  65. </td></tr>
  66. <tr><td align="left" valign="top">&bull; <a href="#Qi-exit-status" accesskey="9">Qi exit status</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Exit codes
  67. </td></tr>
  68. <tr><td align="left" valign="top">&bull; <a href="#Index" rel="index">Index</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  69. </td></tr>
  70. </table>
  71. <br>
  72. <p>Copyright &copy; 2019-2023 Matias Andres Fonzo, Santiago del Estero,
  73. Argentina.
  74. </p>
  75. <p>Permission is granted to copy, distribute and/or modify this document
  76. under the terms of the GNU Free Documentation License, Version 1.3 or
  77. any later version published by the Free Software Foundation; with no
  78. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  79. </p>
  80. <hr>
  81. <span id="Introduction-to-Qi"></span><div class="header">
  82. <p>
  83. Next: <a href="#Invoking-qi" accesskey="n" rel="next">Invoking qi</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  84. </div>
  85. <span id="Introduction-to-Qi-1"></span><h2 class="chapter">1 Introduction to Qi</h2>
  86. <span id="index-introduction-to-qi"></span>
  87. <p>Qi is a simple but well-integrated package manager. It can create,
  88. install, remove, and upgrade software packages. Qi produces binary
  89. packages using recipes, which are files containing specific instructions
  90. to build each package from source. Qi can manage multiple packages
  91. under a single directory hierarchy. This method allows to maintain a set
  92. of packages and multiple versions of them. This means that Qi could be
  93. used as the main package manager or complement the existing one.
  94. </p>
  95. <p>Qi offers a friendly command line interface, a global configuration
  96. file, a simple recipe layout to deploy software packages; also works
  97. with binary packages in parallel, speeding up installations and packages
  98. in production. The format used for packages is a simplified and safer
  99. variant of POSIX pax archive compressed in lzip format.
  100. </p>
  101. <p>Qi is a modern (POSIX-compliant) shell script released under the
  102. terms of the GNU General Public License. There are only two major
  103. dependencies for the magic: graft(1) and tarlz(1), the rest is expected
  104. to be found in any Unix-like system.
  105. </p>
  106. <hr>
  107. <span id="Invoking-qi"></span><div class="header">
  108. <p>
  109. Next: <a href="#The-qirc-file" accesskey="n" rel="next">The qirc file</a>, Previous: <a href="#Introduction-to-Qi" accesskey="p" rel="prev">Introduction to Qi</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  110. </div>
  111. <span id="Invoking-qi-1"></span><h2 class="chapter">2 Invoking qi</h2>
  112. <span id="index-invocation"></span>
  113. <p>This chapter describes the synopsis for invoking Qi.
  114. </p>
  115. <div class="example">
  116. <pre class="example">Usage: qi COMMAND [<var>OPTION</var>...] [<var>FILE</var>]...
  117. </pre></div>
  118. <p>One mandatory command specifies the operation that &lsquo;<samp>qi</samp>&rsquo; should
  119. perform, options are meant to detail how this operation should be
  120. performed during or after the process.
  121. </p>
  122. <p>Qi supports the following commands:
  123. </p>
  124. <dl compact="compact">
  125. <dt><code>warn</code></dt>
  126. <dd><p>Warn about files that will be installed.
  127. </p>
  128. </dd>
  129. <dt><code>install</code></dt>
  130. <dd><p>Install packages.
  131. </p>
  132. </dd>
  133. <dt><code>remove</code></dt>
  134. <dd><p>Remove packages.
  135. </p>
  136. </dd>
  137. <dt><code>upgrade</code></dt>
  138. <dd><p>Upgrade packages.
  139. </p>
  140. </dd>
  141. <dt><code>extract</code></dt>
  142. <dd><p>Extract packages for debugging purposes.
  143. </p>
  144. </dd>
  145. <dt><code>create</code></dt>
  146. <dd><p>Create a .tlz package from directory.
  147. </p>
  148. </dd>
  149. <dt><code>build</code></dt>
  150. <dd><p>Build packages using recipe names.
  151. </p>
  152. </dd>
  153. <dt><code>order</code></dt>
  154. <dd><p>Resolve build order through .order files
  155. </p></dd>
  156. </dl>
  157. <p>Options when installing, removing, or upgrading software packages:
  158. </p>
  159. <dl compact="compact">
  160. <dt><code>-f</code></dt>
  161. <dt><code>--force</code></dt>
  162. <dd><p>Force upgrade of pre-existing packages.
  163. </p>
  164. </dd>
  165. <dt><code>-k</code></dt>
  166. <dt><code>--keep</code></dt>
  167. <dd><p>Keep directories when build/remove/upgrade.
  168. </p>
  169. <p>Keep (don&rsquo;t delete) the package directory when using remove/upgrade command.
  170. </p>
  171. <p>This will also try to preserve the directories &lsquo;<samp>${srcdir}</samp>&rsquo; and
  172. &lsquo;<samp>${destdir}</samp>&rsquo; when using build command. Its effect is available in
  173. recipes as &lsquo;<samp>${keep_srcdir}</samp>&rsquo; and &lsquo;<samp>${keep_destdir}</samp>&rsquo;. See
  174. <a href="#Recipes">Special variables</a> for details.
  175. </p>
  176. </dd>
  177. <dt><code>-p</code></dt>
  178. <dt><code>--prune</code></dt>
  179. <dd><p>Prune conflicts.
  180. </p>
  181. </dd>
  182. <dt><code>-P</code></dt>
  183. <dt><code>--packagedir=&lt;dir&gt;</code></dt>
  184. <dd><p>Set directory for package installations.
  185. </p>
  186. </dd>
  187. <dt><code>-t</code></dt>
  188. <dt><code>--targetdir=&lt;dir&gt;</code></dt>
  189. <dd><p>Set target directory for symbolic links.
  190. </p>
  191. </dd>
  192. <dt><code>-r</code></dt>
  193. <dt><code>--rootdir=&lt;dir&gt;</code></dt>
  194. <dd><p>Use the fully qualified named directory as the root directory for all qi
  195. operations.
  196. </p>
  197. <p>Note: the target directory and the package directory will be
  198. relative to the specified directory, excepting the graft log file.
  199. </p></dd>
  200. </dl>
  201. <p>Options when building software packages using recipes:
  202. </p>
  203. <dl compact="compact">
  204. <dt><code>-a</code></dt>
  205. <dt><code>--architecture</code></dt>
  206. <dd><p>Set architecture name for the package.
  207. </p>
  208. </dd>
  209. <dt><code>-j</code></dt>
  210. <dt><code>--jobs</code></dt>
  211. <dd><p>Parallel jobs for the compiler.
  212. </p>
  213. <p>This option sets the variable &lsquo;<samp>${jobs}</samp>&rsquo;. If not specified, default
  214. sets to 1.
  215. </p>
  216. </dd>
  217. <dt><code>-S</code></dt>
  218. <dt><code>--skip-questions</code></dt>
  219. <dd><p>Skip questions on completed recipes.
  220. </p>
  221. </dd>
  222. <dt><code>-1</code></dt>
  223. <dt><code>--increment</code></dt>
  224. <dd><p>Increment release number (&lsquo;<samp>${release}</samp>&rsquo; + 1).
  225. </p>
  226. <p>The effect of this option will be omitted if &ndash;no-package is being used.
  227. </p>
  228. </dd>
  229. <dt><code>-n</code></dt>
  230. <dt><code>--no-package</code></dt>
  231. <dd><p>Do not create a .tlz package.
  232. </p>
  233. </dd>
  234. <dt><code>-i</code></dt>
  235. <dt><code>--install</code></dt>
  236. <dd><p>Install package after the build.
  237. </p>
  238. </dd>
  239. <dt><code>-u</code></dt>
  240. <dt><code>--upgrade</code></dt>
  241. <dd><p>Upgrade package after the build.
  242. </p>
  243. </dd>
  244. <dt><code>-o</code></dt>
  245. <dt><code>--outdir=&lt;dir&gt;</code></dt>
  246. <dd><p>Where the packages produced will be written.
  247. </p>
  248. <p>This option sets the variable &lsquo;<samp>${outdir}</samp>&rsquo;.
  249. </p>
  250. </dd>
  251. <dt><code>-w</code></dt>
  252. <dt><code>--worktree=&lt;dir&gt;</code></dt>
  253. <dd><p>Where archives, patches, recipes are expected.
  254. </p>
  255. <p>This option sets the variable &lsquo;<samp>${worktree}</samp>&rsquo;.
  256. </p>
  257. </dd>
  258. <dt><code>-s</code></dt>
  259. <dt><code>--sourcedir=&lt;dir&gt;</code></dt>
  260. <dd><p>Where compressed sources will be found.
  261. </p>
  262. <p>This option sets the variable &lsquo;<samp>${tardir}</samp>&rsquo;.
  263. </p></dd>
  264. </dl>
  265. <p>Other options:
  266. </p>
  267. <dl compact="compact">
  268. <dt><code>-v</code></dt>
  269. <dt><code>--verbose</code></dt>
  270. <dd><p>Be verbose (an extra -v gives more).
  271. </p>
  272. <p>It sets the verbosity level, default sets to 0.
  273. </p>
  274. <p>The value 1 is used for more verbosity while the value 2 is too detailed.
  275. Although at the moment it is limited to graft(1) verbosity.
  276. </p>
  277. </dd>
  278. <dt><code>-N</code></dt>
  279. <dt><code>--no-rc</code></dt>
  280. <dd><p>Do not read the configuration file.
  281. </p>
  282. <p>This will ignore reading the qirc file.
  283. </p>
  284. </dd>
  285. <dt><code>-L</code></dt>
  286. <dt><code>--show-location</code></dt>
  287. <dd><p>Print default directory locations and exit.
  288. </p>
  289. <p>This will print the target directory, package directory, working tree,
  290. the directory for sources, and the output directory for the packages
  291. produced. The output will appear on STDOUT as follows:
  292. </p>
  293. <div class="example">
  294. <pre class="example">QI_TARGETDIR=/usr/local
  295. QI_PACKAGEDIR=/usr/local/pkgs
  296. QI_WORKTREE=/usr/src/qi
  297. QI_TARDIR=/usr/src/qi/sources
  298. QI_OUTDIR=/var/cache/qi/packages
  299. </pre></div>
  300. <p>You can set these environment variables using one of the following methods:
  301. </p>
  302. <p><code>eval &quot;$(qi -L)&quot;</code>
  303. </p>
  304. <p>This will display the default locations taking into account the values set
  305. from the qirc configuration file. You can deny the influence of the
  306. configuration file by setting the option &lsquo;<samp>-N</samp>&rsquo;.
  307. </p>
  308. <p><code>eval &quot;$(qi -N -L)&quot;</code>
  309. </p>
  310. <p>Or you can adjust the new locations using the command-line options, e.g:
  311. </p>
  312. <p><code>eval &quot;$(qi -N --targetdir=/directory -L)&quot;</code>
  313. </p>
  314. </dd>
  315. <dt><code>-h</code></dt>
  316. <dt><code>--help</code></dt>
  317. <dd><p>Display the usage and exit.
  318. </p>
  319. </dd>
  320. <dt><code>-V</code></dt>
  321. <dt><code>--version</code></dt>
  322. <dd>
  323. <p>This will print the (short) version information and then exit.
  324. </p>
  325. <p>The same can be achieved if Qi is invoked as &lsquo;<samp>qi version</samp>&rsquo;.
  326. </p></dd>
  327. </dl>
  328. <p>When FILE is -, qi can read from the standard input. See examples from
  329. the <a href="#Packages">Packages</a> section.
  330. </p>
  331. <p>Exit status: 0 for a normal exit, 1 for minor common errors (help usage,
  332. support not available, etc), 2 to indicate a command execution error;
  333. 3 for integrity check error on compressed files, 4 for empty, not
  334. regular, or expected files, 5 for empty or not defined variables,
  335. 6 when a package already exist, 10 for network manager errors.
  336. For more details, see the <a href="#Qi-exit-status">Qi exit status</a> section.
  337. </p>
  338. <hr>
  339. <span id="The-qirc-file"></span><div class="header">
  340. <p>
  341. Next: <a href="#Packages" accesskey="n" rel="next">Packages</a>, Previous: <a href="#Invoking-qi" accesskey="p" rel="prev">Invoking qi</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  342. </div>
  343. <span id="The-qirc-file-1"></span><h2 class="chapter">3 The qirc file</h2>
  344. <span id="index-configuration-file"></span>
  345. <p>The global <samp>qirc</samp> file offers a way to define variables and tools
  346. (such as a download manager) for default use. This file is used by qi
  347. at runtime, e.g., to build, install, remove or upgrade packages.
  348. </p>
  349. <p>Variables and their possible values must be declared as any other
  350. variable in the shell.
  351. </p>
  352. <p>The command line options related to the package directory and target
  353. directory and some of the command line options used for the build command,
  354. have the power to override the values declared on <samp>qirc</samp>.
  355. See <a href="#Invoking-qi">Invoking qi</a>.
  356. </p>
  357. <p>The order in which qi looks for this file is:
  358. </p>
  359. <ol>
  360. <li> <code>${HOME}/.qirc</code>
  361. Effective user.
  362. </li><li> &lsquo;<samp>${sysconfdir}/qirc</samp>&rsquo;
  363. System-wide.
  364. </li></ol>
  365. <p>If you intend to run qi as effective user, the file
  366. &lsquo;<samp>${sysconfdir}/qirc</samp>&rsquo; could be copied to <code>${HOME}/.qirc</code>
  367. setting the paths for &lsquo;<samp>${packagedir}</samp>&rsquo; and &lsquo;<samp>${targetdir}</samp>&rsquo;
  368. according to the <code>$HOME</code>.
  369. </p>
  370. <hr>
  371. <span id="Packages"></span><div class="header">
  372. <p>
  373. Next: <a href="#Recipes" accesskey="n" rel="next">Recipes</a>, Previous: <a href="#The-qirc-file" accesskey="p" rel="prev">The qirc file</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  374. </div>
  375. <span id="Packages-1"></span><h2 class="chapter">4 Packages</h2>
  376. <span id="index-managing-packages"></span>
  377. <p>A package is a suite of programs usually distributed in binary form
  378. which may also contain manual pages, documentation, or any other file
  379. associated to a specific software.
  380. </p>
  381. <p>The package format used by qi is a simplified POSIX pax archive
  382. compressed using lzip<a id="DOCF1" href="#FOOT1"><sup>1</sup></a>. The
  383. file extension for packages ends in &lsquo;<samp>.tlz</samp>&rsquo;.
  384. </p>
  385. <p>Both package installation and package de-installation are managed using
  386. two important (internal) variables: &lsquo;<samp>${packagedir}</samp>&rsquo; and
  387. &lsquo;<samp>${targetdir}</samp>&rsquo;, these values can be changed in the
  388. configuration file or via options.
  389. </p>
  390. <p>&lsquo;<samp>${packagedir}</samp>&rsquo; is a common directory tree where the package
  391. contents will be decompressed (will reside).
  392. </p>
  393. <p>&lsquo;<samp>${targetdir}</samp>&rsquo; is a target directory where the links will be
  394. made by graft(1) taking &lsquo;<samp>${packagedir}/package_name</samp>&rsquo; into account.
  395. </p>
  396. <p>Packages are installed in self-contained directory trees and symbolic
  397. links from a common area are made to the package files. This allows
  398. multiple versions of the same package to coexist on the same system.
  399. </p>
  400. <span id="Package-conflicts"></span><h3 class="section">4.1 Package conflicts</h3>
  401. <span id="index-package-conflicts"></span>
  402. <p>All the links to install or remove a package are handled by graft(1).
  403. Since multiple packages can be installed or removed at the same time,
  404. certain conflicts may arise between the packages.
  405. </p>
  406. <p>graft<a id="DOCF2" href="#FOOT2"><sup>2</sup></a>
  407. defines a CONFLICT as one of the following conditions:
  408. </p>
  409. <ul>
  410. <li> If the package object is a directory and the target object exists but is
  411. not a directory.
  412. </li><li> If the package object is not a directory and the target object exists
  413. and is not a symbolic link.
  414. </li><li> If the package object is not a directory and the target object exists
  415. and is a symbolic link to something other than the package object.
  416. </li></ul>
  417. <p>The default behavior of qi for an incoming package is to ABORT if a
  418. conflict arises. When a package is going to be deleted, qi tells to
  419. graft(1) to remove those parts that are not in conflict, leaving the
  420. links to the belonging package. This behavior can be forced if the
  421. &ndash;prune option is given.
  422. </p>
  423. <span id="Installing-packages"></span><h3 class="section">4.2 Installing packages</h3>
  424. <span id="index-package-installation"></span>
  425. <p>To install a single package, simply type:
  426. </p>
  427. <div class="example">
  428. <pre class="example">qi install coreutils_8.30_i586-1@tools.tlz
  429. </pre></div>
  430. <p>To install multiple packages at once, type:
  431. </p>
  432. <div class="example">
  433. <pre class="example">qi install gcc_8.3.0_i586-1@devel.tlz rafaela_2.2_i586-1@legacy.tlz ...
  434. </pre></div>
  435. <p>Warn about the files that will be linked:
  436. </p>
  437. <div class="example">
  438. <pre class="example">qi warn bash_5.0_i586-1@shells.tlz
  439. </pre></div>
  440. <p>This is to verify the content of a package before installing it.
  441. </p>
  442. <p>See the process of an installation:
  443. </p>
  444. <div class="example">
  445. <pre class="example">qi install --verbose mariana_3.0_i586-1@woman.tlz
  446. </pre></div>
  447. <p>A second &ndash;verbose or -v option gives more (very verbose).
  448. </p>
  449. <p>Installing package in a different location:
  450. </p>
  451. <div class="example">
  452. <pre class="example">qi install --rootdir=/media/floppy lzip_1.21_i586-1@compressors.tlz
  453. </pre></div>
  454. <p>Important: the &ndash;rootdir option assumes &lsquo;<samp>${targetdir}</samp>&rsquo; and
  455. &lsquo;<samp>${packagedir}</samp>&rsquo;. See the following example:
  456. </p>
  457. <div class="example">
  458. <pre class="example">qi install --rootdir=/home/selk lzip_1.21_i586-1@compressors.tlz
  459. </pre></div>
  460. <p>The content of &quot;lzip_1.21_i586-1@compressors.tlz&quot; will be decompressed
  461. into &lsquo;<samp>/home/selk/pkgs/lzip_1.21_i586-1@compressors</samp>&rsquo;.
  462. Assuming that the main binary for lzip is under
  463. &lsquo;<samp>/home/selk/pkgs/lzip_1.21_i586-1@compressors/usr/bin/</samp>&rsquo;
  464. the target for &quot;usr/bin&quot; will be created at &lsquo;<samp>/home/selk</samp>&rsquo;. Considering
  465. that you have exported the <code>PATH</code> as &lsquo;<samp>${HOME}/usr/bin</samp>&rsquo;, now the
  466. system is able to see the recent lzip command.
  467. </p>
  468. <p>Installing from a list of packages using standard input:
  469. </p>
  470. <div class="example">
  471. <pre class="example">qi install - &lt; PACKAGELIST.txt
  472. </pre></div>
  473. <p>Or in combination with another tool:
  474. </p><div class="example">
  475. <pre class="example">sort -u PACKAGELIST.txt | qi install -
  476. </pre></div>
  477. <p>The sort command will read and sorts the list of declared packages,
  478. while trying to have unique entries for each statement. The output
  479. produced is captured by Qi to install each package.
  480. </p>
  481. <p>An example of a list containing package names is:
  482. </p><div class="example">
  483. <pre class="example">/var/cache/qi/packages/amd64/tcl_8.6.9_amd64-1@devel.tlz
  484. /var/cache/qi/packages/amd64/tk_8.6.9.1_amd64-1@devel.tlz
  485. /var/cache/qi/packages/amd64/vala_0.42.3_amd64-1@devel.tlz
  486. </pre></div>
  487. <span id="Removing-packages"></span><h3 class="section">4.3 Removing packages</h3>
  488. <span id="index-package-de_002dinstallation"></span>
  489. <p>To remove a package, simply type:
  490. </p>
  491. <div class="example">
  492. <pre class="example">qi remove xz_5.2.4_i586-1@compressors.tlz
  493. </pre></div>
  494. <p>Remove command will match the package name using &lsquo;<samp>${packagedir}</samp>&rsquo; as
  495. prefix. For example, if the value of &lsquo;<samp>${packagedir}</samp>&rsquo; has been
  496. set to /usr/pkg, this will be equal to:
  497. </p>
  498. <div class="example">
  499. <pre class="example">qi remove /usr/pkg/xz_5.2.4_i586-1@compressors
  500. </pre></div>
  501. <p>Detailed output:
  502. </p>
  503. <div class="example">
  504. <pre class="example">qi remove --verbose /usr/pkg/xz_5.2.4_i586-1@compressors
  505. </pre></div>
  506. <p>A second &ndash;verbose or -v option gives more (very verbose).
  507. </p>
  508. <p>By default the remove command does not preserve a package directory after
  509. removing its links from &lsquo;<samp>${targetdir}</samp>&rsquo;, but this behavior can be
  510. changed if the &ndash;keep option is passed:
  511. </p>
  512. <div class="example">
  513. <pre class="example">qi remove --keep /usr/pkg/lzip_1.21_i586-1@compressors
  514. </pre></div>
  515. <p>This means that the links to the package can be reactivated, later:
  516. </p>
  517. <div class="example">
  518. <pre class="example">cd /usr/pkg &amp;&amp; graft -i lzip_1.21_i586-1@compressors
  519. </pre></div>
  520. <p>Removing package from a different location:
  521. </p>
  522. <div class="example">
  523. <pre class="example">qi remove --rootdir=/home/cthulhu xz_5.2.4_i586-1@compressors
  524. </pre></div>
  525. <p>Removing a package using standard input:
  526. </p>
  527. <div class="example">
  528. <pre class="example">echo vala_0.42.3_amd64-1@devel | qi remove -
  529. </pre></div>
  530. <p>This will match with the package directory.
  531. </p>
  532. <span id="Upgrading-packages"></span><h3 class="section">4.4 Upgrading packages</h3>
  533. <span id="index-package-upgrade"></span>
  534. <p>The upgrade command inherits the properties of the installation and removal
  535. process. To make sure that a package is updated, the package is installed
  536. in a temporary directory taking &lsquo;<samp>${packagedir}</samp>&rsquo; into account. Once
  537. the incoming package is pre-installed, qi can proceed to search and delete
  538. packages that have the same name (considered as previous ones). Finally,
  539. the package is re-installed at its final location and the temporary
  540. directory is removed.
  541. </p>
  542. <p>Since updating a package can be crucial and so to perform a successful
  543. upgrade, from start to finish, you will want to ignore some important
  544. system signals during the upgrade process, those signals are SIGHUP,
  545. SIGINT, SIGQUIT, SIGABRT, and SIGTERM.
  546. </p>
  547. <p>To upgrade a package, just type:
  548. </p>
  549. <div class="example">
  550. <pre class="example">qi upgrade gcc_9.0.1_i586-1@devel.tlz
  551. </pre></div>
  552. <p>This will proceed to upgrade &quot;gcc_9.0.1_i586-1@devel&quot; removing any other
  553. version of &quot;gcc&quot; (if any).
  554. </p>
  555. <p>If you want to keep the package directories of versions found during the
  556. upgrade process, just pass:
  557. </p>
  558. <div class="example">
  559. <pre class="example">qi upgrade --keep gcc_9.0.1_i586-1@devel.tlz
  560. </pre></div>
  561. <p>To see the upgrade process:
  562. </p>
  563. <div class="example">
  564. <pre class="example">qi upgrade --verbose gcc_9.0.1_i586-1@devel.tlz
  565. </pre></div>
  566. <p>A second &ndash;verbose or -v option gives more (very verbose).
  567. </p>
  568. <p>To force the upgrade of an existing package:
  569. </p>
  570. <div class="example">
  571. <pre class="example">qi upgrade --force gcc_9.0.1_i586-1@devel.tlz
  572. </pre></div>
  573. <span id="Package-blacklist"></span><h4 class="subsection">4.4.1 Package blacklist</h4>
  574. <span id="index-package-blacklist"></span>
  575. <p>To implement general package facilities, either to install, remove or
  576. maintain the hierarchy of packages in a clean manner, qi makes use of the
  577. pruning operation via graft(1) by default:
  578. </p>
  579. <p>There is a risk if those are crucial packages for the proper functioning
  580. of the system, because it implies the deactivation of symbolic from the
  581. target directory, <em>especially</em> when transitioning an incoming package
  582. into its final location during an upgrade.
  583. </p>
  584. <p>A blacklist of package names has been devised for the case where
  585. a user decides to upgrade all the packages in the system, or
  586. just the crucial ones, such as the C library.
  587. </p>
  588. <p>The blacklist is related to the upgrade command only, consists in installing
  589. a package instead of updating it or removing previous versions of it;
  590. the content of the package will be updated over the existing content at
  591. &lsquo;<samp>${packagedir}</samp>&rsquo;, while the existing links from
  592. &lsquo;<samp>${targetdir}</samp>&rsquo; will be preserved. A pruning of links will be
  593. carried out in order to re-link possible differences with the recent
  594. content, this helps to avoid leaving dead links in the target directory.
  595. </p>
  596. <p>Package names for the blacklist to be declared must be set from the
  597. configuration file. By default, it is declared using the package name,
  598. which is more than enough for critical system packages, but if you want to
  599. be more specific, you can declare a package using:
  600. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}</samp>&rsquo; where
  601. the package category is avoided for common matching. See
  602. <a href="#Recipes">Special variables</a> for a description of these variables.
  603. </p>
  604. <hr>
  605. <span id="Recipes"></span><div class="header">
  606. <p>
  607. Next: <a href="#Order-files" accesskey="n" rel="next">Order files</a>, Previous: <a href="#Packages" accesskey="p" rel="prev">Packages</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  608. </div>
  609. <span id="Recipes-1"></span><h2 class="chapter">5 Recipes</h2>
  610. <span id="index-recipes"></span>
  611. <p>A recipe is a file telling qi what to do. Most often, the recipe tells
  612. qi how to build a binary package from a source tarball.
  613. </p>
  614. <p>A recipe has two parts: a list of variable definitions and a list of
  615. sections. By convention, the syntax of a section is:
  616. </p>
  617. <div class="example">
  618. <pre class="example">section_name()
  619. {
  620. section lines
  621. }
  622. </pre></div>
  623. <p>The section name is followed by parentheses, one newline and an opening
  624. brace. The line finishing the section contains just a closing brace.
  625. The section names or the function names currently recognized are
  626. &lsquo;<samp>build</samp>&rsquo;.
  627. </p>
  628. <p>The &lsquo;<samp>build</samp>&rsquo; section (or <strong>shell function</strong>) is an augmented
  629. shell script that contains the main instructions to build software
  630. from source.
  631. </p>
  632. <p>If there are other functions defined by the packager, Qi detects them
  633. for later execution.
  634. </p>
  635. <span id="Variables"></span><h3 class="section">5.1 Variables</h3>
  636. <span id="index-variables"></span>
  637. <p>A &quot;variable&quot; is a <strong>shell variable</strong> defined either in <samp>qirc</samp>
  638. or in a recipe to represent a string of text, called the variable&rsquo;s
  639. &quot;value&quot;. These values are substituted by explicit request in the
  640. definitions of other variables or in calls to external commands.
  641. </p>
  642. <p>Variables can represent lists of file names, options to pass to
  643. compilers, programs to run, directories to look in for source files,
  644. directories to write output to, or anything else you can imagine.
  645. </p>
  646. <p>Definitions of variables in qi have four levels of precedence.
  647. Options which define variables from the command-line override those
  648. specified in the <samp>qirc</samp> file, while variables defined in the recipe
  649. override those specified in <samp>qirc</samp>, taking priority over those
  650. variables set by command-line options. Finally, the variables have
  651. default values if they are not defined anywhere.
  652. </p>
  653. <p>Options that set variables through the command-line can only reference
  654. variables defined in <samp>qirc</samp> and variables with default values.
  655. </p>
  656. <p>Definitions of variables in <samp>qirc</samp> can only reference variables
  657. previously defined in <samp>qirc</samp> and variables with default values.
  658. </p>
  659. <p>Definitions of variables in the recipe can only reference variables
  660. set by the command-line, variables previously defined in the recipe,
  661. variables defined in <samp>qirc</samp>, and variables with default values.
  662. </p>
  663. <span id="Special-variables"></span><h3 class="section">5.2 Special variables</h3>
  664. <span id="index-special-variables"></span>
  665. <p>There are variables which can only be set using the command line options or
  666. via <samp>qirc</samp>, there are other special variables which can be defined or
  667. redefined in a recipe. See the following definitions:
  668. </p>
  669. <p>&lsquo;<samp>outdir</samp>&rsquo; is the directory where the packages produced are written.
  670. This variable can be redefined per-recipe. Default sets to
  671. &lsquo;<samp>/var/cache/qi/packages</samp>&rsquo;.
  672. </p>
  673. <p>&lsquo;<samp>worktree</samp>&rsquo; is the working tree where archives, patches, and recipes
  674. are expected. This variable can not be redefined in the recipe. Default
  675. sets to &lsquo;<samp>/usr/src/qi</samp>&rsquo;.
  676. </p>
  677. <p>&lsquo;<samp>tardir</samp>&rsquo; is defined in the recipe to the directory where the tarball
  678. containing the source can be found. The full name of the tarball is
  679. composed as &lsquo;<samp>${tardir}/$tarname</samp>&rsquo;. Its value is available in the
  680. recipe as &lsquo;<samp>${tardir}</samp>&rsquo;; a value of . for &lsquo;<samp>tardir</samp>&rsquo; sets it to
  681. the value of CWD (Current Working Directory), this is where the recipe
  682. lives.
  683. </p>
  684. <p>&lsquo;<samp>arch</samp>&rsquo; is the architecture to compose the package name. Its value is
  685. available in the recipe as &lsquo;<samp>${arch}</samp>&rsquo;. Default value is the one
  686. that was set in the Qi configuration.
  687. </p>
  688. <p>&lsquo;<samp>jobs</samp>&rsquo; is the number of parallel jobs to pass to the compiler. Its
  689. value is available in the recipe as &lsquo;<samp>${jobs}</samp>&rsquo;. The default value
  690. is 1.
  691. </p>
  692. <p>The two variables &lsquo;<samp>${srcdir}</samp>&rsquo; and &lsquo;<samp>${destdir}</samp>&rsquo; can be
  693. set in the recipe, as any other variable, but if they are not, qi uses
  694. default values for them when building a package.
  695. </p>
  696. <p>&lsquo;<samp>srcdir</samp>&rsquo; contains the source code to be compiled, and defaults to
  697. &lsquo;<samp>${program}-${version}</samp>&rsquo;. &lsquo;<samp>destdir</samp>&rsquo; is the place where the
  698. built package will be installed, and defaults to
  699. &lsquo;<samp>${TMPDIR}/package-${program}</samp>&rsquo;.
  700. </p>
  701. <p>If &lsquo;<samp>pkgname</samp>&rsquo; is left undefined, the special variable &lsquo;<samp>program</samp>&rsquo;
  702. is assigned by default. If &lsquo;<samp>pkgversion</samp>&rsquo; is left undefined, the
  703. special variable &lsquo;<samp>version</samp>&rsquo; is assigned by default.
  704. </p>
  705. <p>&lsquo;<samp>pkgname</samp>&rsquo; and &lsquo;<samp>pkgversion</samp>&rsquo; along with: &lsquo;<samp>version</samp>&rsquo;, &lsquo;<samp>arch</samp>&rsquo;,
  706. &lsquo;<samp>release</samp>&rsquo;, and (optionally) &lsquo;<samp>pkgcategory</samp>&rsquo; are used to produce the
  707. package name in the form:
  708. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}[@${pkgcategory}].tlz</samp>&rsquo;
  709. </p>
  710. <p>&lsquo;<samp>pkgcategory</samp>&rsquo; is an optional special variable that can be defined on the
  711. recipe to categorize the package name. If it is defined, then the
  712. package output will be composed as
  713. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}[@${pkgcategory}.tlz</samp>&rsquo;.
  714. Automatically, the value of &lsquo;<samp>pkgcategory</samp>&rsquo; will be prefixed using the
  715. &lsquo;<samp>@</samp>&rsquo; (at) symbol which will be added to the last part of the package name.
  716. </p>
  717. <p>A special variable called &lsquo;<samp>replace</samp>&rsquo; can be used to declare package names
  718. that will be replaced at installation time.
  719. </p>
  720. <p>The special variables &lsquo;<samp>keep_srcdir</samp>&rsquo; and &lsquo;<samp>keep_destdir</samp>&rsquo; are provided
  721. in order to preserve the directories &lsquo;<samp>${srcdir}</samp>&rsquo; or &lsquo;<samp>${destdir}</samp>&rsquo;,
  722. if those exists as such. Note: The declaration of these variables are subject
  723. to manual deactivation; its purpose in recipes is to preserve the directories
  724. that relate to the package&rsquo;s build (source) and destination directory, that is
  725. so that another recipe can get a new package (or meta package) from there. For
  726. example, the declarations can be done as:
  727. </p>
  728. <div class="example">
  729. <pre class="example">keep_srcdir=keep_srcdir
  730. keep_destdir=keep_destdir
  731. </pre></div>
  732. <p>Then from another recipe you would proceed to copy the necessary files that
  733. will compose the meta package, from the main function you must deactivate
  734. the variables at the end:
  735. </p>
  736. <div class="example">
  737. <pre class="example">unset -v keep_srcdir keep_destdir
  738. </pre></div>
  739. <p>This will leave the &rsquo;keep_srcdir&rsquo; and &rsquo;keep_destdir&rsquo; variables blank to
  740. continue with the rest of the recipes.
  741. </p>
  742. <p>The special variable &lsquo;<samp>opt_skiprecipe</samp>&rsquo; is available when you need to
  743. ignore a recipe cleanly, continuing with the next recipe. May you add a
  744. conditional test then set it as &lsquo;<samp>opt_skiprecipe=opt_skiprecipe</samp>&rsquo;.
  745. </p>
  746. <p>The variable &lsquo;<samp>tarlz_compression_options</samp>&rsquo; can be used to change the
  747. default compression options in tarlz(1), default sets to &lsquo;<samp>-9 --solid</samp>&rsquo;.
  748. For example if the variable is declared as:
  749. </p>
  750. <div class="example">
  751. <pre class="example">tarlz_compression_options=&quot;-0 --bsolid&quot;
  752. </pre></div>
  753. <p>It will change the granularity of tarlz(1) by using the &lsquo;<samp>--bsolid</samp>&rsquo;
  754. option <a id="DOCF3" href="#FOOT3"><sup>3</sup></a>,
  755. as well as increasing the compression speed by lowering the compression
  756. level with &lsquo;<samp>-0</samp>&rsquo;.
  757. </p>
  758. <p>This is only recommended for recipes where testing, or faster processing is
  759. desired to create the packaged file more quickly. It is not recommended for
  760. production or general distribution of binary packages.
  761. </p>
  762. <p>A typical recipe contains the following variables:
  763. </p>
  764. <ul>
  765. <li> &lsquo;<samp>program</samp>&rsquo;: Software name.
  766. <p>It matches the source name. It is also used to compose the name of the
  767. package if &lsquo;<samp>${pkgname}</samp>&rsquo; is not specified.
  768. </p>
  769. </li><li> &lsquo;<samp>version</samp>&rsquo;: Software version.
  770. <p>It matches the source name. It is also used to compose the version of the
  771. package if &lsquo;<samp>${pkgversion}</samp>&rsquo; is not specified.
  772. </p>
  773. </li><li> &lsquo;<samp>arch</samp>&rsquo;: Software architecture.
  774. <p>It is used to compose the architecture of the package in which it is
  775. build.
  776. </p>
  777. </li><li> &lsquo;<samp>release</samp>&rsquo;: Release number.
  778. <p>This is used to reflect the release number of the package. It is
  779. recommended to increase this number after any significant change in
  780. the recipe or post-install script.
  781. </p>
  782. </li><li> &lsquo;<samp>pkgcategory</samp>&rsquo;: Package category.
  783. <p>Optional but recommended variable to categorize the package name when it is
  784. created.
  785. </p></li></ul>
  786. <p>Obtaining sources over the network must be declared in the recipe using
  787. the &lsquo;<samp>fetch</samp>&rsquo; variable.
  788. </p>
  789. <p>The variables &lsquo;<samp>netget</samp>&rsquo; and &lsquo;<samp>rsync</samp>&rsquo; can be defined in <samp>qirc</samp>
  790. to establish a network downloader in order to get the sources. If they
  791. are not defined, qi uses default values:
  792. </p>
  793. <p>&lsquo;<samp>netget</samp>&rsquo; is the general network downloader tool, defaults sets to
  794. &lsquo;<samp>wget2 -c -w1 -t3 --no-check-certificate</samp>&rsquo;.
  795. </p>
  796. <p>&lsquo;<samp>rsync</samp>&rsquo; is the network tool for sources containing the prefix for
  797. the RSYNC protocol, default sets to
  798. &lsquo;<samp>rsync -v -a -L -z -i --progress</samp>&rsquo;.
  799. </p>
  800. <p>The variable &lsquo;<samp>description</samp>&rsquo; is used to print the package description
  801. when a package is installed.
  802. </p>
  803. <p>A description has two parts: a brief description, and a long description.
  804. By convention, the syntax of &lsquo;<samp>description</samp>&rsquo; is:
  805. </p>
  806. <div class="example">
  807. <pre class="example">description=&quot;
  808. Brief description.
  809. Long description.
  810. &quot;
  811. </pre></div>
  812. <p>The first line of the value represented is a brief description of the
  813. software (called &quot;blurb&quot;). A blank line separates the <em>brief
  814. description</em> from the <em>long description</em>, which should contain a more
  815. descriptive description of the software.
  816. </p>
  817. <p>An example looks like:
  818. </p>
  819. <div class="example">
  820. <pre class="example">description=&quot;
  821. The GNU core utilities.
  822. The GNU core utilities are the basic file, shell and text manipulation
  823. utilities of the GNU operating system. These are the core utilities
  824. which are expected to exist on every operating system.
  825. &quot;
  826. </pre></div>
  827. <p>Please consider a length limit of 78 characters as maximum, because the same
  828. one would be used on the meta file creation. See
  829. <a href="#Recipes">The meta file</a> section.
  830. </p>
  831. <p>The &lsquo;<samp>homepage</samp>&rsquo; variable is used to declare the main site or home page:
  832. </p>
  833. <div class="example">
  834. <pre class="example">homepage=https://www.gnu.org/software/gcc
  835. </pre></div>
  836. <p>The variable &lsquo;<samp>license</samp>&rsquo; is used for license information<a id="DOCF4" href="#FOOT4"><sup>4</sup></a>.
  837. Some code in the program can be covered by license A, license B, or
  838. license C. For &quot;separate licensing&quot; or &quot;heterogeneous licensing&quot;, we
  839. suggest using <strong>|</strong> for a disjunction, <strong>&amp;</strong> for a conjunction
  840. (if that ever happens in a significant way), and comma for heterogeneous
  841. licensing. Comma would have lower precedence, plus added special terms.
  842. </p>
  843. <div class="example">
  844. <pre class="example">license=&quot;LGPL, GPL | Artistic - added permission&quot;
  845. </pre></div>
  846. <span id="Writing-recipes"></span><h3 class="section">5.3 Writing recipes</h3>
  847. <span id="index-writing-recipes"></span>
  848. <p>Originally, Qi was designed for the series of Dragora GNU/Linux-Libre 3;
  849. this doesn&rsquo;t mean you can&rsquo;t use it in another distribution, just that if
  850. you do, you&rsquo;ll have to try it out for yourself. To help with this, here
  851. are some references to well-written recipes:
  852. </p>
  853. <ul>
  854. <li> <a href="https://git.savannah.nongnu.org/cgit/dragora.git/tree/recipes">https://git.savannah.nongnu.org/cgit/dragora.git/tree/recipes</a>
  855. </li><li> <a href="https://notabug.org/dragora/dragora/src/master/recipes">https://notabug.org/dragora/dragora/src/master/recipes</a>
  856. </li><li> <a href="https://notabug.org/dragora/dragora-extras/src/master/recipes">https://notabug.org/dragora/dragora-extras/src/master/recipes</a>
  857. </li><li> <a href="https://git.savannah.nongnu.org/cgit/dragora/dragora-extras.git/tree/recipes">https://git.savannah.nongnu.org/cgit/dragora/dragora-extras.git/tree/recipes</a>
  858. </li></ul>
  859. <span id="Building-packages"></span><h3 class="section">5.4 Building packages</h3>
  860. <span id="index-package-build"></span>
  861. <p>A recipe is any valid regular file. Qi sets priorities for reading a
  862. recipe, the order in which qi looks for a recipe is:
  863. </p>
  864. <ol>
  865. <li> Current working directory.
  866. </li><li> If the specified path name does not contain &quot;recipe&quot; as the last
  867. component. Qi will complete it by adding &quot;recipe&quot; to the path name.
  868. </li><li> If the recipe is not in the current working directory, it will be
  869. searched under &lsquo;<samp>${worktree}/recipes</samp>&rsquo;. The last component will be
  870. completed adding &quot;recipe&quot; to the specified path name.
  871. </li></ol>
  872. <p>To build a single package, type:
  873. </p>
  874. <div class="example">
  875. <pre class="example">qi build x-apps/xterm
  876. </pre></div>
  877. <p>Multiple jobs can be passed to the compiler to speed up the build process:
  878. </p>
  879. <div class="example">
  880. <pre class="example">qi build --jobs 3 x-apps/xterm
  881. </pre></div>
  882. <p>Update or install the produced package (if not already installed) when the
  883. build command ends:
  884. </p>
  885. <div class="example">
  886. <pre class="example">qi build -j3 --upgrade x-apps/xterm
  887. </pre></div>
  888. <p>Only process a recipe but do not create the binary package:
  889. </p>
  890. <div class="example">
  891. <pre class="example">qi build --no-package dict/aspell
  892. </pre></div>
  893. <p>The options &ndash;install or &ndash;upgrade have no effect when &ndash;no-package
  894. is given.
  895. </p>
  896. <p>This is useful to inspect the build process of the above recipe:
  897. </p>
  898. <p>qi build &ndash;keep &ndash;no-package dict/aspell 2&gt;&amp;1 | tee aspell-log.txt
  899. </p>
  900. <p>The &ndash;keep option could preserve the source directory and the destination
  901. directory for later inspection. A log file of the build process will be
  902. created redirecting both, standard error and standard output to tee(1).
  903. </p>
  904. <span id="Variables-from-the-environment"></span><h3 class="section">5.5 Variables from the environment</h3>
  905. <span id="index-environment-variables"></span>
  906. <p>Qi has environment variables which can be used at build time:
  907. </p>
  908. <p>The variable <code>TMPDIR</code> sets the temporary directory for sources, which is
  909. used for package extractions (see <a href="#Examining-packages">Examining packages</a>) and is
  910. prepended to the value of &lsquo;<samp>${srcdir}</samp>&rsquo; and &lsquo;<samp>${destdir}</samp>&rsquo; in
  911. build command. By convention its default value is equal to
  912. &lsquo;<samp>/usr/src/qi/build</samp>&rsquo;.
  913. </p>
  914. <p>The variables <code>QICFLAGS</code>, <code>QICXXFLAGS</code>, <code>QILDFLAGS</code>, and
  915. <code>QICPPFLAGS</code> have no effect by default. The environment variables
  916. such as <code>CFLAGS</code>, <code>CXXFLAGS</code>, <code>LDFLAGS</code>, and <code>CPPFLAGS</code>
  917. are unset at compile time:
  918. </p>
  919. <p>Recommended practice is to set variables in the command line of
  920. &lsquo;<samp>configure</samp>&rsquo; or <em>make(1)</em> instead of exporting to the
  921. environment. As follows:
  922. </p>
  923. <p><a href="https://www.gnu.org/software/make/manual/html_node/Environment.html">https://www.gnu.org/software/make/manual/html_node/Environment.html</a>
  924. </p><blockquote>
  925. <p>It is not wise for makefiles to depend for their functioning on environment
  926. variables set up outside their control, since this would cause different
  927. users to get different results from the same makefile. This is against the
  928. whole purpose of most makefiles.
  929. </p></blockquote>
  930. <p>Setting environment variables for configure is deprecated because running
  931. configure in varying environments can be dangerous.
  932. </p>
  933. <p><a href="https://gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Defining-Variables.html">https://gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Defining-Variables.html</a>
  934. </p><blockquote>
  935. <p>Variables not defined in a site shell script can be set in the environment
  936. passed to configure. However, some packages may run configure again
  937. during the build, and the customized values of these variables may be
  938. lost. In order to avoid this problem, you should set them in the
  939. configure command line, using &lsquo;<samp>VAR=value</samp>&rsquo;. For example:
  940. </p>
  941. <p><code>./configure CC=/usr/local2/bin/gcc</code>
  942. </p></blockquote>
  943. <p><a href="https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Setting-Output-Variables.html">https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Setting-Output-Variables.html</a>
  944. </p><blockquote>
  945. <p>If for instance the user runs &lsquo;<samp>CC=bizarre-cc ./configure</samp>&rsquo;, then the cache,
  946. config.h, and many other output files depend upon bizarre-cc being the C
  947. compiler. If for some reason the user runs ./configure again, or if it is
  948. run via &lsquo;<samp>./config.status --recheck</samp>&rsquo;, (See Automatic Remaking, and see
  949. config.status Invocation), then the configuration can be inconsistent,
  950. composed of results depending upon two different compilers.
  951. [...]
  952. Indeed, while configure can notice the definition of CC in &lsquo;<samp>./configure
  953. CC=bizarre-cc</samp>&rsquo;, it is impossible to notice it in &lsquo;<samp>CC=bizarre-cc
  954. ./configure</samp>&rsquo;, which, unfortunately, is what most users do.
  955. [...]
  956. configure: error: changes in the environment can compromise the build.
  957. </p></blockquote>
  958. <p>If the <code>SOURCE_DATE_EPOCH</code> environment variable is set to a UNIX timestamp
  959. (defined as the number of seconds, excluding leap seconds, since 01 Jan 1970
  960. 00:00:00 UTC.); then the given timestamp will be used to overwrite any newer
  961. timestamps on the package contents (when it is created). More information
  962. about this can be found at
  963. <a href="https://reproducible-builds.org/specs/source-date-epoch/">https://reproducible-builds.org/specs/source-date-epoch/</a>.
  964. </p>
  965. <span id="The-meta-file"></span><h3 class="section">5.6 The meta file</h3>
  966. <span id="index-the-meta-file"></span>
  967. <p>The &quot;meta file&quot; is a regular file created during the build process, it
  968. contains information about the package such as package name, package
  969. version, architecture, release, fetch address, description, and other
  970. minor data extracted from processed recipes. The name of the file is
  971. generated as &lsquo;<samp>${full_pkgname}.tlz.txt</samp>&rsquo;, and its purpose is to
  972. reflect essential information to the user without having to look inside
  973. the package content. The file format is also intended to be used by
  974. other scripts or by common Unix tools.
  975. </p>
  976. <p>The content of a meta file looks like:
  977. </p>
  978. <div class="example">
  979. <pre class="example">#
  980. # Pattern scanning and processing language.
  981. #
  982. # The awk utility interprets a special-purpose programming language
  983. # that makes it possible to handle simple data-reformatting jobs
  984. # with just a few lines of code. It is a free version of 'awk'.
  985. #
  986. # GNU awk implements the AWK utility which is part of
  987. # IEEE Std 1003.1 Shell and Utilities (XCU).
  988. #
  989. QICFLAGS=&quot;-O2&quot;
  990. QICXXFLAGS=&quot;-O2&quot;
  991. QILDFLAGS=&quot;&quot;
  992. QICPPFLAGS=&quot;&quot;
  993. pkgname=gawk
  994. pkgversion=5.0.1
  995. arch=amd64
  996. release=1
  997. pkgcategory=&quot;tools&quot;
  998. full_pkgname=gawk_5.0.1_amd64-1@tools
  999. blurb=&quot;Pattern scanning and processing language.&quot;
  1000. homepage=&quot;https://www.gnu.org/software/gawk&quot;
  1001. license=&quot;GPLv3+&quot;
  1002. fetch=&quot;https://ftp.gnu.org/gnu/gawk/gawk-5.0.1.tar.lz&quot;
  1003. replace=&quot;&quot;
  1004. </pre></div>
  1005. <p>A package descriptions is extracted from the variable &lsquo;<samp>description</samp>&rsquo;
  1006. where each line is interpreted literally and pre-formatted to fit in
  1007. (exactly) <strong>80 columns</strong>, plus the character &lsquo;<samp>#</samp>&rsquo; and a blank
  1008. space is prefixed to every line (shell comments).
  1009. </p>
  1010. <p>In addition to the Special variables, there are implicit variables such as
  1011. &lsquo;<samp>blurb</samp>&rsquo;:
  1012. </p>
  1013. <p>The &lsquo;<samp>blurb</samp>&rsquo; variable is related to the special variable
  1014. &lsquo;<samp>description</samp>&rsquo;. Its value is made from the first (substantial)
  1015. line of &lsquo;<samp>description</samp>&rsquo;, mentioned as the &quot;brief description&quot;.
  1016. </p>
  1017. <p>The build flags such as &lsquo;<samp>QICFLAGS</samp>&rsquo;, &lsquo;<samp>QICXXFLAGS</samp>&rsquo;,
  1018. &lsquo;<samp>QILDFLAGS</samp>&rsquo;, and &lsquo;<samp>QICPPFLAGS</samp>&rsquo; are only added to the meta file
  1019. if the declared variable &lsquo;<samp>arch</samp>&rsquo; is not equal to the &quot;noarch&quot; value.
  1020. </p>
  1021. <hr>
  1022. <span id="Order-files"></span><div class="header">
  1023. <p>
  1024. Next: <a href="#Creating-packages" accesskey="n" rel="next">Creating packages</a>, Previous: <a href="#Recipes" accesskey="p" rel="prev">Recipes</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1025. </div>
  1026. <span id="Order-files-1"></span><h2 class="chapter">6 Order files</h2>
  1027. <span id="index-handling-build-order"></span>
  1028. <p>The order command has the purpose of resolving the build order through
  1029. .order files. An order file contains a list of recipe names, by default
  1030. does not perform any action other than to print a resolved list in
  1031. descending order. For example, if <strong>a</strong> depends on <strong>b</strong> and
  1032. <strong>c</strong>, and <strong>c</strong> depends on <strong>b</strong> as well, the file might
  1033. look like:
  1034. </p>
  1035. <div class="example">
  1036. <pre class="example">a: c b
  1037. b:
  1038. c: b
  1039. </pre></div>
  1040. <p>Each letter represents a recipe name, complete dependencies for
  1041. the first recipe name are listed in descending order, which is
  1042. printed from right to left, and removed from left to right:
  1043. </p>
  1044. <p><small>OUTPUT</small>
  1045. </p>
  1046. <div class="example">
  1047. <pre class="example">b
  1048. c
  1049. a
  1050. </pre></div>
  1051. <p>Blank lines, colons and parentheses are simply ignored. Comment lines
  1052. beginning with &lsquo;<samp>#</samp>&rsquo; are allowed.
  1053. </p>
  1054. <p>An order file could be used to build a series of packages, for example,
  1055. if the content is:
  1056. </p>
  1057. <div class="example">
  1058. <pre class="example"># Image handling libraries
  1059. libs/libjpeg-turbo: devel/nasm
  1060. x-libs/jasper: libs/libjpeg-turbo
  1061. libs/tiff: libs/libjpeg-turbo
  1062. </pre></div>
  1063. <p>To proceed with each recipe, we can type:
  1064. </p>
  1065. <div class="example">
  1066. <pre class="example">qi order imglibs.order | qi build --install -
  1067. </pre></div>
  1068. <p>The output of &lsquo;<samp>qi order imglibs.order</samp>&rsquo; tells to qi in which order it
  1069. should build the recipes:
  1070. </p>
  1071. <div class="example">
  1072. <pre class="example">devel/nasm
  1073. libs/libjpeg-turbo
  1074. x-libs/jasper
  1075. libs/tiff
  1076. </pre></div>
  1077. <hr>
  1078. <span id="Creating-packages"></span><div class="header">
  1079. <p>
  1080. Next: <a href="#Examining-packages" accesskey="n" rel="next">Examining packages</a>, Previous: <a href="#Order-files" accesskey="p" rel="prev">Order files</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1081. </div>
  1082. <span id="Creating-packages-1"></span><h2 class="chapter">7 Creating packages</h2>
  1083. <span id="index-package-creation"></span>
  1084. <p>The creation command is an internal function of qi to make new Qi
  1085. compatible packages. A package is produced using the contents of
  1086. the Current Working Directory and the package file is written out.
  1087. </p>
  1088. <div class="example">
  1089. <pre class="example">Usage: qi create [<var>Output/PackageName.tlz</var>]...
  1090. </pre></div>
  1091. <p>The argument for the file name to be written must contain a fully
  1092. qualified named directory as the output directory where the package
  1093. produced will be written. The file name should be composed using the
  1094. full name: name-version-architecture-release[@pkgcategory].tlz
  1095. </p>
  1096. <p><small>EXAMPLE</small>
  1097. </p>
  1098. <div class="example">
  1099. <pre class="example">cd /usr/pkg
  1100. cd claws-mail_3.17.1_amd64-1@x-apps
  1101. qi create /var/cache/qi/packages/claws-mail_3.17.1_amd64-1@x-apps
  1102. </pre></div>
  1103. <p>In this case, the package &quot;claws-mail_3.17.1_amd64-1@x-apps&quot; will be
  1104. written into &lsquo;<samp>/var/cache/qi/packages/</samp>&rsquo;.
  1105. </p>
  1106. <p>All packages produced are complemented by a checksum file (.sha256).
  1107. </p>
  1108. <hr>
  1109. <span id="Examining-packages"></span><div class="header">
  1110. <p>
  1111. Next: <a href="#Qi-exit-status" accesskey="n" rel="next">Qi exit status</a>, Previous: <a href="#Creating-packages" accesskey="p" rel="prev">Creating packages</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1112. </div>
  1113. <span id="Examining-packages-1"></span><h2 class="chapter">8 Examining packages</h2>
  1114. <span id="index-package-examination"></span>
  1115. <p>The extraction command serves to examine binary packages for debugging
  1116. purposes. It decompresses a package into a single directory, verifying
  1117. its integrity and preserving all of its properties (owner and permissions).
  1118. </p>
  1119. <div class="example">
  1120. <pre class="example">Usage: qi extract [<var>packagename.tlz</var>]...
  1121. </pre></div>
  1122. <p><small>EXAMPLE</small>
  1123. </p>
  1124. <div class="example">
  1125. <pre class="example">qi extract mksh_R56c_amd64-1@shells.tlz
  1126. </pre></div>
  1127. <p>This action will put the content of &quot;mksh_R56c_amd64-1@shells.tlz&quot; into a
  1128. single directory, this is a private directory for the user who requested
  1129. the action, creation operation will be equal to <strong>u=rwx,g=,o= (0700)</strong>.
  1130. The package content will reside on this location, default mask to deploy
  1131. the content will be equal to <strong>u=rwx,g=rwx,o=rwx (0000)</strong>.
  1132. </p>
  1133. <p>Note: the creation of the custom directory is influenced by the value
  1134. of the <code>TMPDIR</code> variable.
  1135. </p>
  1136. <hr>
  1137. <span id="Qi-exit-status"></span><div class="header">
  1138. <p>
  1139. Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Examining-packages" accesskey="p" rel="prev">Examining packages</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1140. </div>
  1141. <span id="Qi-exit-status-1"></span><h2 class="chapter">9 Qi exit status</h2>
  1142. <span id="index-exit-codes"></span>
  1143. <p>All the exit codes are described in this chapter.
  1144. </p>
  1145. <dl compact="compact">
  1146. <dt>&lsquo;<samp>0</samp>&rsquo;</dt>
  1147. <dd><p>Successful completion (no errors).
  1148. </p>
  1149. </dd>
  1150. <dt>&lsquo;<samp>1</samp>&rsquo;</dt>
  1151. <dd><p>Minor common errors:
  1152. </p>
  1153. <ul>
  1154. <li> Help usage on invalid options or required arguments.
  1155. </li><li> Program needed by qi (prerequisite) is not available.
  1156. </li></ul>
  1157. </dd>
  1158. <dt>&lsquo;<samp>2</samp>&rsquo;</dt>
  1159. <dd><p>Command execution error:
  1160. </p>
  1161. <p>This code is used to return the evaluation of an external command or shell
  1162. arguments in case of failure.
  1163. </p>
  1164. </dd>
  1165. <dt>&lsquo;<samp>3</samp>&rsquo;</dt>
  1166. <dd><p>Integrity check error for compressed files.
  1167. </p>
  1168. <p>Compressed files means:
  1169. </p>
  1170. <ul>
  1171. <li> A tarball file from tar(1), typically handled by the GNU tar implementation.
  1172. Supported extensions: .tar, .tar.gz, .tgz, .tar.Z, .tar.bz2, .tbz2, .tbz,
  1173. .tar.xz, .txz, .tar.zst, .tzst
  1174. </li><li> A tarball file from tarlz(1).
  1175. Supported extensions: .tar.lz, .tlz
  1176. </li><li> Zip files from unzip(1).
  1177. Supported extensions: .zip, .ZIP
  1178. </li><li> Gzip files from gzip(1).
  1179. Supported extensions: .gz, .Z
  1180. </li><li> Bzip2 files from bzip2(1).
  1181. Supported extension: .bz2
  1182. </li><li> Lzip files from lzip(1).
  1183. Supported extension: .lz
  1184. </li><li> Xz files from xz(1).
  1185. Supported extension: .xz
  1186. </li><li> Zstd files from zstd(1).
  1187. Supported extension: .zst
  1188. </li></ul>
  1189. </dd>
  1190. <dt>&lsquo;<samp>4</samp>&rsquo;</dt>
  1191. <dd><p>File empty, not regular, or expected.
  1192. </p>
  1193. <p>It&rsquo;s commonly expected:
  1194. </p>
  1195. <ul>
  1196. <li> An argument for giving commands.
  1197. </li><li> A regular file or readable directory.
  1198. </li><li> An expected extension: .tlz, .sha256, .order.
  1199. </li><li> A protocol supported by the network downloader tool.
  1200. </li></ul>
  1201. </dd>
  1202. <dt>&lsquo;<samp>5</samp>&rsquo;</dt>
  1203. <dd><p>Empty or not defined variable:
  1204. </p>
  1205. <p>This code is used to report empty or undefined variables (usually
  1206. variables coming from a recipe or assigned arrays that are tested).
  1207. </p>
  1208. </dd>
  1209. <dt>&lsquo;<samp>6</samp>&rsquo;</dt>
  1210. <dd><p>Package already installed:
  1211. </p>
  1212. <p>The package directory for an incoming .tlz package already exists.
  1213. </p>
  1214. </dd>
  1215. <dt>&lsquo;<samp>10</samp>&rsquo;</dt>
  1216. <dd><p>Network manager error:
  1217. </p>
  1218. <p>This code is used if the network downloader tool fails for some reason.
  1219. </p></dd>
  1220. </dl>
  1221. <hr>
  1222. <span id="Index"></span><div class="header">
  1223. <p>
  1224. Previous: <a href="#Qi-exit-status" accesskey="p" rel="prev">Qi exit status</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1225. </div>
  1226. <span id="Index-1"></span><h2 class="unnumbered">Index</h2>
  1227. <table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
  1228. &nbsp;
  1229. <a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
  1230. &nbsp;
  1231. <a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
  1232. &nbsp;
  1233. <a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
  1234. &nbsp;
  1235. <a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
  1236. &nbsp;
  1237. <a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
  1238. &nbsp;
  1239. <a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
  1240. &nbsp;
  1241. <a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
  1242. &nbsp;
  1243. <a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
  1244. &nbsp;
  1245. <a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
  1246. &nbsp;
  1247. <a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
  1248. &nbsp;
  1249. </td></tr></table>
  1250. <table class="index-cp" border="0">
  1251. <tr><td></td><th align="left">Index Entry</th><td>&nbsp;</td><th align="left"> Section</th></tr>
  1252. <tr><td colspan="4"> <hr></td></tr>
  1253. <tr><th id="Index_cp_letter-C">C</th><td></td><td></td></tr>
  1254. <tr><td></td><td valign="top"><a href="#index-configuration-file">configuration file</a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-qirc-file">The qirc file</a></td></tr>
  1255. <tr><td colspan="4"> <hr></td></tr>
  1256. <tr><th id="Index_cp_letter-E">E</th><td></td><td></td></tr>
  1257. <tr><td></td><td valign="top"><a href="#index-environment-variables">environment variables</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1258. <tr><td></td><td valign="top"><a href="#index-exit-codes">exit codes</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Qi-exit-status">Qi exit status</a></td></tr>
  1259. <tr><td colspan="4"> <hr></td></tr>
  1260. <tr><th id="Index_cp_letter-H">H</th><td></td><td></td></tr>
  1261. <tr><td></td><td valign="top"><a href="#index-handling-build-order">handling build order</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Order-files">Order files</a></td></tr>
  1262. <tr><td colspan="4"> <hr></td></tr>
  1263. <tr><th id="Index_cp_letter-I">I</th><td></td><td></td></tr>
  1264. <tr><td></td><td valign="top"><a href="#index-introduction-to-qi">introduction to qi</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-Qi">Introduction to Qi</a></td></tr>
  1265. <tr><td></td><td valign="top"><a href="#index-invocation">invocation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Invoking-qi">Invoking qi</a></td></tr>
  1266. <tr><td colspan="4"> <hr></td></tr>
  1267. <tr><th id="Index_cp_letter-M">M</th><td></td><td></td></tr>
  1268. <tr><td></td><td valign="top"><a href="#index-managing-packages">managing packages</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1269. <tr><td colspan="4"> <hr></td></tr>
  1270. <tr><th id="Index_cp_letter-P">P</th><td></td><td></td></tr>
  1271. <tr><td></td><td valign="top"><a href="#index-package-blacklist">package blacklist</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1272. <tr><td></td><td valign="top"><a href="#index-package-build">package build</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1273. <tr><td></td><td valign="top"><a href="#index-package-conflicts">package conflicts</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1274. <tr><td></td><td valign="top"><a href="#index-package-creation">package creation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Creating-packages">Creating packages</a></td></tr>
  1275. <tr><td></td><td valign="top"><a href="#index-package-de_002dinstallation">package de-installation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1276. <tr><td></td><td valign="top"><a href="#index-package-examination">package examination</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Examining-packages">Examining packages</a></td></tr>
  1277. <tr><td></td><td valign="top"><a href="#index-package-installation">package installation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1278. <tr><td></td><td valign="top"><a href="#index-package-upgrade">package upgrade</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Packages">Packages</a></td></tr>
  1279. <tr><td colspan="4"> <hr></td></tr>
  1280. <tr><th id="Index_cp_letter-R">R</th><td></td><td></td></tr>
  1281. <tr><td></td><td valign="top"><a href="#index-recipes">recipes</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1282. <tr><td colspan="4"> <hr></td></tr>
  1283. <tr><th id="Index_cp_letter-S">S</th><td></td><td></td></tr>
  1284. <tr><td></td><td valign="top"><a href="#index-special-variables">special variables</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1285. <tr><td colspan="4"> <hr></td></tr>
  1286. <tr><th id="Index_cp_letter-T">T</th><td></td><td></td></tr>
  1287. <tr><td></td><td valign="top"><a href="#index-the-meta-file">the meta file</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1288. <tr><td colspan="4"> <hr></td></tr>
  1289. <tr><th id="Index_cp_letter-V">V</th><td></td><td></td></tr>
  1290. <tr><td></td><td valign="top"><a href="#index-variables">variables</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1291. <tr><td colspan="4"> <hr></td></tr>
  1292. <tr><th id="Index_cp_letter-W">W</th><td></td><td></td></tr>
  1293. <tr><td></td><td valign="top"><a href="#index-writing-recipes">writing recipes</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Recipes">Recipes</a></td></tr>
  1294. <tr><td colspan="4"> <hr></td></tr>
  1295. </table>
  1296. <table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
  1297. &nbsp;
  1298. <a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
  1299. &nbsp;
  1300. <a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
  1301. &nbsp;
  1302. <a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
  1303. &nbsp;
  1304. <a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
  1305. &nbsp;
  1306. <a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
  1307. &nbsp;
  1308. <a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
  1309. &nbsp;
  1310. <a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
  1311. &nbsp;
  1312. <a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
  1313. &nbsp;
  1314. <a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
  1315. &nbsp;
  1316. <a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
  1317. &nbsp;
  1318. </td></tr></table>
  1319. <div class="footnote">
  1320. <hr>
  1321. <h4 class="footnotes-heading">Footnotes</h4>
  1322. <h5><a id="FOOT1" href="#DOCF1">(1)</a></h3>
  1323. <p>For more details about tarlz and the
  1324. lzip format, visit <a href="https://lzip.nongnu.org/tarlz.html">https://lzip.nongnu.org/tarlz.html</a>.</p>
  1325. <h5><a id="FOOT2" href="#DOCF2">(2)</a></h3>
  1326. <p>The official guide for Graft can be found at
  1327. <a href="https://peters.gormand.com.au/Home/tools/graft/graft.html">https://peters.gormand.com.au/Home/tools/graft/graft.html</a>.</p>
  1328. <h5><a id="FOOT3" href="#DOCF3">(3)</a></h3>
  1329. <p>About the &lsquo;<samp>--bsolid</samp>&rsquo; granularity option of tarlz(1),
  1330. <a href="https://www.nongnu.org/lzip/manual/tarlz_manual.html#g_t_002d_002dbsolid">https://www.nongnu.org/lzip/manual/tarlz_manual.html#g_t_002d_002dbsolid</a>.</p>
  1331. <h5><a id="FOOT4" href="#DOCF4">(4)</a></h3>
  1332. <p>The proposal for &lsquo;<samp>license</samp>&rsquo; was made by Richard M. Stallman at
  1333. <a href="https://lists.gnu.org/archive/html/gnu-linux-libre/2016-05/msg00003.html">https://lists.gnu.org/archive/html/gnu-linux-libre/2016-05/msg00003.html</a>.</p>
  1334. </div>
  1335. <hr>
  1336. </body>
  1337. </html>