dragora-handbook.html 114 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 2020-2023 The Dragora Team.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with no
  7. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -->
  8. <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
  9. <head>
  10. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  11. <title>Dragora 3.0 Handbook</title>
  12. <meta name="description" content="Dragora 3.0 Handbook">
  13. <meta name="keywords" content="Dragora 3.0 Handbook">
  14. <meta name="resource-type" content="document">
  15. <meta name="distribution" content="global">
  16. <meta name="Generator" content="makeinfo">
  17. <link href="#Top" rel="start" title="Top">
  18. <link href="#Index" rel="index" title="Index">
  19. <style type="text/css">
  20. <!--
  21. /*
  22. * handbook.css
  23. * CSS stylesheet based on the Dragora GNU/Linux-Libre website
  24. * (https://www.dragora.org)
  25. *
  26. *
  27. * Copyright (C)
  28. * 2019-2021, Matias Fonzo and Michael Siegel
  29. * 2019 Chris F. A. Johnson
  30. * 2023 Matias Fonzo
  31. *
  32. * Licensed under the Apache License, Version 2.0 (the "License");
  33. * you may not use this file except in compliance with the License.
  34. * You may obtain a copy of the License at
  35. *
  36. * http://www.apache.org/licenses/LICENSE-2.0
  37. *
  38. * Unless required by applicable law or agreed to in writing, software
  39. * distributed under the License is distributed on an "AS IS" BASIS,
  40. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  41. * See the License for the specific language governing permissions and
  42. * limitations under the License.
  43. */
  44. a.summary-letter {text-decoration: none}
  45. blockquote.indentedblock {margin-right: 0em}
  46. div.display {margin-left: 3.2em}
  47. div.example {margin-left: 3.2em}
  48. div.lisp {margin-left: 3.2em}
  49. kbd {font-style: oblique}
  50. pre.display {font-family: inherit}
  51. pre.format {font-family: inherit}
  52. pre.menu-comment {font-family: serif}
  53. pre.menu-preformatted {font-family: serif}
  54. span.nolinebreak {white-space: nowrap}
  55. span.roman {font-family: initial; font-weight: normal}
  56. span.sansserif {font-family: sans-serif; font-weight: normal}
  57. ul.no-bullet {list-style: none}
  58. body {
  59. font-family:Helvetica,"Helvetica Neue",DejaVuSans,FreeSans,"Nimbus Sans L",sans-serif;
  60. font-size:18px;
  61. background-color:#ffffff;
  62. color:#000000;
  63. }
  64. /** Headings **/
  65. h1 {
  66. margin:0;
  67. font-size:2.33rem;
  68. color:#4169e1;
  69. }
  70. h2 {
  71. margin-top:1.5rem;
  72. margin-bottom:1.33rem;
  73. font-size:1.67rem;
  74. color:#4682b4;
  75. }
  76. h3 {
  77. margin-top:1.33rem;
  78. margin-bottom:1.17rem;
  79. font-size:1.5rem;
  80. color:#4682b4;
  81. }
  82. h4 {
  83. margin-top:1.17rem;
  84. margin-bottom:1rem;
  85. font-size:1.17rem;
  86. color:#4682b4;
  87. }
  88. /** Paragraphs **/
  89. p {
  90. margin:1rem 0;
  91. text-align:justify;
  92. }
  93. /** Quote blocks **/
  94. blockquote {
  95. margin:1rem 2rem;
  96. }
  97. /** Lists **/
  98. dl, ol, ul {
  99. margin:1rem 0;
  100. padding-left:2rem;
  101. }
  102. dl dd {
  103. margin-left:1rem;
  104. }
  105. /* Add space between each list item. */
  106. li {
  107. margin:0.3em 0;
  108. }
  109. /* Switch vertical margins off for nested lists. */
  110. dl dl, ol ol, ul ul {
  111. margin:0;
  112. }
  113. /** Tables **/
  114. table {
  115. margin:1rem auto;
  116. margin-left:3rem;
  117. border:1px solid #999999;
  118. border-collapse:collapse;
  119. }
  120. table.alt_rows tbody tr:nth-child(odd) {
  121. background-color:#ffffcc;
  122. }
  123. th, td {
  124. border:1px solid #999999;
  125. padding:.33rem;
  126. text-align:justify;
  127. }
  128. th {
  129. background-color:#cccccc;
  130. }
  131. /** Misc **/
  132. hr {
  133. margin:.5rem auto;
  134. border: 1px inset;
  135. }
  136. /*** Inline elements ***/
  137. code {
  138. padding:0 .25rem;
  139. font-family:monospace;
  140. font-weight:lighter;
  141. background-color:#fffafa;
  142. }
  143. kbd {
  144. padding:0 .25rem;
  145. font-family:monospace;
  146. font-weight:normal;
  147. background-color:#fffafa;
  148. }
  149. /** Links **/
  150. a:link {
  151. color:#00008b;
  152. /* color:#002288; */
  153. }
  154. a:visited {
  155. color:#666666;
  156. }
  157. a:hover {
  158. color:#ff69b4;
  159. }
  160. a:active {
  161. color:#bc8f8f;
  162. }
  163. -->
  164. </style>
  165. </head>
  166. <body lang="en">
  167. <h1 class="settitle" align="center">Dragora 3.0 Handbook</h1>
  168. <span id="Top"></span><div class="header">
  169. <p>
  170. Next: <a href="#About-this-handbook" accesskey="n" rel="next">About this handbook</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  171. </div>
  172. <span id="SEC_Top"></span>
  173. <p>This Handbook is for Dragora
  174. (version 3.0, initial revision, 26 Apr 2023).
  175. </p>
  176. <table class="menu" border="0" cellspacing="0">
  177. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">Preface
  178. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#About-this-handbook" accesskey="1">About this handbook</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  179. </td></tr>
  180. <tr><td align="left" valign="top">&bull; <a href="#Revision-history-_0028ChangeLog_0029" accesskey="2">Revision history (ChangeLog)</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  181. </td></tr>
  182. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
  183. About Dragora
  184. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#What-is-Dragora_003f" accesskey="3">What is Dragora?</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  185. </td></tr>
  186. <tr><td align="left" valign="top">&bull; <a href="#Why-should-I-use-Dragora_003f" accesskey="4">Why should I use Dragora?</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  187. </td></tr>
  188. <tr><td align="left" valign="top">&bull; <a href="#History" accesskey="5">History</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  189. </td></tr>
  190. <tr><td align="left" valign="top">&bull; <a href="#Maintainers" accesskey="6">Maintainers</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  191. </td></tr>
  192. <tr><td align="left" valign="top">&bull; <a href="#A-quick-glance-at-Dragora" accesskey="7">A quick glance at Dragora</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  193. </td></tr>
  194. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
  195. Setting up a Dragora system
  196. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Boot-options-from-live-medium" accesskey="8">Boot options from live medium</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  197. </td></tr>
  198. <tr><td align="left" valign="top">&bull; <a href="#Using-dragora_002dinstaller" accesskey="9">Using dragora-installer</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  199. </td></tr>
  200. <tr><td align="left" valign="top">&bull; <a href="#Installing-the-system-manually-_0028as-an-alternative_0029">Installing the system manually (as an alternative)</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  201. </td></tr>
  202. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
  203. Basic system configuration
  204. Package Management
  205. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Introduction-to-package-management-in-Dragora">Introduction to package management in Dragora</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  206. </td></tr>
  207. <tr><td align="left" valign="top">&bull; <a href="#Package-management-in-a-nutshell">Package management in a nutshell</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  208. </td></tr>
  209. <tr><td align="left" valign="top">&bull; <a href="#Using-third_002dparty-free-software">Using third-party free software</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  210. </td></tr>
  211. <tr><td align="left" valign="top">&bull; <a href="#Introduction-to-Qi">Introduction to Qi</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description and features of qi
  212. </td></tr>
  213. <tr><td align="left" valign="top">&bull; <a href="#Invoking-qi">Invoking qi</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Command-line options
  214. </td></tr>
  215. <tr><td align="left" valign="top">&bull; <a href="#The-qirc-file">The qirc file</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Configuration file
  216. </td></tr>
  217. <tr><td align="left" valign="top">&bull; <a href="#Packages">Packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Managing packages
  218. </td></tr>
  219. <tr><td align="left" valign="top">&bull; <a href="#Recipes">Recipes</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Building packages
  220. </td></tr>
  221. <tr><td align="left" valign="top">&bull; <a href="#Order-files">Order files</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Handling build order
  222. </td></tr>
  223. <tr><td align="left" valign="top">&bull; <a href="#Creating-packages">Creating packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Making Qi packages
  224. </td></tr>
  225. <tr><td align="left" valign="top">&bull; <a href="#Examining-packages">Examining packages</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Debugging purposes
  226. </td></tr>
  227. <tr><td align="left" valign="top">&bull; <a href="#Qi-exit-status">Qi exit status</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Exit codes
  228. </td></tr>
  229. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
  230. Additional Chapters
  231. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Getting-support">Getting support</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  232. </td></tr>
  233. <tr><td align="left" valign="top">&bull; <a href="#Contributing-to-Dragora">Contributing to Dragora</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  234. </td></tr>
  235. <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
  236. </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  237. </td></tr>
  238. <tr><td align="left" valign="top">&bull; <a href="#Index" rel="index">Index</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  239. </td></tr>
  240. </table>
  241. <br>
  242. <p>Copyright &copy; 2020-2023 The Dragora Team.
  243. </p>
  244. <p>Permission is granted to copy, distribute and/or modify this document
  245. under the terms of the GNU Free Documentation License, Version 1.3 or
  246. any later version published by the Free Software Foundation; with no
  247. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  248. </p>
  249. <hr>
  250. <span id="About-this-handbook"></span><div class="header">
  251. <p>
  252. Next: <a href="#Revision-history-_0028ChangeLog_0029" accesskey="n" rel="next">Revision history (ChangeLog)</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>
  253. </div>
  254. <span id="About-this-handbook-1"></span><h2 class="chapter">1 About this handbook</h2>
  255. <span id="index-about-this-handbook"></span>
  256. <p>TODO (Add intro + versioning scheme paragraph).
  257. </p>
  258. <span id="Typographic-conventions"></span><h3 class="section">1.1 Typographic conventions</h3>
  259. <span id="index-typographic-conventions"></span>
  260. <p>TODO (appendix).
  261. </p>
  262. <hr>
  263. <span id="Revision-history-_0028ChangeLog_0029"></span><div class="header">
  264. <p>
  265. Next: <a href="#What-is-Dragora_003f" accesskey="n" rel="next">What is Dragora?</a>, Previous: <a href="#About-this-handbook" accesskey="p" rel="prev">About this handbook</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  266. </div>
  267. <span id="Revision-history-_0028ChangeLog_0029-1"></span><h2 class="unnumbered">Revision history (ChangeLog)</h2>
  268. <span id="index-revision-history-_0028changelog_0029"></span>
  269. <p>TODO (appendix).
  270. </p>
  271. <hr>
  272. <span id="What-is-Dragora_003f"></span><div class="header">
  273. <p>
  274. Next: <a href="#Why-should-I-use-Dragora_003f" accesskey="n" rel="next">Why should I use Dragora?</a>, Previous: <a href="#Revision-history-_0028ChangeLog_0029" accesskey="p" rel="prev">Revision history (ChangeLog)</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  275. </div>
  276. <span id="What-is-Dragora_003f-1"></span><h2 class="chapter">2 What is Dragora?</h2>
  277. <span id="index-what-is-dragora_003f"></span>
  278. <p><strong>Dragora</strong> is an independent GNU/Linux distribution project which
  279. was created from scratch with the intention of providing a reliable
  280. operating system with maximum respect for the user by including entirely
  281. free software. <strong>Dragora</strong> is based on the concepts of simplicity
  282. and elegance, it offers a user-friendly Unix-like environment with
  283. emphasis on stability and security for long-term durability.
  284. </p>
  285. <p>To put it in a nutshell, <strong>Dragora</strong> is...
  286. </p><ul>
  287. <li> Minimalist.
  288. </li><li> Free as in freedom.
  289. </li><li> Getting better by the day.
  290. </li><li> A whole lot of fun (not suitable for old vinegars).
  291. </li></ul>
  292. <p>Some of the features of Dragora are:
  293. </p>
  294. <ul>
  295. <li> SysV init as the classic, documented initialization program (PID 1).
  296. </li><li> Perp to reliably start, monitor, log and control &quot;critical&quot; system daemons.
  297. </li><li> Lightweight alternatives to popular free software; i.e, musl libc, libressl,
  298. mksh, scron, pkgconf.
  299. </li><li> The Trinity Desktop Environment (TDE).
  300. </li><li> Window managers such as TWM, DWM.
  301. </li><li> Graft for managing multiple packages under a single directory hierarchy
  302. using symbolic links mechanisms.
  303. </li><li> Qi as a simple local package manager that complements Graft to create,
  304. install, remove and upgrade software packages.
  305. </li></ul>
  306. <span id="Free-software"></span><h3 class="section">2.1 Free software</h3>
  307. <span id="index-free-software"></span>
  308. <p>TODO.
  309. </p>
  310. <span id="GNU"></span><h3 class="section">2.2 GNU</h3>
  311. <span id="index-gnu"></span>
  312. <p>TODO.
  313. </p>
  314. <span id="Linux-and-Linux_002dlibre"></span><h3 class="section">2.3 Linux and Linux-libre</h3>
  315. <span id="index-linux-or-linux_002dlibre"></span>
  316. <p>TODO.
  317. </p>
  318. <hr>
  319. <span id="Why-should-I-use-Dragora_003f"></span><div class="header">
  320. <p>
  321. Next: <a href="#History" accesskey="n" rel="next">History</a>, Previous: <a href="#What-is-Dragora_003f" accesskey="p" rel="prev">What is Dragora?</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  322. </div>
  323. <span id="Why-should-I-use-Dragora_003f-1"></span><h2 class="chapter">3 Why should I use Dragora?</h2>
  324. <span id="index-why-should-I-use-dragora_003f"></span>
  325. <p>We cannot and do not intend to decide for you, we can only cite what we
  326. believe to be Dragora&rsquo;s main strengths:
  327. </p>
  328. <ul>
  329. <li> <strong>Independent</strong>:
  330. As mentioned before, Dragora is an independent project, this means that it
  331. is based on a voluntary basis where one or more people share the same
  332. direction or intentions for the sake of the project and in benefit of the
  333. free software community. But above all, it is
  334. not a purely commercial project or one that is made by a company, where they
  335. have commercial interests, and where many times they will do anything to
  336. catch you and see your face for their selfish business.
  337. </li><li> <strong>Simple:</strong> The underlying concept of Dragora&rsquo;s design philosophy is
  338. simplicity: KISS, &quot;Keep It Simple, Stupid!&quot;. This principle, which derives
  339. from what is known as &quot;Ockham&rsquo;s razor,&quot; was developed by the first modern
  340. critical philosopher: William of Ockham. We believe this concept represents
  341. the traditional UNIX philosophy - so we don&rsquo;t add functionality
  342. unnecessarily, nor do we duplicate information.
  343. </li><li> <strong>Ethical:</strong> We try to ensure that the included software is
  344. completely free and allows you to legally run, copy, distribute, study,
  345. change and improve the software.
  346. </li><li> <strong>Language:</strong> Native support.
  347. </li><li> <strong>Community:</strong> Dragora is not a closed project. On the contrary, anyone
  348. person with good intentions is welcome - and encouraged! - to join and help.
  349. </li></ul>
  350. <hr>
  351. <span id="History"></span><div class="header">
  352. <p>
  353. Next: <a href="#Maintainers" accesskey="n" rel="next">Maintainers</a>, Previous: <a href="#Why-should-I-use-Dragora_003f" accesskey="p" rel="prev">Why should I use Dragora?</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  354. </div>
  355. <span id="History-1"></span><h2 class="chapter">4 History</h2>
  356. <span id="index-history"></span>
  357. <p>Development of Dragora started in 2007 by Matias Andres Fonzo from
  358. Santiago del Estero, Argentina. After one year of hard work, the first
  359. beta of Dragora was released on June 13, 2008, which contained the basic
  360. GNU toolset, boot scripts, package system, and an installer.
  361. Whereas the intention was to achieve a 100% &quot;free&quot; as in freedom
  362. GNU/Linux distribution from the beginning, this very first version was not
  363. fully free (or libre) since all parts were free software, except for the
  364. Linux Kernel due to blobs or non-free parts. Fortunately, the Linux-Libre
  365. project appears that same year, which removes or cleans the non-free parts
  366. of the official versions of the Linux Kernel. This led to the second beta
  367. of Dragora on September 18, 2008; completing distribution&rsquo;s freedom by
  368. replacing the Kernel, and becoming the first one available to the public.
  369. Ongoing work to provide a more complete distribution would result in the
  370. stable release of Dragora 1.0, achieved on March 13, 2009. The series
  371. ends with the massive update plus fixes and added software for version
  372. 1.1 released on October 8, 2009.
  373. </p>
  374. <p>Design of this series was based on a traditional GNU/Linux scheme with
  375. SysVinit as the init system but using BSD-style boot scripts. The package
  376. system, the installer, the text menu-mode tools and the boot scripts were
  377. all written using the syntax and the features offered by GNU Bash.
  378. Initially the binary packages were provided in .tbz2 format (files
  379. compressed with bzip2 and packaged using GNU Tar) which later migrated to
  380. the .tlz format (files compressed with lzip for a higher compression plus
  381. very safe integrity checking). Dragora&rsquo;s installer offered the option of
  382. several languages (translations produced by the community) to choose
  383. between English, Galician, Italian, and Spanish. A second CD included the
  384. packages for the K Desktop Environment (KDE) 3 series.
  385. </p>
  386. <span id="Releases"></span><h3 class="section">4.1 Releases</h3>
  387. <span id="index-releases"></span>
  388. <p>Below are the dates and code names used for all the Dragora releases:
  389. </p>
  390. <ul>
  391. <li> <em><strong>Dragora 1.0 Beta 1:</strong> June 13th, 2008 - &quot;hell&quot;.</em>
  392. </li><li> <em><strong>Dragora 1.0 Beta 2:</strong> September 18th, 2008.</em>
  393. </li><li> <em><strong>Dragora 1.0 Release Candidate 1:</strong> February 12th, 2009.</em>
  394. </li><li> <em><strong>Dragora 1.0 Stable:</strong> March 13th, 2009 - &quot;starlight&quot;.</em>
  395. </li><li> <em><strong>Dragora 1.1 Release Candidate 1:</strong> August 25th, 2009.</em>
  396. </li><li> <em><strong>Dragora 1.1 Stable:</strong> October 8th, 2009 - &quot;stargazer&quot;.</em>
  397. </li><li> <em><strong>Dragora 2.0 Release Candidate 1:</strong> January 24th, 2010.</em>
  398. </li><li> <em><strong>Dragora 2.0 Release Candidate 2:</strong> March 28th, 2010.</em>
  399. </li><li> <em><strong>Dragora 2.0 Stable:</strong> April 13th, 2010 - &quot;ardi&quot;.</em>
  400. </li><li> <em><strong>Dragora 2.1 Release Candidate 1:</strong> December 4th, 2010.</em>
  401. </li><li> <em><strong>Dragora 2.1 Stable:</strong> December 31st, 2010 - &quot;dio&quot;.</em>
  402. </li><li> <em><strong>Dragora 2.2 Release Candidate 1:</strong> March 2nd, 2012.</em>
  403. </li><li> <em><strong>Dragora 2.2 Stable:</strong> April 21st, 2012 - &quot;rafaela&quot;.</em>
  404. </li><li> <em><strong>Dragora 3.0 Alpha 1:</strong> December 31st, 2017.</em>
  405. </li><li> <em><strong>Dragora 3.0 Alpha 2:</strong> September 28th, 2018.</em>
  406. </li><li> <em><strong>Dragora 3.0 Beta 1:</strong> October 16th, 2019.</em>
  407. </li></ul>
  408. <hr>
  409. <span id="Maintainers"></span><div class="header">
  410. <p>
  411. Next: <a href="#A-quick-glance-at-Dragora" accesskey="n" rel="next">A quick glance at Dragora</a>, Previous: <a href="#History" accesskey="p" rel="prev">History</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  412. </div>
  413. <span id="Maintainers-1"></span><h2 class="chapter">5 Maintainers</h2>
  414. <span id="index-maintainers"></span>
  415. <p>TODO.
  416. </p>
  417. <hr>
  418. <span id="A-quick-glance-at-Dragora"></span><div class="header">
  419. <p>
  420. Next: <a href="#Boot-options-from-live-medium" accesskey="n" rel="next">Boot options from live medium</a>, Previous: <a href="#Maintainers" accesskey="p" rel="prev">Maintainers</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  421. </div>
  422. <span id="A-quick-glance-at-Dragora-1"></span><h2 class="chapter">6 A quick glance at Dragora</h2>
  423. <span id="index-a-quick-glance-at-dragora"></span>
  424. <p>TODO.
  425. </p>
  426. <hr>
  427. <span id="Boot-options-from-live-medium"></span><div class="header">
  428. <p>
  429. Next: <a href="#Using-dragora_002dinstaller" accesskey="n" rel="next">Using dragora-installer</a>, Previous: <a href="#A-quick-glance-at-Dragora" accesskey="p" rel="prev">A quick glance at Dragora</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  430. </div>
  431. <span id="Boot-options-from-live-medium-1"></span><h2 class="chapter">7 Boot options from live medium</h2>
  432. <span id="index-boot-options-from-live-medium"></span>
  433. <p>TODO.
  434. </p>
  435. <hr>
  436. <span id="Using-dragora_002dinstaller"></span><div class="header">
  437. <p>
  438. Next: <a href="#Installing-the-system-manually-_0028as-an-alternative_0029" accesskey="n" rel="next">Installing the system manually (as an alternative)</a>, Previous: <a href="#Boot-options-from-live-medium" accesskey="p" rel="prev">Boot options from live medium</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  439. </div>
  440. <span id="Using-dragora_002dinstaller-1"></span><h2 class="chapter">8 Using dragora-installer</h2>
  441. <span id="index-using-dragora_002dinstaller"></span>
  442. <p>TODO.
  443. </p>
  444. <hr>
  445. <span id="Installing-the-system-manually-_0028as-an-alternative_0029"></span><div class="header">
  446. <p>
  447. Next: <a href="#Introduction-to-package-management-in-Dragora" accesskey="n" rel="next">Introduction to package management in Dragora</a>, Previous: <a href="#Using-dragora_002dinstaller" accesskey="p" rel="prev">Using dragora-installer</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  448. </div>
  449. <span id="Installing-the-system-manually-_0028as-an-alternative_0029-1"></span><h2 class="chapter">9 Installing the system manually (as an alternative)</h2>
  450. <span id="index-installing-the-system-manually-_0028as-an-alternative_0029"></span>
  451. <p>TODO.
  452. </p>
  453. <hr>
  454. <span id="Introduction-to-package-management-in-Dragora"></span><div class="header">
  455. <p>
  456. Next: <a href="#Package-management-in-a-nutshell" accesskey="n" rel="next">Package management in a nutshell</a>, Previous: <a href="#Installing-the-system-manually-_0028as-an-alternative_0029" accesskey="p" rel="prev">Installing the system manually (as an alternative)</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  457. </div>
  458. <span id="Introduction-to-package-management-in-Dragora-1"></span><h2 class="chapter">10 Introduction to package management in Dragora</h2>
  459. <span id="index-package-management-in-dragora"></span>
  460. <p>TODO.
  461. </p>
  462. <hr>
  463. <span id="Package-management-in-a-nutshell"></span><div class="header">
  464. <p>
  465. Next: <a href="#Using-third_002dparty-free-software" accesskey="n" rel="next">Using third-party free software</a>, Previous: <a href="#Introduction-to-package-management-in-Dragora" accesskey="p" rel="prev">Introduction to package management in Dragora</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  466. </div>
  467. <span id="Package-management-in-a-nutshell-1"></span><h2 class="chapter">11 Package management in a nutshell</h2>
  468. <span id="index-package-management-in-a-nutshell"></span>
  469. <p>TODO.
  470. </p>
  471. <hr>
  472. <span id="Using-third_002dparty-free-software"></span><div class="header">
  473. <p>
  474. Next: <a href="#Introduction-to-Qi" accesskey="n" rel="next">Introduction to Qi</a>, Previous: <a href="#Package-management-in-a-nutshell" accesskey="p" rel="prev">Package management in a nutshell</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  475. </div>
  476. <span id="Using-third_002dparty-free-software-1"></span><h2 class="unnumbered">Using third-party free software</h2>
  477. <span id="index-using-third_002dparty-free-software"></span>
  478. <p>TODO (appendix).
  479. </p>
  480. <hr>
  481. <span id="Introduction-to-Qi"></span><div class="header">
  482. <p>
  483. Next: <a href="#Invoking-qi" accesskey="n" rel="next">Invoking qi</a>, Previous: <a href="#Using-third_002dparty-free-software" accesskey="p" rel="prev">Using third-party free software</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  484. </div>
  485. <span id="Introduction-to-Qi-1"></span><h2 class="chapter">12 Introduction to Qi</h2>
  486. <span id="index-introduction-to-qi"></span>
  487. <p>Qi is a simple but well-integrated package manager. It can create,
  488. install, remove, and upgrade software packages. Qi produces binary
  489. packages using recipes, which are files containing specific instructions
  490. to build each package from source. Qi can manage multiple packages
  491. under a single directory hierarchy. This method allows to maintain a set
  492. of packages and multiple versions of them. This means that Qi could be
  493. used as the main package manager or complement the existing one.
  494. </p>
  495. <p>Qi offers a friendly command line interface, a global configuration
  496. file, a simple recipe layout to deploy software packages; also works
  497. with binary packages in parallel, speeding up installations and packages
  498. in production. The format used for packages is a simplified and safer
  499. variant of POSIX pax archive compressed in lzip format.
  500. </p>
  501. <p>Qi is a modern (POSIX-compliant) shell script released under the
  502. terms of the GNU General Public License. There are only two major
  503. dependencies for the magic: graft(1) and tarlz(1), the rest is expected
  504. to be found in any Unix-like system.
  505. </p>
  506. <hr>
  507. <span id="Invoking-qi"></span><div class="header">
  508. <p>
  509. 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>
  510. </div>
  511. <span id="Invoking-qi-1"></span><h2 class="chapter">13 Invoking qi</h2>
  512. <span id="index-invocation"></span>
  513. <p>This chapter describes the synopsis for invoking Qi.
  514. </p>
  515. <div class="example">
  516. <pre class="example">Usage: qi COMMAND [<var>OPTION</var>...] [<var>FILE</var>]...
  517. </pre></div>
  518. <p>One mandatory command specifies the operation that &lsquo;<samp>qi</samp>&rsquo; should
  519. perform, options are meant to detail how this operation should be
  520. performed during or after the process.
  521. </p>
  522. <p>Qi supports the following commands:
  523. </p>
  524. <dl compact="compact">
  525. <dt><code>warn</code></dt>
  526. <dd><p>Warn about files that will be installed.
  527. </p>
  528. </dd>
  529. <dt><code>install</code></dt>
  530. <dd><p>Install packages.
  531. </p>
  532. </dd>
  533. <dt><code>remove</code></dt>
  534. <dd><p>Remove packages.
  535. </p>
  536. </dd>
  537. <dt><code>upgrade</code></dt>
  538. <dd><p>Upgrade packages.
  539. </p>
  540. </dd>
  541. <dt><code>extract</code></dt>
  542. <dd><p>Extract packages for debugging purposes.
  543. </p>
  544. </dd>
  545. <dt><code>create</code></dt>
  546. <dd><p>Create a .tlz package from directory.
  547. </p>
  548. </dd>
  549. <dt><code>build</code></dt>
  550. <dd><p>Build packages using recipe names.
  551. </p>
  552. </dd>
  553. <dt><code>order</code></dt>
  554. <dd><p>Resolve build order through .order files
  555. </p></dd>
  556. </dl>
  557. <p>Options when installing, removing, or upgrading software packages:
  558. </p>
  559. <dl compact="compact">
  560. <dt><code>-f</code></dt>
  561. <dt><code>--force</code></dt>
  562. <dd><p>Force upgrade of pre-existing packages.
  563. </p>
  564. </dd>
  565. <dt><code>-k</code></dt>
  566. <dt><code>--keep</code></dt>
  567. <dd><p>Keep directories when build/remove/upgrade.
  568. </p>
  569. <p>Keep (don&rsquo;t delete) the package directory when using remove/upgrade command.
  570. </p>
  571. <p>This will also try to preserve the directories &lsquo;<samp>${srcdir}</samp>&rsquo; and
  572. &lsquo;<samp>${destdir}</samp>&rsquo; when using build command. Its effect is available in
  573. recipes as &lsquo;<samp>${keep_srcdir}</samp>&rsquo; and &lsquo;<samp>${keep_destdir}</samp>&rsquo;. See
  574. <a href="#Recipes">Special variables</a> for details.
  575. </p>
  576. </dd>
  577. <dt><code>-p</code></dt>
  578. <dt><code>--prune</code></dt>
  579. <dd><p>Prune conflicts.
  580. </p>
  581. </dd>
  582. <dt><code>-P</code></dt>
  583. <dt><code>--packagedir=&lt;dir&gt;</code></dt>
  584. <dd><p>Set directory for package installations.
  585. </p>
  586. </dd>
  587. <dt><code>-t</code></dt>
  588. <dt><code>--targetdir=&lt;dir&gt;</code></dt>
  589. <dd><p>Set target directory for symbolic links.
  590. </p>
  591. </dd>
  592. <dt><code>-r</code></dt>
  593. <dt><code>--rootdir=&lt;dir&gt;</code></dt>
  594. <dd><p>Use the fully qualified named directory as the root directory for all qi
  595. operations.
  596. </p>
  597. <p>Note: the target directory and the package directory will be
  598. relative to the specified directory, excepting the graft log file.
  599. </p></dd>
  600. </dl>
  601. <p>Options when building software packages using recipes:
  602. </p>
  603. <dl compact="compact">
  604. <dt><code>-a</code></dt>
  605. <dt><code>--architecture</code></dt>
  606. <dd><p>Set architecture name for the package.
  607. </p>
  608. </dd>
  609. <dt><code>-j</code></dt>
  610. <dt><code>--jobs</code></dt>
  611. <dd><p>Parallel jobs for the compiler.
  612. </p>
  613. <p>This option sets the variable &lsquo;<samp>${jobs}</samp>&rsquo;. If not specified, default
  614. sets to 1.
  615. </p>
  616. </dd>
  617. <dt><code>-S</code></dt>
  618. <dt><code>--skip-questions</code></dt>
  619. <dd><p>Skip questions on completed recipes.
  620. </p>
  621. </dd>
  622. <dt><code>-1</code></dt>
  623. <dt><code>--increment</code></dt>
  624. <dd><p>Increment release number (&lsquo;<samp>${release}</samp>&rsquo; + 1).
  625. </p>
  626. <p>The effect of this option will be omitted if &ndash;no-package is being used.
  627. </p>
  628. </dd>
  629. <dt><code>-n</code></dt>
  630. <dt><code>--no-package</code></dt>
  631. <dd><p>Do not create a .tlz package.
  632. </p>
  633. </dd>
  634. <dt><code>-i</code></dt>
  635. <dt><code>--install</code></dt>
  636. <dd><p>Install package after the build.
  637. </p>
  638. </dd>
  639. <dt><code>-u</code></dt>
  640. <dt><code>--upgrade</code></dt>
  641. <dd><p>Upgrade package after the build.
  642. </p>
  643. </dd>
  644. <dt><code>-o</code></dt>
  645. <dt><code>--outdir=&lt;dir&gt;</code></dt>
  646. <dd><p>Where the packages produced will be written.
  647. </p>
  648. <p>This option sets the variable &lsquo;<samp>${outdir}</samp>&rsquo;.
  649. </p>
  650. </dd>
  651. <dt><code>-w</code></dt>
  652. <dt><code>--worktree=&lt;dir&gt;</code></dt>
  653. <dd><p>Where archives, patches, recipes are expected.
  654. </p>
  655. <p>This option sets the variable &lsquo;<samp>${worktree}</samp>&rsquo;.
  656. </p>
  657. </dd>
  658. <dt><code>-s</code></dt>
  659. <dt><code>--sourcedir=&lt;dir&gt;</code></dt>
  660. <dd><p>Where compressed sources will be found.
  661. </p>
  662. <p>This option sets the variable &lsquo;<samp>${tardir}</samp>&rsquo;.
  663. </p></dd>
  664. </dl>
  665. <p>Other options:
  666. </p>
  667. <dl compact="compact">
  668. <dt><code>-v</code></dt>
  669. <dt><code>--verbose</code></dt>
  670. <dd><p>Be verbose (an extra -v gives more).
  671. </p>
  672. <p>It sets the verbosity level, default sets to 0.
  673. </p>
  674. <p>The value 1 is used for more verbosity while the value 2 is too detailed.
  675. Although at the moment it is limited to graft(1) verbosity.
  676. </p>
  677. </dd>
  678. <dt><code>-N</code></dt>
  679. <dt><code>--no-rc</code></dt>
  680. <dd><p>Do not read the configuration file.
  681. </p>
  682. <p>This will ignore reading the qirc file.
  683. </p>
  684. </dd>
  685. <dt><code>-L</code></dt>
  686. <dt><code>--show-location</code></dt>
  687. <dd><p>Print default directory locations and exit.
  688. </p>
  689. <p>This will print the target directory, package directory, working tree,
  690. the directory for sources, and the output directory for the packages
  691. produced. The output will appear on STDOUT as follows:
  692. </p>
  693. <div class="example">
  694. <pre class="example">QI_TARGETDIR=/usr/local
  695. QI_PACKAGEDIR=/usr/local/pkgs
  696. QI_WORKTREE=/usr/src/qi
  697. QI_TARDIR=/usr/src/qi/sources
  698. QI_OUTDIR=/var/cache/qi/packages
  699. </pre></div>
  700. <p>You can set these environment variables using one of the following methods:
  701. </p>
  702. <p><code>eval &quot;$(qi -L)&quot;</code>
  703. </p>
  704. <p>This will display the default locations taking into account the values set
  705. from the qirc configuration file. You can deny the influence of the
  706. configuration file by setting the option &lsquo;<samp>-N</samp>&rsquo;.
  707. </p>
  708. <p><code>eval &quot;$(qi -N -L)&quot;</code>
  709. </p>
  710. <p>Or you can adjust the new locations using the command-line options, e.g:
  711. </p>
  712. <p><code>eval &quot;$(qi -N --targetdir=/directory -L)&quot;</code>
  713. </p>
  714. </dd>
  715. <dt><code>-h</code></dt>
  716. <dt><code>--help</code></dt>
  717. <dd><p>Display the usage and exit.
  718. </p>
  719. </dd>
  720. <dt><code>-V</code></dt>
  721. <dt><code>--version</code></dt>
  722. <dd>
  723. <p>This will print the (short) version information and then exit.
  724. </p>
  725. <p>The same can be achieved if Qi is invoked as &lsquo;<samp>qi version</samp>&rsquo;.
  726. </p></dd>
  727. </dl>
  728. <p>When FILE is -, qi can read from the standard input. See examples from
  729. the <a href="#Packages">Packages</a> section.
  730. </p>
  731. <p>Exit status: 0 for a normal exit, 1 for minor common errors (help usage,
  732. support not available, etc), 2 to indicate a command execution error;
  733. 3 for integrity check error on compressed files, 4 for empty, not
  734. regular, or expected files, 5 for empty or not defined variables,
  735. 6 when a package already exist, 10 for network manager errors.
  736. For more details, see the <a href="#Qi-exit-status">Qi exit status</a> section.
  737. </p>
  738. <hr>
  739. <span id="The-qirc-file"></span><div class="header">
  740. <p>
  741. 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>
  742. </div>
  743. <span id="The-qirc-file-1"></span><h2 class="chapter">14 The qirc file</h2>
  744. <span id="index-configuration-file"></span>
  745. <p>The global <samp>qirc</samp> file offers a way to define variables and tools
  746. (such as a download manager) for default use. This file is used by qi
  747. at runtime, e.g., to build, install, remove or upgrade packages.
  748. </p>
  749. <p>Variables and their possible values must be declared as any other
  750. variable in the shell.
  751. </p>
  752. <p>The command line options related to the package directory and target
  753. directory and some of the command line options used for the build command,
  754. have the power to override the values declared on <samp>qirc</samp>.
  755. See <a href="#Invoking-qi">Invoking qi</a>.
  756. </p>
  757. <p>The order in which qi looks for this file is:
  758. </p>
  759. <ol>
  760. <li> <code>${HOME}/.qirc</code>
  761. Effective user.
  762. </li><li> &lsquo;<samp>${sysconfdir}/qirc</samp>&rsquo;
  763. System-wide.
  764. </li></ol>
  765. <p>If you intend to run qi as effective user, the file
  766. &lsquo;<samp>${sysconfdir}/qirc</samp>&rsquo; could be copied to <code>${HOME}/.qirc</code>
  767. setting the paths for &lsquo;<samp>${packagedir}</samp>&rsquo; and &lsquo;<samp>${targetdir}</samp>&rsquo;
  768. according to the <code>$HOME</code>.
  769. </p>
  770. <hr>
  771. <span id="Packages"></span><div class="header">
  772. <p>
  773. 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>
  774. </div>
  775. <span id="Packages-1"></span><h2 class="chapter">15 Packages</h2>
  776. <span id="index-managing-packages"></span>
  777. <p>A package is a suite of programs usually distributed in binary form
  778. which may also contain manual pages, documentation, or any other file
  779. associated to a specific software.
  780. </p>
  781. <p>The package format used by qi is a simplified POSIX pax archive
  782. compressed using lzip<a id="DOCF1" href="#FOOT1"><sup>1</sup></a>. The
  783. file extension for packages ends in &lsquo;<samp>.tlz</samp>&rsquo;.
  784. </p>
  785. <p>Both package installation and package de-installation are managed using
  786. two important (internal) variables: &lsquo;<samp>${packagedir}</samp>&rsquo; and
  787. &lsquo;<samp>${targetdir}</samp>&rsquo;, these values can be changed in the
  788. configuration file or via options.
  789. </p>
  790. <p>&lsquo;<samp>${packagedir}</samp>&rsquo; is a common directory tree where the package
  791. contents will be decompressed (will reside).
  792. </p>
  793. <p>&lsquo;<samp>${targetdir}</samp>&rsquo; is a target directory where the links will be
  794. made by graft(1) taking &lsquo;<samp>${packagedir}/package_name</samp>&rsquo; into account.
  795. </p>
  796. <p>Packages are installed in self-contained directory trees and symbolic
  797. links from a common area are made to the package files. This allows
  798. multiple versions of the same package to coexist on the same system.
  799. </p>
  800. <span id="Package-conflicts"></span><h3 class="section">15.1 Package conflicts</h3>
  801. <span id="index-package-conflicts"></span>
  802. <p>All the links to install or remove a package are handled by graft(1).
  803. Since multiple packages can be installed or removed at the same time,
  804. certain conflicts may arise between the packages.
  805. </p>
  806. <p>graft<a id="DOCF2" href="#FOOT2"><sup>2</sup></a>
  807. defines a CONFLICT as one of the following conditions:
  808. </p>
  809. <ul>
  810. <li> If the package object is a directory and the target object exists but is
  811. not a directory.
  812. </li><li> If the package object is not a directory and the target object exists
  813. and is not a symbolic link.
  814. </li><li> If the package object is not a directory and the target object exists
  815. and is a symbolic link to something other than the package object.
  816. </li></ul>
  817. <p>The default behavior of qi for an incoming package is to ABORT if a
  818. conflict arises. When a package is going to be deleted, qi tells to
  819. graft(1) to remove those parts that are not in conflict, leaving the
  820. links to the belonging package. This behavior can be forced if the
  821. &ndash;prune option is given.
  822. </p>
  823. <span id="Installing-packages"></span><h3 class="section">15.2 Installing packages</h3>
  824. <span id="index-package-installation"></span>
  825. <p>To install a single package, simply type:
  826. </p>
  827. <div class="example">
  828. <pre class="example">qi install coreutils_8.30_i586-1@tools.tlz
  829. </pre></div>
  830. <p>To install multiple packages at once, type:
  831. </p>
  832. <div class="example">
  833. <pre class="example">qi install gcc_8.3.0_i586-1@devel.tlz rafaela_2.2_i586-1@legacy.tlz ...
  834. </pre></div>
  835. <p>Warn about the files that will be linked:
  836. </p>
  837. <div class="example">
  838. <pre class="example">qi warn bash_5.0_i586-1@shells.tlz
  839. </pre></div>
  840. <p>This is to verify the content of a package before installing it.
  841. </p>
  842. <p>See the process of an installation:
  843. </p>
  844. <div class="example">
  845. <pre class="example">qi install --verbose mariana_3.0_i586-1@woman.tlz
  846. </pre></div>
  847. <p>A second &ndash;verbose or -v option gives more (very verbose).
  848. </p>
  849. <p>Installing package in a different location:
  850. </p>
  851. <div class="example">
  852. <pre class="example">qi install --rootdir=/media/floppy lzip_1.21_i586-1@compressors.tlz
  853. </pre></div>
  854. <p>Important: the &ndash;rootdir option assumes &lsquo;<samp>${targetdir}</samp>&rsquo; and
  855. &lsquo;<samp>${packagedir}</samp>&rsquo;. See the following example:
  856. </p>
  857. <div class="example">
  858. <pre class="example">qi install --rootdir=/home/selk lzip_1.21_i586-1@compressors.tlz
  859. </pre></div>
  860. <p>The content of &quot;lzip_1.21_i586-1@compressors.tlz&quot; will be decompressed
  861. into &lsquo;<samp>/home/selk/pkgs/lzip_1.21_i586-1@compressors</samp>&rsquo;.
  862. Assuming that the main binary for lzip is under
  863. &lsquo;<samp>/home/selk/pkgs/lzip_1.21_i586-1@compressors/usr/bin/</samp>&rsquo;
  864. the target for &quot;usr/bin&quot; will be created at &lsquo;<samp>/home/selk</samp>&rsquo;. Considering
  865. that you have exported the <code>PATH</code> as &lsquo;<samp>${HOME}/usr/bin</samp>&rsquo;, now the
  866. system is able to see the recent lzip command.
  867. </p>
  868. <p>Installing from a list of packages using standard input:
  869. </p>
  870. <div class="example">
  871. <pre class="example">qi install - &lt; PACKAGELIST.txt
  872. </pre></div>
  873. <p>Or in combination with another tool:
  874. </p><div class="example">
  875. <pre class="example">sort -u PACKAGELIST.txt | qi install -
  876. </pre></div>
  877. <p>The sort command will read and sorts the list of declared packages,
  878. while trying to have unique entries for each statement. The output
  879. produced is captured by Qi to install each package.
  880. </p>
  881. <p>An example of a list containing package names is:
  882. </p><div class="example">
  883. <pre class="example">/var/cache/qi/packages/amd64/tcl_8.6.9_amd64-1@devel.tlz
  884. /var/cache/qi/packages/amd64/tk_8.6.9.1_amd64-1@devel.tlz
  885. /var/cache/qi/packages/amd64/vala_0.42.3_amd64-1@devel.tlz
  886. </pre></div>
  887. <span id="Removing-packages"></span><h3 class="section">15.3 Removing packages</h3>
  888. <span id="index-package-de_002dinstallation"></span>
  889. <p>To remove a package, simply type:
  890. </p>
  891. <div class="example">
  892. <pre class="example">qi remove xz_5.2.4_i586-1@compressors.tlz
  893. </pre></div>
  894. <p>Remove command will match the package name using &lsquo;<samp>${packagedir}</samp>&rsquo; as
  895. prefix. For example, if the value of &lsquo;<samp>${packagedir}</samp>&rsquo; has been
  896. set to /usr/pkg, this will be equal to:
  897. </p>
  898. <div class="example">
  899. <pre class="example">qi remove /usr/pkg/xz_5.2.4_i586-1@compressors
  900. </pre></div>
  901. <p>Detailed output:
  902. </p>
  903. <div class="example">
  904. <pre class="example">qi remove --verbose /usr/pkg/xz_5.2.4_i586-1@compressors
  905. </pre></div>
  906. <p>A second &ndash;verbose or -v option gives more (very verbose).
  907. </p>
  908. <p>By default the remove command does not preserve a package directory after
  909. removing its links from &lsquo;<samp>${targetdir}</samp>&rsquo;, but this behavior can be
  910. changed if the &ndash;keep option is passed:
  911. </p>
  912. <div class="example">
  913. <pre class="example">qi remove --keep /usr/pkg/lzip_1.21_i586-1@compressors
  914. </pre></div>
  915. <p>This means that the links to the package can be reactivated, later:
  916. </p>
  917. <div class="example">
  918. <pre class="example">cd /usr/pkg &amp;&amp; graft -i lzip_1.21_i586-1@compressors
  919. </pre></div>
  920. <p>Removing package from a different location:
  921. </p>
  922. <div class="example">
  923. <pre class="example">qi remove --rootdir=/home/cthulhu xz_5.2.4_i586-1@compressors
  924. </pre></div>
  925. <p>Removing a package using standard input:
  926. </p>
  927. <div class="example">
  928. <pre class="example">echo vala_0.42.3_amd64-1@devel | qi remove -
  929. </pre></div>
  930. <p>This will match with the package directory.
  931. </p>
  932. <span id="Upgrading-packages"></span><h3 class="section">15.4 Upgrading packages</h3>
  933. <span id="index-package-upgrade"></span>
  934. <p>The upgrade command inherits the properties of the installation and removal
  935. process. To make sure that a package is updated, the package is installed
  936. in a temporary directory taking &lsquo;<samp>${packagedir}</samp>&rsquo; into account. Once
  937. the incoming package is pre-installed, qi can proceed to search and delete
  938. packages that have the same name (considered as previous ones). Finally,
  939. the package is re-installed at its final location and the temporary
  940. directory is removed.
  941. </p>
  942. <p>Since updating a package can be crucial and so to perform a successful
  943. upgrade, from start to finish, you will want to ignore some important
  944. system signals during the upgrade process, those signals are SIGHUP,
  945. SIGINT, SIGQUIT, SIGABRT, and SIGTERM.
  946. </p>
  947. <p>To upgrade a package, just type:
  948. </p>
  949. <div class="example">
  950. <pre class="example">qi upgrade gcc_9.0.1_i586-1@devel.tlz
  951. </pre></div>
  952. <p>This will proceed to upgrade &quot;gcc_9.0.1_i586-1@devel&quot; removing any other
  953. version of &quot;gcc&quot; (if any).
  954. </p>
  955. <p>If you want to keep the package directories of versions found during the
  956. upgrade process, just pass:
  957. </p>
  958. <div class="example">
  959. <pre class="example">qi upgrade --keep gcc_9.0.1_i586-1@devel.tlz
  960. </pre></div>
  961. <p>To see the upgrade process:
  962. </p>
  963. <div class="example">
  964. <pre class="example">qi upgrade --verbose gcc_9.0.1_i586-1@devel.tlz
  965. </pre></div>
  966. <p>A second &ndash;verbose or -v option gives more (very verbose).
  967. </p>
  968. <p>To force the upgrade of an existing package:
  969. </p>
  970. <div class="example">
  971. <pre class="example">qi upgrade --force gcc_9.0.1_i586-1@devel.tlz
  972. </pre></div>
  973. <span id="Package-blacklist"></span><h4 class="subsection">15.4.1 Package blacklist</h4>
  974. <span id="index-package-blacklist"></span>
  975. <p>To implement general package facilities, either to install, remove or
  976. maintain the hierarchy of packages in a clean manner, qi makes use of the
  977. pruning operation via graft(1) by default:
  978. </p>
  979. <p>There is a risk if those are crucial packages for the proper functioning
  980. of the system, because it implies the deactivation of symbolic from the
  981. target directory, <em>especially</em> when transitioning an incoming package
  982. into its final location during an upgrade.
  983. </p>
  984. <p>A blacklist of package names has been devised for the case where
  985. a user decides to upgrade all the packages in the system, or
  986. just the crucial ones, such as the C library.
  987. </p>
  988. <p>The blacklist is related to the upgrade command only, consists in installing
  989. a package instead of updating it or removing previous versions of it;
  990. the content of the package will be updated over the existing content at
  991. &lsquo;<samp>${packagedir}</samp>&rsquo;, while the existing links from
  992. &lsquo;<samp>${targetdir}</samp>&rsquo; will be preserved. A pruning of links will be
  993. carried out in order to re-link possible differences with the recent
  994. content, this helps to avoid leaving dead links in the target directory.
  995. </p>
  996. <p>Package names for the blacklist to be declared must be set from the
  997. configuration file. By default, it is declared using the package name,
  998. which is more than enough for critical system packages, but if you want to
  999. be more specific, you can declare a package using:
  1000. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}</samp>&rsquo; where
  1001. the package category is avoided for common matching. See
  1002. <a href="#Recipes">Special variables</a> for a description of these variables.
  1003. </p>
  1004. <hr>
  1005. <span id="Recipes"></span><div class="header">
  1006. <p>
  1007. 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>
  1008. </div>
  1009. <span id="Recipes-1"></span><h2 class="chapter">16 Recipes</h2>
  1010. <span id="index-recipes"></span>
  1011. <p>A recipe is a file telling qi what to do. Most often, the recipe tells
  1012. qi how to build a binary package from a source tarball.
  1013. </p>
  1014. <p>A recipe has two parts: a list of variable definitions and a list of
  1015. sections. By convention, the syntax of a section is:
  1016. </p>
  1017. <div class="example">
  1018. <pre class="example">section_name()
  1019. {
  1020. section lines
  1021. }
  1022. </pre></div>
  1023. <p>The section name is followed by parentheses, one newline and an opening
  1024. brace. The line finishing the section contains just a closing brace.
  1025. The section names or the function names currently recognized are
  1026. &lsquo;<samp>build</samp>&rsquo;.
  1027. </p>
  1028. <p>The &lsquo;<samp>build</samp>&rsquo; section (or <strong>shell function</strong>) is an augmented
  1029. shell script that contains the main instructions to build software
  1030. from source.
  1031. </p>
  1032. <p>If there are other functions defined by the packager, Qi detects them
  1033. for later execution.
  1034. </p>
  1035. <span id="Variables"></span><h3 class="section">16.1 Variables</h3>
  1036. <span id="index-variables"></span>
  1037. <p>A &quot;variable&quot; is a <strong>shell variable</strong> defined either in <samp>qirc</samp>
  1038. or in a recipe to represent a string of text, called the variable&rsquo;s
  1039. &quot;value&quot;. These values are substituted by explicit request in the
  1040. definitions of other variables or in calls to external commands.
  1041. </p>
  1042. <p>Variables can represent lists of file names, options to pass to
  1043. compilers, programs to run, directories to look in for source files,
  1044. directories to write output to, or anything else you can imagine.
  1045. </p>
  1046. <p>Definitions of variables in qi have four levels of precedence.
  1047. Options which define variables from the command-line override those
  1048. specified in the <samp>qirc</samp> file, while variables defined in the recipe
  1049. override those specified in <samp>qirc</samp>, taking priority over those
  1050. variables set by command-line options. Finally, the variables have
  1051. default values if they are not defined anywhere.
  1052. </p>
  1053. <p>Options that set variables through the command-line can only reference
  1054. variables defined in <samp>qirc</samp> and variables with default values.
  1055. </p>
  1056. <p>Definitions of variables in <samp>qirc</samp> can only reference variables
  1057. previously defined in <samp>qirc</samp> and variables with default values.
  1058. </p>
  1059. <p>Definitions of variables in the recipe can only reference variables
  1060. set by the command-line, variables previously defined in the recipe,
  1061. variables defined in <samp>qirc</samp>, and variables with default values.
  1062. </p>
  1063. <span id="Special-variables"></span><h3 class="section">16.2 Special variables</h3>
  1064. <span id="index-special-variables"></span>
  1065. <p>There are variables which can only be set using the command line options or
  1066. via <samp>qirc</samp>, there are other special variables which can be defined or
  1067. redefined in a recipe. See the following definitions:
  1068. </p>
  1069. <p>&lsquo;<samp>outdir</samp>&rsquo; is the directory where the packages produced are written.
  1070. This variable can be redefined per-recipe. Default sets to
  1071. &lsquo;<samp>/var/cache/qi/packages</samp>&rsquo;.
  1072. </p>
  1073. <p>&lsquo;<samp>worktree</samp>&rsquo; is the working tree where archives, patches, and recipes
  1074. are expected. This variable can not be redefined in the recipe. Default
  1075. sets to &lsquo;<samp>/usr/src/qi</samp>&rsquo;.
  1076. </p>
  1077. <p>&lsquo;<samp>tardir</samp>&rsquo; is defined in the recipe to the directory where the tarball
  1078. containing the source can be found. The full name of the tarball is
  1079. composed as &lsquo;<samp>${tardir}/$tarname</samp>&rsquo;. Its value is available in the
  1080. recipe as &lsquo;<samp>${tardir}</samp>&rsquo;; a value of . for &lsquo;<samp>tardir</samp>&rsquo; sets it to
  1081. the value of CWD (Current Working Directory), this is where the recipe
  1082. lives.
  1083. </p>
  1084. <p>&lsquo;<samp>arch</samp>&rsquo; is the architecture to compose the package name. Its value is
  1085. available in the recipe as &lsquo;<samp>${arch}</samp>&rsquo;. Default value is the one
  1086. that was set in the Qi configuration.
  1087. </p>
  1088. <p>&lsquo;<samp>jobs</samp>&rsquo; is the number of parallel jobs to pass to the compiler. Its
  1089. value is available in the recipe as &lsquo;<samp>${jobs}</samp>&rsquo;. The default value
  1090. is 1.
  1091. </p>
  1092. <p>The two variables &lsquo;<samp>${srcdir}</samp>&rsquo; and &lsquo;<samp>${destdir}</samp>&rsquo; can be
  1093. set in the recipe, as any other variable, but if they are not, qi uses
  1094. default values for them when building a package.
  1095. </p>
  1096. <p>&lsquo;<samp>srcdir</samp>&rsquo; contains the source code to be compiled, and defaults to
  1097. &lsquo;<samp>${program}-${version}</samp>&rsquo;. &lsquo;<samp>destdir</samp>&rsquo; is the place where the
  1098. built package will be installed, and defaults to
  1099. &lsquo;<samp>${TMPDIR}/package-${program}</samp>&rsquo;.
  1100. </p>
  1101. <p>If &lsquo;<samp>pkgname</samp>&rsquo; is left undefined, the special variable &lsquo;<samp>program</samp>&rsquo;
  1102. is assigned by default. If &lsquo;<samp>pkgversion</samp>&rsquo; is left undefined, the
  1103. special variable &lsquo;<samp>version</samp>&rsquo; is assigned by default.
  1104. </p>
  1105. <p>&lsquo;<samp>pkgname</samp>&rsquo; and &lsquo;<samp>pkgversion</samp>&rsquo; along with: &lsquo;<samp>version</samp>&rsquo;, &lsquo;<samp>arch</samp>&rsquo;,
  1106. &lsquo;<samp>release</samp>&rsquo;, and (optionally) &lsquo;<samp>pkgcategory</samp>&rsquo; are used to produce the
  1107. package name in the form:
  1108. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}[@${pkgcategory}].tlz</samp>&rsquo;
  1109. </p>
  1110. <p>&lsquo;<samp>pkgcategory</samp>&rsquo; is an optional special variable that can be defined on the
  1111. recipe to categorize the package name. If it is defined, then the
  1112. package output will be composed as
  1113. &lsquo;<samp>${pkgname}_${pkgversion}_${arch}-${release}[@${pkgcategory}.tlz</samp>&rsquo;.
  1114. Automatically, the value of &lsquo;<samp>pkgcategory</samp>&rsquo; will be prefixed using the
  1115. &lsquo;<samp>@</samp>&rsquo; (at) symbol which will be added to the last part of the package name.
  1116. </p>
  1117. <p>A special variable called &lsquo;<samp>replace</samp>&rsquo; can be used to declare package names
  1118. that will be replaced at installation time.
  1119. </p>
  1120. <p>The special variables &lsquo;<samp>keep_srcdir</samp>&rsquo; and &lsquo;<samp>keep_destdir</samp>&rsquo; are provided
  1121. in order to preserve the directories &lsquo;<samp>${srcdir}</samp>&rsquo; or &lsquo;<samp>${destdir}</samp>&rsquo;,
  1122. if those exists as such. Note: The declaration of these variables are subject
  1123. to manual deactivation; its purpose in recipes is to preserve the directories
  1124. that relate to the package&rsquo;s build (source) and destination directory, that is
  1125. so that another recipe can get a new package (or meta package) from there. For
  1126. example, the declarations can be done as:
  1127. </p>
  1128. <div class="example">
  1129. <pre class="example">keep_srcdir=keep_srcdir
  1130. keep_destdir=keep_destdir
  1131. </pre></div>
  1132. <p>Then from another recipe you would proceed to copy the necessary files that
  1133. will compose the meta package, from the main function you must deactivate
  1134. the variables at the end:
  1135. </p>
  1136. <div class="example">
  1137. <pre class="example">unset -v keep_srcdir keep_destdir
  1138. </pre></div>
  1139. <p>This will leave the &rsquo;keep_srcdir&rsquo; and &rsquo;keep_destdir&rsquo; variables blank to
  1140. continue with the rest of the recipes.
  1141. </p>
  1142. <p>The special variable &lsquo;<samp>opt_skiprecipe</samp>&rsquo; is available when you need to
  1143. ignore a recipe cleanly, continuing with the next recipe. May you add a
  1144. conditional test then set it as &lsquo;<samp>opt_skiprecipe=opt_skiprecipe</samp>&rsquo;.
  1145. </p>
  1146. <p>The variable &lsquo;<samp>tarlz_compression_options</samp>&rsquo; can be used to change the
  1147. default compression options in tarlz(1), default sets to &lsquo;<samp>-9 --solid</samp>&rsquo;.
  1148. For example if the variable is declared as:
  1149. </p>
  1150. <div class="example">
  1151. <pre class="example">tarlz_compression_options=&quot;-0 --bsolid&quot;
  1152. </pre></div>
  1153. <p>It will change the granularity of tarlz(1) by using the &lsquo;<samp>--bsolid</samp>&rsquo;
  1154. option <a id="DOCF3" href="#FOOT3"><sup>3</sup></a>,
  1155. as well as increasing the compression speed by lowering the compression
  1156. level with &lsquo;<samp>-0</samp>&rsquo;.
  1157. </p>
  1158. <p>This is only recommended for recipes where testing, or faster processing is
  1159. desired to create the packaged file more quickly. It is not recommended for
  1160. production or general distribution of binary packages.
  1161. </p>
  1162. <p>A typical recipe contains the following variables:
  1163. </p>
  1164. <ul>
  1165. <li> &lsquo;<samp>program</samp>&rsquo;: Software name.
  1166. <p>It matches the source name. It is also used to compose the name of the
  1167. package if &lsquo;<samp>${pkgname}</samp>&rsquo; is not specified.
  1168. </p>
  1169. </li><li> &lsquo;<samp>version</samp>&rsquo;: Software version.
  1170. <p>It matches the source name. It is also used to compose the version of the
  1171. package if &lsquo;<samp>${pkgversion}</samp>&rsquo; is not specified.
  1172. </p>
  1173. </li><li> &lsquo;<samp>arch</samp>&rsquo;: Software architecture.
  1174. <p>It is used to compose the architecture of the package in which it is
  1175. build.
  1176. </p>
  1177. </li><li> &lsquo;<samp>release</samp>&rsquo;: Release number.
  1178. <p>This is used to reflect the release number of the package. It is
  1179. recommended to increase this number after any significant change in
  1180. the recipe or post-install script.
  1181. </p>
  1182. </li><li> &lsquo;<samp>pkgcategory</samp>&rsquo;: Package category.
  1183. <p>Optional but recommended variable to categorize the package name when it is
  1184. created.
  1185. </p></li></ul>
  1186. <p>Obtaining sources over the network must be declared in the recipe using
  1187. the &lsquo;<samp>fetch</samp>&rsquo; variable.
  1188. </p>
  1189. <p>The variables &lsquo;<samp>netget</samp>&rsquo; and &lsquo;<samp>rsync</samp>&rsquo; can be defined in <samp>qirc</samp>
  1190. to establish a network downloader in order to get the sources. If they
  1191. are not defined, qi uses default values:
  1192. </p>
  1193. <p>&lsquo;<samp>netget</samp>&rsquo; is the general network downloader tool, defaults sets to
  1194. &lsquo;<samp>wget2 -c -w1 -t3 --no-check-certificate</samp>&rsquo;.
  1195. </p>
  1196. <p>&lsquo;<samp>rsync</samp>&rsquo; is the network tool for sources containing the prefix for
  1197. the RSYNC protocol, default sets to
  1198. &lsquo;<samp>rsync -v -a -L -z -i --progress</samp>&rsquo;.
  1199. </p>
  1200. <p>The variable &lsquo;<samp>description</samp>&rsquo; is used to print the package description
  1201. when a package is installed.
  1202. </p>
  1203. <p>A description has two parts: a brief description, and a long description.
  1204. By convention, the syntax of &lsquo;<samp>description</samp>&rsquo; is:
  1205. </p>
  1206. <div class="example">
  1207. <pre class="example">description=&quot;
  1208. Brief description.
  1209. Long description.
  1210. &quot;
  1211. </pre></div>
  1212. <p>The first line of the value represented is a brief description of the
  1213. software (called &quot;blurb&quot;). A blank line separates the <em>brief
  1214. description</em> from the <em>long description</em>, which should contain a more
  1215. descriptive description of the software.
  1216. </p>
  1217. <p>An example looks like:
  1218. </p>
  1219. <div class="example">
  1220. <pre class="example">description=&quot;
  1221. The GNU core utilities.
  1222. The GNU core utilities are the basic file, shell and text manipulation
  1223. utilities of the GNU operating system. These are the core utilities
  1224. which are expected to exist on every operating system.
  1225. &quot;
  1226. </pre></div>
  1227. <p>Please consider a length limit of 78 characters as maximum, because the same
  1228. one would be used on the meta file creation. See
  1229. <a href="#Recipes">The meta file</a> section.
  1230. </p>
  1231. <p>The &lsquo;<samp>homepage</samp>&rsquo; variable is used to declare the main site or home page:
  1232. </p>
  1233. <div class="example">
  1234. <pre class="example">homepage=https://www.gnu.org/software/gcc
  1235. </pre></div>
  1236. <p>The variable &lsquo;<samp>license</samp>&rsquo; is used for license information<a id="DOCF4" href="#FOOT4"><sup>4</sup></a>.
  1237. Some code in the program can be covered by license A, license B, or
  1238. license C. For &quot;separate licensing&quot; or &quot;heterogeneous licensing&quot;, we
  1239. suggest using <strong>|</strong> for a disjunction, <strong>&amp;</strong> for a conjunction
  1240. (if that ever happens in a significant way), and comma for heterogeneous
  1241. licensing. Comma would have lower precedence, plus added special terms.
  1242. </p>
  1243. <div class="example">
  1244. <pre class="example">license=&quot;LGPL, GPL | Artistic - added permission&quot;
  1245. </pre></div>
  1246. <span id="Writing-recipes"></span><h3 class="section">16.3 Writing recipes</h3>
  1247. <span id="index-writing-recipes"></span>
  1248. <p>Originally, Qi was designed for the series of Dragora GNU/Linux-Libre 3;
  1249. this doesn&rsquo;t mean you can&rsquo;t use it in another distribution, just that if
  1250. you do, you&rsquo;ll have to try it out for yourself. To help with this, here
  1251. are some references to well-written recipes:
  1252. </p>
  1253. <ul>
  1254. <li> <a href="https://git.savannah.nongnu.org/cgit/dragora.git/tree/recipes">https://git.savannah.nongnu.org/cgit/dragora.git/tree/recipes</a>
  1255. </li><li> <a href="https://notabug.org/dragora/dragora/src/master/recipes">https://notabug.org/dragora/dragora/src/master/recipes</a>
  1256. </li><li> <a href="https://notabug.org/dragora/dragora-extras/src/master/recipes">https://notabug.org/dragora/dragora-extras/src/master/recipes</a>
  1257. </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>
  1258. </li></ul>
  1259. <span id="Building-packages"></span><h3 class="section">16.4 Building packages</h3>
  1260. <span id="index-package-build"></span>
  1261. <p>A recipe is any valid regular file. Qi sets priorities for reading a
  1262. recipe, the order in which qi looks for a recipe is:
  1263. </p>
  1264. <ol>
  1265. <li> Current working directory.
  1266. </li><li> If the specified path name does not contain &quot;recipe&quot; as the last
  1267. component. Qi will complete it by adding &quot;recipe&quot; to the path name.
  1268. </li><li> If the recipe is not in the current working directory, it will be
  1269. searched under &lsquo;<samp>${worktree}/recipes</samp>&rsquo;. The last component will be
  1270. completed adding &quot;recipe&quot; to the specified path name.
  1271. </li></ol>
  1272. <p>To build a single package, type:
  1273. </p>
  1274. <div class="example">
  1275. <pre class="example">qi build x-apps/xterm
  1276. </pre></div>
  1277. <p>Multiple jobs can be passed to the compiler to speed up the build process:
  1278. </p>
  1279. <div class="example">
  1280. <pre class="example">qi build --jobs 3 x-apps/xterm
  1281. </pre></div>
  1282. <p>Update or install the produced package (if not already installed) when the
  1283. build command ends:
  1284. </p>
  1285. <div class="example">
  1286. <pre class="example">qi build -j3 --upgrade x-apps/xterm
  1287. </pre></div>
  1288. <p>Only process a recipe but do not create the binary package:
  1289. </p>
  1290. <div class="example">
  1291. <pre class="example">qi build --no-package dict/aspell
  1292. </pre></div>
  1293. <p>The options &ndash;install or &ndash;upgrade have no effect when &ndash;no-package
  1294. is given.
  1295. </p>
  1296. <p>This is useful to inspect the build process of the above recipe:
  1297. </p>
  1298. <p>qi build &ndash;keep &ndash;no-package dict/aspell 2&gt;&amp;1 | tee aspell-log.txt
  1299. </p>
  1300. <p>The &ndash;keep option could preserve the source directory and the destination
  1301. directory for later inspection. A log file of the build process will be
  1302. created redirecting both, standard error and standard output to tee(1).
  1303. </p>
  1304. <span id="Variables-from-the-environment"></span><h3 class="section">16.5 Variables from the environment</h3>
  1305. <span id="index-environment-variables"></span>
  1306. <p>Qi has environment variables which can be used at build time:
  1307. </p>
  1308. <p>The variable <code>TMPDIR</code> sets the temporary directory for sources, which is
  1309. used for package extractions (see <a href="#Examining-packages">Examining packages</a>) and is
  1310. prepended to the value of &lsquo;<samp>${srcdir}</samp>&rsquo; and &lsquo;<samp>${destdir}</samp>&rsquo; in
  1311. build command. By convention its default value is equal to
  1312. &lsquo;<samp>/usr/src/qi/build</samp>&rsquo;.
  1313. </p>
  1314. <p>The variables <code>QICFLAGS</code>, <code>QICXXFLAGS</code>, <code>QILDFLAGS</code>, and
  1315. <code>QICPPFLAGS</code> have no effect by default. The environment variables
  1316. such as <code>CFLAGS</code>, <code>CXXFLAGS</code>, <code>LDFLAGS</code>, and <code>CPPFLAGS</code>
  1317. are unset at compile time:
  1318. </p>
  1319. <p>Recommended practice is to set variables in the command line of
  1320. &lsquo;<samp>configure</samp>&rsquo; or <em>make(1)</em> instead of exporting to the
  1321. environment. As follows:
  1322. </p>
  1323. <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>
  1324. </p><blockquote>
  1325. <p>It is not wise for makefiles to depend for their functioning on environment
  1326. variables set up outside their control, since this would cause different
  1327. users to get different results from the same makefile. This is against the
  1328. whole purpose of most makefiles.
  1329. </p></blockquote>
  1330. <p>Setting environment variables for configure is deprecated because running
  1331. configure in varying environments can be dangerous.
  1332. </p>
  1333. <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>
  1334. </p><blockquote>
  1335. <p>Variables not defined in a site shell script can be set in the environment
  1336. passed to configure. However, some packages may run configure again
  1337. during the build, and the customized values of these variables may be
  1338. lost. In order to avoid this problem, you should set them in the
  1339. configure command line, using &lsquo;<samp>VAR=value</samp>&rsquo;. For example:
  1340. </p>
  1341. <p><code>./configure CC=/usr/local2/bin/gcc</code>
  1342. </p></blockquote>
  1343. <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>
  1344. </p><blockquote>
  1345. <p>If for instance the user runs &lsquo;<samp>CC=bizarre-cc ./configure</samp>&rsquo;, then the cache,
  1346. config.h, and many other output files depend upon bizarre-cc being the C
  1347. compiler. If for some reason the user runs ./configure again, or if it is
  1348. run via &lsquo;<samp>./config.status --recheck</samp>&rsquo;, (See Automatic Remaking, and see
  1349. config.status Invocation), then the configuration can be inconsistent,
  1350. composed of results depending upon two different compilers.
  1351. [...]
  1352. Indeed, while configure can notice the definition of CC in &lsquo;<samp>./configure
  1353. CC=bizarre-cc</samp>&rsquo;, it is impossible to notice it in &lsquo;<samp>CC=bizarre-cc
  1354. ./configure</samp>&rsquo;, which, unfortunately, is what most users do.
  1355. [...]
  1356. configure: error: changes in the environment can compromise the build.
  1357. </p></blockquote>
  1358. <p>If the <code>SOURCE_DATE_EPOCH</code> environment variable is set to a UNIX timestamp
  1359. (defined as the number of seconds, excluding leap seconds, since 01 Jan 1970
  1360. 00:00:00 UTC.); then the given timestamp will be used to overwrite any newer
  1361. timestamps on the package contents (when it is created). More information
  1362. about this can be found at
  1363. <a href="https://reproducible-builds.org/specs/source-date-epoch/">https://reproducible-builds.org/specs/source-date-epoch/</a>.
  1364. </p>
  1365. <span id="The-meta-file"></span><h3 class="section">16.6 The meta file</h3>
  1366. <span id="index-the-meta-file"></span>
  1367. <p>The &quot;meta file&quot; is a regular file created during the build process, it
  1368. contains information about the package such as package name, package
  1369. version, architecture, release, fetch address, description, and other
  1370. minor data extracted from processed recipes. The name of the file is
  1371. generated as &lsquo;<samp>${full_pkgname}.tlz.txt</samp>&rsquo;, and its purpose is to
  1372. reflect essential information to the user without having to look inside
  1373. the package content. The file format is also intended to be used by
  1374. other scripts or by common Unix tools.
  1375. </p>
  1376. <p>The content of a meta file looks like:
  1377. </p>
  1378. <div class="example">
  1379. <pre class="example">#
  1380. # Pattern scanning and processing language.
  1381. #
  1382. # The awk utility interprets a special-purpose programming language
  1383. # that makes it possible to handle simple data-reformatting jobs
  1384. # with just a few lines of code. It is a free version of 'awk'.
  1385. #
  1386. # GNU awk implements the AWK utility which is part of
  1387. # IEEE Std 1003.1 Shell and Utilities (XCU).
  1388. #
  1389. QICFLAGS=&quot;-O2&quot;
  1390. QICXXFLAGS=&quot;-O2&quot;
  1391. QILDFLAGS=&quot;&quot;
  1392. QICPPFLAGS=&quot;&quot;
  1393. pkgname=gawk
  1394. pkgversion=5.0.1
  1395. arch=amd64
  1396. release=1
  1397. pkgcategory=&quot;tools&quot;
  1398. full_pkgname=gawk_5.0.1_amd64-1@tools
  1399. blurb=&quot;Pattern scanning and processing language.&quot;
  1400. homepage=&quot;https://www.gnu.org/software/gawk&quot;
  1401. license=&quot;GPLv3+&quot;
  1402. fetch=&quot;https://ftp.gnu.org/gnu/gawk/gawk-5.0.1.tar.lz&quot;
  1403. replace=&quot;&quot;
  1404. </pre></div>
  1405. <p>A package descriptions is extracted from the variable &lsquo;<samp>description</samp>&rsquo;
  1406. where each line is interpreted literally and pre-formatted to fit in
  1407. (exactly) <strong>80 columns</strong>, plus the character &lsquo;<samp>#</samp>&rsquo; and a blank
  1408. space is prefixed to every line (shell comments).
  1409. </p>
  1410. <p>In addition to the Special variables, there are implicit variables such as
  1411. &lsquo;<samp>blurb</samp>&rsquo;:
  1412. </p>
  1413. <p>The &lsquo;<samp>blurb</samp>&rsquo; variable is related to the special variable
  1414. &lsquo;<samp>description</samp>&rsquo;. Its value is made from the first (substantial)
  1415. line of &lsquo;<samp>description</samp>&rsquo;, mentioned as the &quot;brief description&quot;.
  1416. </p>
  1417. <p>The build flags such as &lsquo;<samp>QICFLAGS</samp>&rsquo;, &lsquo;<samp>QICXXFLAGS</samp>&rsquo;,
  1418. &lsquo;<samp>QILDFLAGS</samp>&rsquo;, and &lsquo;<samp>QICPPFLAGS</samp>&rsquo; are only added to the meta file
  1419. if the declared variable &lsquo;<samp>arch</samp>&rsquo; is not equal to the &quot;noarch&quot; value.
  1420. </p>
  1421. <hr>
  1422. <span id="Order-files"></span><div class="header">
  1423. <p>
  1424. 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>
  1425. </div>
  1426. <span id="Order-files-1"></span><h2 class="chapter">17 Order files</h2>
  1427. <span id="index-handling-build-order"></span>
  1428. <p>The order command has the purpose of resolving the build order through
  1429. .order files. An order file contains a list of recipe names, by default
  1430. does not perform any action other than to print a resolved list in
  1431. descending order. For example, if <strong>a</strong> depends on <strong>b</strong> and
  1432. <strong>c</strong>, and <strong>c</strong> depends on <strong>b</strong> as well, the file might
  1433. look like:
  1434. </p>
  1435. <div class="example">
  1436. <pre class="example">a: c b
  1437. b:
  1438. c: b
  1439. </pre></div>
  1440. <p>Each letter represents a recipe name, complete dependencies for
  1441. the first recipe name are listed in descending order, which is
  1442. printed from right to left, and removed from left to right:
  1443. </p>
  1444. <p><small>OUTPUT</small>
  1445. </p>
  1446. <div class="example">
  1447. <pre class="example">b
  1448. c
  1449. a
  1450. </pre></div>
  1451. <p>Blank lines, colons and parentheses are simply ignored. Comment lines
  1452. beginning with &lsquo;<samp>#</samp>&rsquo; are allowed.
  1453. </p>
  1454. <p>An order file could be used to build a series of packages, for example,
  1455. if the content is:
  1456. </p>
  1457. <div class="example">
  1458. <pre class="example"># Image handling libraries
  1459. libs/libjpeg-turbo: devel/nasm
  1460. x-libs/jasper: libs/libjpeg-turbo
  1461. libs/tiff: libs/libjpeg-turbo
  1462. </pre></div>
  1463. <p>To proceed with each recipe, we can type:
  1464. </p>
  1465. <div class="example">
  1466. <pre class="example">qi order imglibs.order | qi build --install -
  1467. </pre></div>
  1468. <p>The output of &lsquo;<samp>qi order imglibs.order</samp>&rsquo; tells to qi in which order it
  1469. should build the recipes:
  1470. </p>
  1471. <div class="example">
  1472. <pre class="example">devel/nasm
  1473. libs/libjpeg-turbo
  1474. x-libs/jasper
  1475. libs/tiff
  1476. </pre></div>
  1477. <hr>
  1478. <span id="Creating-packages"></span><div class="header">
  1479. <p>
  1480. 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>
  1481. </div>
  1482. <span id="Creating-packages-1"></span><h2 class="chapter">18 Creating packages</h2>
  1483. <span id="index-package-creation"></span>
  1484. <p>The creation command is an internal function of qi to make new Qi
  1485. compatible packages. A package is produced using the contents of
  1486. the Current Working Directory and the package file is written out.
  1487. </p>
  1488. <div class="example">
  1489. <pre class="example">Usage: qi create [<var>Output/PackageName.tlz</var>]...
  1490. </pre></div>
  1491. <p>The argument for the file name to be written must contain a fully
  1492. qualified named directory as the output directory where the package
  1493. produced will be written. The file name should be composed using the
  1494. full name: name-version-architecture-release[@pkgcategory].tlz
  1495. </p>
  1496. <p><small>EXAMPLE</small>
  1497. </p>
  1498. <div class="example">
  1499. <pre class="example">cd /usr/pkg
  1500. cd claws-mail_3.17.1_amd64-1@x-apps
  1501. qi create /var/cache/qi/packages/claws-mail_3.17.1_amd64-1@x-apps
  1502. </pre></div>
  1503. <p>In this case, the package &quot;claws-mail_3.17.1_amd64-1@x-apps&quot; will be
  1504. written into &lsquo;<samp>/var/cache/qi/packages/</samp>&rsquo;.
  1505. </p>
  1506. <p>All packages produced are complemented by a checksum file (.sha256).
  1507. </p>
  1508. <hr>
  1509. <span id="Examining-packages"></span><div class="header">
  1510. <p>
  1511. 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>
  1512. </div>
  1513. <span id="Examining-packages-1"></span><h2 class="chapter">19 Examining packages</h2>
  1514. <span id="index-package-examination"></span>
  1515. <p>The extraction command serves to examine binary packages for debugging
  1516. purposes. It decompresses a package into a single directory, verifying
  1517. its integrity and preserving all of its properties (owner and permissions).
  1518. </p>
  1519. <div class="example">
  1520. <pre class="example">Usage: qi extract [<var>packagename.tlz</var>]...
  1521. </pre></div>
  1522. <p><small>EXAMPLE</small>
  1523. </p>
  1524. <div class="example">
  1525. <pre class="example">qi extract mksh_R56c_amd64-1@shells.tlz
  1526. </pre></div>
  1527. <p>This action will put the content of &quot;mksh_R56c_amd64-1@shells.tlz&quot; into a
  1528. single directory, this is a private directory for the user who requested
  1529. the action, creation operation will be equal to <strong>u=rwx,g=,o= (0700)</strong>.
  1530. The package content will reside on this location, default mask to deploy
  1531. the content will be equal to <strong>u=rwx,g=rwx,o=rwx (0000)</strong>.
  1532. </p>
  1533. <p>Note: the creation of the custom directory is influenced by the value
  1534. of the <code>TMPDIR</code> variable.
  1535. </p>
  1536. <hr>
  1537. <span id="Qi-exit-status"></span><div class="header">
  1538. <p>
  1539. Next: <a href="#Getting-support" accesskey="n" rel="next">Getting support</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>
  1540. </div>
  1541. <span id="Qi-exit-status-1"></span><h2 class="chapter">20 Qi exit status</h2>
  1542. <span id="index-exit-codes"></span>
  1543. <p>All the exit codes are described in this chapter.
  1544. </p>
  1545. <dl compact="compact">
  1546. <dt>&lsquo;<samp>0</samp>&rsquo;</dt>
  1547. <dd><p>Successful completion (no errors).
  1548. </p>
  1549. </dd>
  1550. <dt>&lsquo;<samp>1</samp>&rsquo;</dt>
  1551. <dd><p>Minor common errors:
  1552. </p>
  1553. <ul>
  1554. <li> Help usage on invalid options or required arguments.
  1555. </li><li> Program needed by qi (prerequisite) is not available.
  1556. </li></ul>
  1557. </dd>
  1558. <dt>&lsquo;<samp>2</samp>&rsquo;</dt>
  1559. <dd><p>Command execution error:
  1560. </p>
  1561. <p>This code is used to return the evaluation of an external command or shell
  1562. arguments in case of failure.
  1563. </p>
  1564. </dd>
  1565. <dt>&lsquo;<samp>3</samp>&rsquo;</dt>
  1566. <dd><p>Integrity check error for compressed files.
  1567. </p>
  1568. <p>Compressed files means:
  1569. </p>
  1570. <ul>
  1571. <li> A tarball file from tar(1), typically handled by the GNU tar implementation.
  1572. Supported extensions: .tar, .tar.gz, .tgz, .tar.Z, .tar.bz2, .tbz2, .tbz,
  1573. .tar.xz, .txz, .tar.zst, .tzst
  1574. </li><li> A tarball file from tarlz(1).
  1575. Supported extensions: .tar.lz, .tlz
  1576. </li><li> Zip files from unzip(1).
  1577. Supported extensions: .zip, .ZIP
  1578. </li><li> Gzip files from gzip(1).
  1579. Supported extensions: .gz, .Z
  1580. </li><li> Bzip2 files from bzip2(1).
  1581. Supported extension: .bz2
  1582. </li><li> Lzip files from lzip(1).
  1583. Supported extension: .lz
  1584. </li><li> Xz files from xz(1).
  1585. Supported extension: .xz
  1586. </li><li> Zstd files from zstd(1).
  1587. Supported extension: .zst
  1588. </li></ul>
  1589. </dd>
  1590. <dt>&lsquo;<samp>4</samp>&rsquo;</dt>
  1591. <dd><p>File empty, not regular, or expected.
  1592. </p>
  1593. <p>It&rsquo;s commonly expected:
  1594. </p>
  1595. <ul>
  1596. <li> An argument for giving commands.
  1597. </li><li> A regular file or readable directory.
  1598. </li><li> An expected extension: .tlz, .sha256, .order.
  1599. </li><li> A protocol supported by the network downloader tool.
  1600. </li></ul>
  1601. </dd>
  1602. <dt>&lsquo;<samp>5</samp>&rsquo;</dt>
  1603. <dd><p>Empty or not defined variable:
  1604. </p>
  1605. <p>This code is used to report empty or undefined variables (usually
  1606. variables coming from a recipe or assigned arrays that are tested).
  1607. </p>
  1608. </dd>
  1609. <dt>&lsquo;<samp>6</samp>&rsquo;</dt>
  1610. <dd><p>Package already installed:
  1611. </p>
  1612. <p>The package directory for an incoming .tlz package already exists.
  1613. </p>
  1614. </dd>
  1615. <dt>&lsquo;<samp>10</samp>&rsquo;</dt>
  1616. <dd><p>Network manager error:
  1617. </p>
  1618. <p>This code is used if the network downloader tool fails for some reason.
  1619. </p></dd>
  1620. </dl>
  1621. <hr>
  1622. <span id="Getting-support"></span><div class="header">
  1623. <p>
  1624. Next: <a href="#Contributing-to-Dragora" accesskey="n" rel="next">Contributing to Dragora</a>, 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>
  1625. </div>
  1626. <span id="Getting-support-1"></span><h2 class="chapter">21 Getting support</h2>
  1627. <span id="index-getting-support"></span>
  1628. <p>Dragora&rsquo;s home page can be found at <a href="https://www.dragora.org">https://www.dragora.org</a>.
  1629. &nbsp;Bug reports or suggestions can be sent to <a href="mailto:dragora-users@nongnu.org">dragora-users@nongnu.org</a>.
  1630. </p>
  1631. <hr>
  1632. <span id="Contributing-to-Dragora"></span><div class="header">
  1633. <p>
  1634. Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="#Getting-support" accesskey="p" rel="prev">Getting support</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1635. </div>
  1636. <span id="Contributing-to-Dragora-1"></span><h2 class="chapter">22 Contributing to Dragora</h2>
  1637. <span id="index-contributing-to-dragora"></span>
  1638. <p>TODO (introductory text here).
  1639. </p>
  1640. <span id="How-to-place-a-mirror"></span><h3 class="section">22.1 How to place a mirror</h3>
  1641. <span id="index-how-to-place-a-mirror"></span>
  1642. <p>If there&rsquo;s no Dragora mirror near you, you&rsquo;re welcome to contribute one.
  1643. </p>
  1644. <p>First, for users or downloaders, the address <em>rsync://rsync.dragora.org/</em>
  1645. contains ISO images and source code (in various formats) taken from the
  1646. original sites and distributed by Dragora.
  1647. </p>
  1648. <p>Mirroring the Dragora server requires approximately 13GB of disk space (as
  1649. of January 2022). You can hit rsync directly from <em>rsync.dragora.org</em> as:
  1650. </p>
  1651. <p><code>rsync -rltpHS --delete-excluded rsync://rsync.dragora.org/dragora /your/dir/</code>
  1652. </p>
  1653. <p>Also, consider mirroring from another site in order to reduce load on the
  1654. Dragora server. The listed sites at
  1655. <a href="https://www.dragora.org/en/get/mirrors/index.html">https://www.dragora.org/en/get/mirrors/index.html</a> provide access to all
  1656. the material on rsync.dragora.org. They update from us nightly (at least),
  1657. and you may access them via rsync with the same options as above.
  1658. </p>
  1659. <p>Note:
  1660. </p>
  1661. <p>We keep a file called &quot;timestamp&quot; under the main tree after each
  1662. synchronization. This file can be used to verify, instead of synchronizing
  1663. all the content at once, you can check if this file has been updated and
  1664. then continue with the full synchronization.
  1665. </p>
  1666. <hr>
  1667. <span id="GNU-Free-Documentation-License"></span><div class="header">
  1668. <p>
  1669. Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Contributing-to-Dragora" accesskey="p" rel="prev">Contributing to Dragora</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  1670. </div>
  1671. <span id="GNU-Free-Documentation-License-1"></span><h2 class="appendix">Appendix A GNU Free Documentation License</h2>
  1672. <div align="center">Version 1.3, 3 November 2008
  1673. </div>
  1674. <div class="display">
  1675. <pre class="display">Copyright &copy; 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
  1676. <a href="https://fsf.org/">https://fsf.org/</a>
  1677. Everyone is permitted to copy and distribute verbatim copies
  1678. of this license document, but changing it is not allowed.
  1679. </pre></div>
  1680. <ol start="0">
  1681. <li> PREAMBLE
  1682. <p>The purpose of this License is to make a manual, textbook, or other
  1683. functional and useful document <em>free</em> in the sense of freedom: to
  1684. assure everyone the effective freedom to copy and redistribute it,
  1685. with or without modifying it, either commercially or noncommercially.
  1686. Secondarily, this License preserves for the author and publisher a way
  1687. to get credit for their work, while not being considered responsible
  1688. for modifications made by others.
  1689. </p>
  1690. <p>This License is a kind of &ldquo;copyleft&rdquo;, which means that derivative
  1691. works of the document must themselves be free in the same sense. It
  1692. complements the GNU General Public License, which is a copyleft
  1693. license designed for free software.
  1694. </p>
  1695. <p>We have designed this License in order to use it for manuals for free
  1696. software, because free software needs free documentation: a free
  1697. program should come with manuals providing the same freedoms that the
  1698. software does. But this License is not limited to software manuals;
  1699. it can be used for any textual work, regardless of subject matter or
  1700. whether it is published as a printed book. We recommend this License
  1701. principally for works whose purpose is instruction or reference.
  1702. </p>
  1703. </li><li> APPLICABILITY AND DEFINITIONS
  1704. <p>This License applies to any manual or other work, in any medium, that
  1705. contains a notice placed by the copyright holder saying it can be
  1706. distributed under the terms of this License. Such a notice grants a
  1707. world-wide, royalty-free license, unlimited in duration, to use that
  1708. work under the conditions stated herein. The &ldquo;Document&rdquo;, below,
  1709. refers to any such manual or work. Any member of the public is a
  1710. licensee, and is addressed as &ldquo;you&rdquo;. You accept the license if you
  1711. copy, modify or distribute the work in a way requiring permission
  1712. under copyright law.
  1713. </p>
  1714. <p>A &ldquo;Modified Version&rdquo; of the Document means any work containing the
  1715. Document or a portion of it, either copied verbatim, or with
  1716. modifications and/or translated into another language.
  1717. </p>
  1718. <p>A &ldquo;Secondary Section&rdquo; is a named appendix or a front-matter section
  1719. of the Document that deals exclusively with the relationship of the
  1720. publishers or authors of the Document to the Document&rsquo;s overall
  1721. subject (or to related matters) and contains nothing that could fall
  1722. directly within that overall subject. (Thus, if the Document is in
  1723. part a textbook of mathematics, a Secondary Section may not explain
  1724. any mathematics.) The relationship could be a matter of historical
  1725. connection with the subject or with related matters, or of legal,
  1726. commercial, philosophical, ethical or political position regarding
  1727. them.
  1728. </p>
  1729. <p>The &ldquo;Invariant Sections&rdquo; are certain Secondary Sections whose titles
  1730. are designated, as being those of Invariant Sections, in the notice
  1731. that says that the Document is released under this License. If a
  1732. section does not fit the above definition of Secondary then it is not
  1733. allowed to be designated as Invariant. The Document may contain zero
  1734. Invariant Sections. If the Document does not identify any Invariant
  1735. Sections then there are none.
  1736. </p>
  1737. <p>The &ldquo;Cover Texts&rdquo; are certain short passages of text that are listed,
  1738. as Front-Cover Texts or Back-Cover Texts, in the notice that says that
  1739. the Document is released under this License. A Front-Cover Text may
  1740. be at most 5 words, and a Back-Cover Text may be at most 25 words.
  1741. </p>
  1742. <p>A &ldquo;Transparent&rdquo; copy of the Document means a machine-readable copy,
  1743. represented in a format whose specification is available to the
  1744. general public, that is suitable for revising the document
  1745. straightforwardly with generic text editors or (for images composed of
  1746. pixels) generic paint programs or (for drawings) some widely available
  1747. drawing editor, and that is suitable for input to text formatters or
  1748. for automatic translation to a variety of formats suitable for input
  1749. to text formatters. A copy made in an otherwise Transparent file
  1750. format whose markup, or absence of markup, has been arranged to thwart
  1751. or discourage subsequent modification by readers is not Transparent.
  1752. An image format is not Transparent if used for any substantial amount
  1753. of text. A copy that is not &ldquo;Transparent&rdquo; is called &ldquo;Opaque&rdquo;.
  1754. </p>
  1755. <p>Examples of suitable formats for Transparent copies include plain
  1756. ASCII without markup, Texinfo input format, LaTeX input
  1757. format, SGML or XML using a publicly available
  1758. DTD, and standard-conforming simple HTML,
  1759. PostScript or PDF designed for human modification. Examples
  1760. of transparent image formats include PNG, XCF and
  1761. JPG. Opaque formats include proprietary formats that can be
  1762. read and edited only by proprietary word processors, SGML or
  1763. XML for which the DTD and/or processing tools are
  1764. not generally available, and the machine-generated HTML,
  1765. PostScript or PDF produced by some word processors for
  1766. output purposes only.
  1767. </p>
  1768. <p>The &ldquo;Title Page&rdquo; means, for a printed book, the title page itself,
  1769. plus such following pages as are needed to hold, legibly, the material
  1770. this License requires to appear in the title page. For works in
  1771. formats which do not have any title page as such, &ldquo;Title Page&rdquo; means
  1772. the text near the most prominent appearance of the work&rsquo;s title,
  1773. preceding the beginning of the body of the text.
  1774. </p>
  1775. <p>The &ldquo;publisher&rdquo; means any person or entity that distributes copies
  1776. of the Document to the public.
  1777. </p>
  1778. <p>A section &ldquo;Entitled XYZ&rdquo; means a named subunit of the Document whose
  1779. title either is precisely XYZ or contains XYZ in parentheses following
  1780. text that translates XYZ in another language. (Here XYZ stands for a
  1781. specific section name mentioned below, such as &ldquo;Acknowledgements&rdquo;,
  1782. &ldquo;Dedications&rdquo;, &ldquo;Endorsements&rdquo;, or &ldquo;History&rdquo;.) To &ldquo;Preserve the Title&rdquo;
  1783. of such a section when you modify the Document means that it remains a
  1784. section &ldquo;Entitled XYZ&rdquo; according to this definition.
  1785. </p>
  1786. <p>The Document may include Warranty Disclaimers next to the notice which
  1787. states that this License applies to the Document. These Warranty
  1788. Disclaimers are considered to be included by reference in this
  1789. License, but only as regards disclaiming warranties: any other
  1790. implication that these Warranty Disclaimers may have is void and has
  1791. no effect on the meaning of this License.
  1792. </p>
  1793. </li><li> VERBATIM COPYING
  1794. <p>You may copy and distribute the Document in any medium, either
  1795. commercially or noncommercially, provided that this License, the
  1796. copyright notices, and the license notice saying this License applies
  1797. to the Document are reproduced in all copies, and that you add no other
  1798. conditions whatsoever to those of this License. You may not use
  1799. technical measures to obstruct or control the reading or further
  1800. copying of the copies you make or distribute. However, you may accept
  1801. compensation in exchange for copies. If you distribute a large enough
  1802. number of copies you must also follow the conditions in section 3.
  1803. </p>
  1804. <p>You may also lend copies, under the same conditions stated above, and
  1805. you may publicly display copies.
  1806. </p>
  1807. </li><li> COPYING IN QUANTITY
  1808. <p>If you publish printed copies (or copies in media that commonly have
  1809. printed covers) of the Document, numbering more than 100, and the
  1810. Document&rsquo;s license notice requires Cover Texts, you must enclose the
  1811. copies in covers that carry, clearly and legibly, all these Cover
  1812. Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
  1813. the back cover. Both covers must also clearly and legibly identify
  1814. you as the publisher of these copies. The front cover must present
  1815. the full title with all words of the title equally prominent and
  1816. visible. You may add other material on the covers in addition.
  1817. Copying with changes limited to the covers, as long as they preserve
  1818. the title of the Document and satisfy these conditions, can be treated
  1819. as verbatim copying in other respects.
  1820. </p>
  1821. <p>If the required texts for either cover are too voluminous to fit
  1822. legibly, you should put the first ones listed (as many as fit
  1823. reasonably) on the actual cover, and continue the rest onto adjacent
  1824. pages.
  1825. </p>
  1826. <p>If you publish or distribute Opaque copies of the Document numbering
  1827. more than 100, you must either include a machine-readable Transparent
  1828. copy along with each Opaque copy, or state in or with each Opaque copy
  1829. a computer-network location from which the general network-using
  1830. public has access to download using public-standard network protocols
  1831. a complete Transparent copy of the Document, free of added material.
  1832. If you use the latter option, you must take reasonably prudent steps,
  1833. when you begin distribution of Opaque copies in quantity, to ensure
  1834. that this Transparent copy will remain thus accessible at the stated
  1835. location until at least one year after the last time you distribute an
  1836. Opaque copy (directly or through your agents or retailers) of that
  1837. edition to the public.
  1838. </p>
  1839. <p>It is requested, but not required, that you contact the authors of the
  1840. Document well before redistributing any large number of copies, to give
  1841. them a chance to provide you with an updated version of the Document.
  1842. </p>
  1843. </li><li> MODIFICATIONS
  1844. <p>You may copy and distribute a Modified Version of the Document under
  1845. the conditions of sections 2 and 3 above, provided that you release
  1846. the Modified Version under precisely this License, with the Modified
  1847. Version filling the role of the Document, thus licensing distribution
  1848. and modification of the Modified Version to whoever possesses a copy
  1849. of it. In addition, you must do these things in the Modified Version:
  1850. </p>
  1851. <ol type="A" start="1">
  1852. <li> Use in the Title Page (and on the covers, if any) a title distinct
  1853. from that of the Document, and from those of previous versions
  1854. (which should, if there were any, be listed in the History section
  1855. of the Document). You may use the same title as a previous version
  1856. if the original publisher of that version gives permission.
  1857. </li><li> List on the Title Page, as authors, one or more persons or entities
  1858. responsible for authorship of the modifications in the Modified
  1859. Version, together with at least five of the principal authors of the
  1860. Document (all of its principal authors, if it has fewer than five),
  1861. unless they release you from this requirement.
  1862. </li><li> State on the Title page the name of the publisher of the
  1863. Modified Version, as the publisher.
  1864. </li><li> Preserve all the copyright notices of the Document.
  1865. </li><li> Add an appropriate copyright notice for your modifications
  1866. adjacent to the other copyright notices.
  1867. </li><li> Include, immediately after the copyright notices, a license notice
  1868. giving the public permission to use the Modified Version under the
  1869. terms of this License, in the form shown in the Addendum below.
  1870. </li><li> Preserve in that license notice the full lists of Invariant Sections
  1871. and required Cover Texts given in the Document&rsquo;s license notice.
  1872. </li><li> Include an unaltered copy of this License.
  1873. </li><li> Preserve the section Entitled &ldquo;History&rdquo;, Preserve its Title, and add
  1874. to it an item stating at least the title, year, new authors, and
  1875. publisher of the Modified Version as given on the Title Page. If
  1876. there is no section Entitled &ldquo;History&rdquo; in the Document, create one
  1877. stating the title, year, authors, and publisher of the Document as
  1878. given on its Title Page, then add an item describing the Modified
  1879. Version as stated in the previous sentence.
  1880. </li><li> Preserve the network location, if any, given in the Document for
  1881. public access to a Transparent copy of the Document, and likewise
  1882. the network locations given in the Document for previous versions
  1883. it was based on. These may be placed in the &ldquo;History&rdquo; section.
  1884. You may omit a network location for a work that was published at
  1885. least four years before the Document itself, or if the original
  1886. publisher of the version it refers to gives permission.
  1887. </li><li> For any section Entitled &ldquo;Acknowledgements&rdquo; or &ldquo;Dedications&rdquo;, Preserve
  1888. the Title of the section, and preserve in the section all the
  1889. substance and tone of each of the contributor acknowledgements and/or
  1890. dedications given therein.
  1891. </li><li> Preserve all the Invariant Sections of the Document,
  1892. unaltered in their text and in their titles. Section numbers
  1893. or the equivalent are not considered part of the section titles.
  1894. </li><li> Delete any section Entitled &ldquo;Endorsements&rdquo;. Such a section
  1895. may not be included in the Modified Version.
  1896. </li><li> Do not retitle any existing section to be Entitled &ldquo;Endorsements&rdquo; or
  1897. to conflict in title with any Invariant Section.
  1898. </li><li> Preserve any Warranty Disclaimers.
  1899. </li></ol>
  1900. <p>If the Modified Version includes new front-matter sections or
  1901. appendices that qualify as Secondary Sections and contain no material
  1902. copied from the Document, you may at your option designate some or all
  1903. of these sections as invariant. To do this, add their titles to the
  1904. list of Invariant Sections in the Modified Version&rsquo;s license notice.
  1905. These titles must be distinct from any other section titles.
  1906. </p>
  1907. <p>You may add a section Entitled &ldquo;Endorsements&rdquo;, provided it contains
  1908. nothing but endorsements of your Modified Version by various
  1909. parties&mdash;for example, statements of peer review or that the text has
  1910. been approved by an organization as the authoritative definition of a
  1911. standard.
  1912. </p>
  1913. <p>You may add a passage of up to five words as a Front-Cover Text, and a
  1914. passage of up to 25 words as a Back-Cover Text, to the end of the list
  1915. of Cover Texts in the Modified Version. Only one passage of
  1916. Front-Cover Text and one of Back-Cover Text may be added by (or
  1917. through arrangements made by) any one entity. If the Document already
  1918. includes a cover text for the same cover, previously added by you or
  1919. by arrangement made by the same entity you are acting on behalf of,
  1920. you may not add another; but you may replace the old one, on explicit
  1921. permission from the previous publisher that added the old one.
  1922. </p>
  1923. <p>The author(s) and publisher(s) of the Document do not by this License
  1924. give permission to use their names for publicity for or to assert or
  1925. imply endorsement of any Modified Version.
  1926. </p>
  1927. </li><li> COMBINING DOCUMENTS
  1928. <p>You may combine the Document with other documents released under this
  1929. License, under the terms defined in section 4 above for modified
  1930. versions, provided that you include in the combination all of the
  1931. Invariant Sections of all of the original documents, unmodified, and
  1932. list them all as Invariant Sections of your combined work in its
  1933. license notice, and that you preserve all their Warranty Disclaimers.
  1934. </p>
  1935. <p>The combined work need only contain one copy of this License, and
  1936. multiple identical Invariant Sections may be replaced with a single
  1937. copy. If there are multiple Invariant Sections with the same name but
  1938. different contents, make the title of each such section unique by
  1939. adding at the end of it, in parentheses, the name of the original
  1940. author or publisher of that section if known, or else a unique number.
  1941. Make the same adjustment to the section titles in the list of
  1942. Invariant Sections in the license notice of the combined work.
  1943. </p>
  1944. <p>In the combination, you must combine any sections Entitled &ldquo;History&rdquo;
  1945. in the various original documents, forming one section Entitled
  1946. &ldquo;History&rdquo;; likewise combine any sections Entitled &ldquo;Acknowledgements&rdquo;,
  1947. and any sections Entitled &ldquo;Dedications&rdquo;. You must delete all
  1948. sections Entitled &ldquo;Endorsements.&rdquo;
  1949. </p>
  1950. </li><li> COLLECTIONS OF DOCUMENTS
  1951. <p>You may make a collection consisting of the Document and other documents
  1952. released under this License, and replace the individual copies of this
  1953. License in the various documents with a single copy that is included in
  1954. the collection, provided that you follow the rules of this License for
  1955. verbatim copying of each of the documents in all other respects.
  1956. </p>
  1957. <p>You may extract a single document from such a collection, and distribute
  1958. it individually under this License, provided you insert a copy of this
  1959. License into the extracted document, and follow this License in all
  1960. other respects regarding verbatim copying of that document.
  1961. </p>
  1962. </li><li> AGGREGATION WITH INDEPENDENT WORKS
  1963. <p>A compilation of the Document or its derivatives with other separate
  1964. and independent documents or works, in or on a volume of a storage or
  1965. distribution medium, is called an &ldquo;aggregate&rdquo; if the copyright
  1966. resulting from the compilation is not used to limit the legal rights
  1967. of the compilation&rsquo;s users beyond what the individual works permit.
  1968. When the Document is included in an aggregate, this License does not
  1969. apply to the other works in the aggregate which are not themselves
  1970. derivative works of the Document.
  1971. </p>
  1972. <p>If the Cover Text requirement of section 3 is applicable to these
  1973. copies of the Document, then if the Document is less than one half of
  1974. the entire aggregate, the Document&rsquo;s Cover Texts may be placed on
  1975. covers that bracket the Document within the aggregate, or the
  1976. electronic equivalent of covers if the Document is in electronic form.
  1977. Otherwise they must appear on printed covers that bracket the whole
  1978. aggregate.
  1979. </p>
  1980. </li><li> TRANSLATION
  1981. <p>Translation is considered a kind of modification, so you may
  1982. distribute translations of the Document under the terms of section 4.
  1983. Replacing Invariant Sections with translations requires special
  1984. permission from their copyright holders, but you may include
  1985. translations of some or all Invariant Sections in addition to the
  1986. original versions of these Invariant Sections. You may include a
  1987. translation of this License, and all the license notices in the
  1988. Document, and any Warranty Disclaimers, provided that you also include
  1989. the original English version of this License and the original versions
  1990. of those notices and disclaimers. In case of a disagreement between
  1991. the translation and the original version of this License or a notice
  1992. or disclaimer, the original version will prevail.
  1993. </p>
  1994. <p>If a section in the Document is Entitled &ldquo;Acknowledgements&rdquo;,
  1995. &ldquo;Dedications&rdquo;, or &ldquo;History&rdquo;, the requirement (section 4) to Preserve
  1996. its Title (section 1) will typically require changing the actual
  1997. title.
  1998. </p>
  1999. </li><li> TERMINATION
  2000. <p>You may not copy, modify, sublicense, or distribute the Document
  2001. except as expressly provided under this License. Any attempt
  2002. otherwise to copy, modify, sublicense, or distribute it is void, and
  2003. will automatically terminate your rights under this License.
  2004. </p>
  2005. <p>However, if you cease all violation of this License, then your license
  2006. from a particular copyright holder is reinstated (a) provisionally,
  2007. unless and until the copyright holder explicitly and finally
  2008. terminates your license, and (b) permanently, if the copyright holder
  2009. fails to notify you of the violation by some reasonable means prior to
  2010. 60 days after the cessation.
  2011. </p>
  2012. <p>Moreover, your license from a particular copyright holder is
  2013. reinstated permanently if the copyright holder notifies you of the
  2014. violation by some reasonable means, this is the first time you have
  2015. received notice of violation of this License (for any work) from that
  2016. copyright holder, and you cure the violation prior to 30 days after
  2017. your receipt of the notice.
  2018. </p>
  2019. <p>Termination of your rights under this section does not terminate the
  2020. licenses of parties who have received copies or rights from you under
  2021. this License. If your rights have been terminated and not permanently
  2022. reinstated, receipt of a copy of some or all of the same material does
  2023. not give you any rights to use it.
  2024. </p>
  2025. </li><li> FUTURE REVISIONS OF THIS LICENSE
  2026. <p>The Free Software Foundation may publish new, revised versions
  2027. of the GNU Free Documentation License from time to time. Such new
  2028. versions will be similar in spirit to the present version, but may
  2029. differ in detail to address new problems or concerns. See
  2030. <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
  2031. </p>
  2032. <p>Each version of the License is given a distinguishing version number.
  2033. If the Document specifies that a particular numbered version of this
  2034. License &ldquo;or any later version&rdquo; applies to it, you have the option of
  2035. following the terms and conditions either of that specified version or
  2036. of any later version that has been published (not as a draft) by the
  2037. Free Software Foundation. If the Document does not specify a version
  2038. number of this License, you may choose any version ever published (not
  2039. as a draft) by the Free Software Foundation. If the Document
  2040. specifies that a proxy can decide which future versions of this
  2041. License can be used, that proxy&rsquo;s public statement of acceptance of a
  2042. version permanently authorizes you to choose that version for the
  2043. Document.
  2044. </p>
  2045. </li><li> RELICENSING
  2046. <p>&ldquo;Massive Multiauthor Collaboration Site&rdquo; (or &ldquo;MMC Site&rdquo;) means any
  2047. World Wide Web server that publishes copyrightable works and also
  2048. provides prominent facilities for anybody to edit those works. A
  2049. public wiki that anybody can edit is an example of such a server. A
  2050. &ldquo;Massive Multiauthor Collaboration&rdquo; (or &ldquo;MMC&rdquo;) contained in the
  2051. site means any set of copyrightable works thus published on the MMC
  2052. site.
  2053. </p>
  2054. <p>&ldquo;CC-BY-SA&rdquo; means the Creative Commons Attribution-Share Alike 3.0
  2055. license published by Creative Commons Corporation, a not-for-profit
  2056. corporation with a principal place of business in San Francisco,
  2057. California, as well as future copyleft versions of that license
  2058. published by that same organization.
  2059. </p>
  2060. <p>&ldquo;Incorporate&rdquo; means to publish or republish a Document, in whole or
  2061. in part, as part of another Document.
  2062. </p>
  2063. <p>An MMC is &ldquo;eligible for relicensing&rdquo; if it is licensed under this
  2064. License, and if all works that were first published under this License
  2065. somewhere other than this MMC, and subsequently incorporated in whole
  2066. or in part into the MMC, (1) had no cover texts or invariant sections,
  2067. and (2) were thus incorporated prior to November 1, 2008.
  2068. </p>
  2069. <p>The operator of an MMC Site may republish an MMC contained in the site
  2070. under CC-BY-SA on the same site at any time before August 1, 2009,
  2071. provided the MMC is eligible for relicensing.
  2072. </p>
  2073. </li></ol>
  2074. <span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
  2075. <p>To use this License in a document you have written, include a copy of
  2076. the License in the document and put the following copyright and
  2077. license notices just after the title page:
  2078. </p>
  2079. <div class="example">
  2080. <pre class="example"> Copyright (C) <var>year</var> <var>your name</var>.
  2081. Permission is granted to copy, distribute and/or modify this document
  2082. under the terms of the GNU Free Documentation License, Version 1.3
  2083. or any later version published by the Free Software Foundation;
  2084. with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  2085. Texts. A copy of the license is included in the section entitled ``GNU
  2086. Free Documentation License''.
  2087. </pre></div>
  2088. <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
  2089. replace the &ldquo;with&hellip;Texts.&rdquo; line with this:
  2090. </p>
  2091. <div class="example">
  2092. <pre class="example"> with the Invariant Sections being <var>list their titles</var>, with
  2093. the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
  2094. being <var>list</var>.
  2095. </pre></div>
  2096. <p>If you have Invariant Sections without Cover Texts, or some other
  2097. combination of the three, merge those two alternatives to suit the
  2098. situation.
  2099. </p>
  2100. <p>If your document contains nontrivial examples of program code, we
  2101. recommend releasing these examples in parallel under your choice of
  2102. free software license, such as the GNU General Public License,
  2103. to permit their use in free software.
  2104. </p>
  2105. <hr>
  2106. <span id="Index"></span><div class="header">
  2107. <p>
  2108. Previous: <a href="#GNU-Free-Documentation-License" accesskey="p" rel="prev">GNU Free Documentation License</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Index" title="Index" rel="index">Index</a>]</p>
  2109. </div>
  2110. <span id="Index-1"></span><h2 class="unnumbered">Index</h2>
  2111. <table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
  2112. &nbsp;
  2113. <a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
  2114. &nbsp;
  2115. <a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
  2116. &nbsp;
  2117. <a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
  2118. &nbsp;
  2119. <a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
  2120. &nbsp;
  2121. <a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
  2122. &nbsp;
  2123. <a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
  2124. &nbsp;
  2125. <a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
  2126. &nbsp;
  2127. <a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
  2128. &nbsp;
  2129. <a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
  2130. &nbsp;
  2131. <a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
  2132. &nbsp;
  2133. <a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
  2134. &nbsp;
  2135. <a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
  2136. &nbsp;
  2137. <a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
  2138. &nbsp;
  2139. <a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
  2140. &nbsp;
  2141. <a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
  2142. &nbsp;
  2143. <a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
  2144. &nbsp;
  2145. </td></tr></table>
  2146. <table class="index-cp" border="0">
  2147. <tr><td></td><th align="left">Index Entry</th><td>&nbsp;</td><th align="left"> Section</th></tr>
  2148. <tr><td colspan="4"> <hr></td></tr>
  2149. <tr><th id="Index_cp_letter-A">A</th><td></td><td></td></tr>
  2150. <tr><td></td><td valign="top"><a href="#index-a-quick-glance-at-dragora">a quick glance at dragora</a>:</td><td>&nbsp;</td><td valign="top"><a href="#A-quick-glance-at-Dragora">A quick glance at Dragora</a></td></tr>
  2151. <tr><td></td><td valign="top"><a href="#index-about-this-handbook">about this handbook</a>:</td><td>&nbsp;</td><td valign="top"><a href="#About-this-handbook">About this handbook</a></td></tr>
  2152. <tr><td colspan="4"> <hr></td></tr>
  2153. <tr><th id="Index_cp_letter-B">B</th><td></td><td></td></tr>
  2154. <tr><td></td><td valign="top"><a href="#index-boot-options-from-live-medium">boot options from live medium</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Boot-options-from-live-medium">Boot options from live medium</a></td></tr>
  2155. <tr><td colspan="4"> <hr></td></tr>
  2156. <tr><th id="Index_cp_letter-C">C</th><td></td><td></td></tr>
  2157. <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>
  2158. <tr><td></td><td valign="top"><a href="#index-contributing-to-dragora">contributing to dragora</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Contributing-to-Dragora">Contributing to Dragora</a></td></tr>
  2159. <tr><td colspan="4"> <hr></td></tr>
  2160. <tr><th id="Index_cp_letter-E">E</th><td></td><td></td></tr>
  2161. <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>
  2162. <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>
  2163. <tr><td colspan="4"> <hr></td></tr>
  2164. <tr><th id="Index_cp_letter-F">F</th><td></td><td></td></tr>
  2165. <tr><td></td><td valign="top"><a href="#index-free-software">free software</a>:</td><td>&nbsp;</td><td valign="top"><a href="#What-is-Dragora_003f">What is Dragora?</a></td></tr>
  2166. <tr><td colspan="4"> <hr></td></tr>
  2167. <tr><th id="Index_cp_letter-G">G</th><td></td><td></td></tr>
  2168. <tr><td></td><td valign="top"><a href="#index-getting-support">getting support</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Getting-support">Getting support</a></td></tr>
  2169. <tr><td></td><td valign="top"><a href="#index-gnu">gnu</a>:</td><td>&nbsp;</td><td valign="top"><a href="#What-is-Dragora_003f">What is Dragora?</a></td></tr>
  2170. <tr><td colspan="4"> <hr></td></tr>
  2171. <tr><th id="Index_cp_letter-H">H</th><td></td><td></td></tr>
  2172. <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>
  2173. <tr><td></td><td valign="top"><a href="#index-history">history</a>:</td><td>&nbsp;</td><td valign="top"><a href="#History">History</a></td></tr>
  2174. <tr><td></td><td valign="top"><a href="#index-how-to-place-a-mirror">how to place a mirror</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Contributing-to-Dragora">Contributing to Dragora</a></td></tr>
  2175. <tr><td colspan="4"> <hr></td></tr>
  2176. <tr><th id="Index_cp_letter-I">I</th><td></td><td></td></tr>
  2177. <tr><td></td><td valign="top"><a href="#index-installing-the-system-manually-_0028as-an-alternative_0029">installing the system manually (as an alternative)</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Installing-the-system-manually-_0028as-an-alternative_0029">Installing the system manually (as an alternative)</a></td></tr>
  2178. <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>
  2179. <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>
  2180. <tr><td colspan="4"> <hr></td></tr>
  2181. <tr><th id="Index_cp_letter-L">L</th><td></td><td></td></tr>
  2182. <tr><td></td><td valign="top"><a href="#index-linux-or-linux_002dlibre">linux or linux-libre</a>:</td><td>&nbsp;</td><td valign="top"><a href="#What-is-Dragora_003f">What is Dragora?</a></td></tr>
  2183. <tr><td colspan="4"> <hr></td></tr>
  2184. <tr><th id="Index_cp_letter-M">M</th><td></td><td></td></tr>
  2185. <tr><td></td><td valign="top"><a href="#index-maintainers">maintainers</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Maintainers">Maintainers</a></td></tr>
  2186. <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>
  2187. <tr><td colspan="4"> <hr></td></tr>
  2188. <tr><th id="Index_cp_letter-P">P</th><td></td><td></td></tr>
  2189. <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>
  2190. <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>
  2191. <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>
  2192. <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>
  2193. <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>
  2194. <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>
  2195. <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>
  2196. <tr><td></td><td valign="top"><a href="#index-package-management-in-a-nutshell">package management in a nutshell</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Package-management-in-a-nutshell">Package management in a nutshell</a></td></tr>
  2197. <tr><td></td><td valign="top"><a href="#index-package-management-in-dragora">package management in dragora</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-package-management-in-Dragora">Introduction to package management in Dragora</a></td></tr>
  2198. <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>
  2199. <tr><td colspan="4"> <hr></td></tr>
  2200. <tr><th id="Index_cp_letter-R">R</th><td></td><td></td></tr>
  2201. <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>
  2202. <tr><td></td><td valign="top"><a href="#index-releases">releases</a>:</td><td>&nbsp;</td><td valign="top"><a href="#History">History</a></td></tr>
  2203. <tr><td></td><td valign="top"><a href="#index-revision-history-_0028changelog_0029">revision history (changelog)</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Revision-history-_0028ChangeLog_0029">Revision history (ChangeLog)</a></td></tr>
  2204. <tr><td colspan="4"> <hr></td></tr>
  2205. <tr><th id="Index_cp_letter-S">S</th><td></td><td></td></tr>
  2206. <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>
  2207. <tr><td colspan="4"> <hr></td></tr>
  2208. <tr><th id="Index_cp_letter-T">T</th><td></td><td></td></tr>
  2209. <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>
  2210. <tr><td></td><td valign="top"><a href="#index-typographic-conventions">typographic conventions</a>:</td><td>&nbsp;</td><td valign="top"><a href="#About-this-handbook">About this handbook</a></td></tr>
  2211. <tr><td colspan="4"> <hr></td></tr>
  2212. <tr><th id="Index_cp_letter-U">U</th><td></td><td></td></tr>
  2213. <tr><td></td><td valign="top"><a href="#index-using-dragora_002dinstaller">using dragora-installer</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Using-dragora_002dinstaller">Using dragora-installer</a></td></tr>
  2214. <tr><td></td><td valign="top"><a href="#index-using-third_002dparty-free-software">using third-party free software</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Using-third_002dparty-free-software">Using third-party free software</a></td></tr>
  2215. <tr><td colspan="4"> <hr></td></tr>
  2216. <tr><th id="Index_cp_letter-V">V</th><td></td><td></td></tr>
  2217. <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>
  2218. <tr><td colspan="4"> <hr></td></tr>
  2219. <tr><th id="Index_cp_letter-W">W</th><td></td><td></td></tr>
  2220. <tr><td></td><td valign="top"><a href="#index-what-is-dragora_003f">what is dragora?</a>:</td><td>&nbsp;</td><td valign="top"><a href="#What-is-Dragora_003f">What is Dragora?</a></td></tr>
  2221. <tr><td></td><td valign="top"><a href="#index-why-should-I-use-dragora_003f">why should I use dragora?</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Why-should-I-use-Dragora_003f">Why should I use Dragora?</a></td></tr>
  2222. <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>
  2223. <tr><td colspan="4"> <hr></td></tr>
  2224. </table>
  2225. <table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
  2226. &nbsp;
  2227. <a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
  2228. &nbsp;
  2229. <a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
  2230. &nbsp;
  2231. <a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
  2232. &nbsp;
  2233. <a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
  2234. &nbsp;
  2235. <a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
  2236. &nbsp;
  2237. <a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
  2238. &nbsp;
  2239. <a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
  2240. &nbsp;
  2241. <a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
  2242. &nbsp;
  2243. <a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
  2244. &nbsp;
  2245. <a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
  2246. &nbsp;
  2247. <a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
  2248. &nbsp;
  2249. <a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
  2250. &nbsp;
  2251. <a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
  2252. &nbsp;
  2253. <a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
  2254. &nbsp;
  2255. <a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
  2256. &nbsp;
  2257. <a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
  2258. &nbsp;
  2259. </td></tr></table>
  2260. <div class="footnote">
  2261. <hr>
  2262. <h4 class="footnotes-heading">Footnotes</h4>
  2263. <h5><a id="FOOT1" href="#DOCF1">(1)</a></h3>
  2264. <p>For more details about tarlz and the
  2265. lzip format, visit <a href="https://lzip.nongnu.org/tarlz.html">https://lzip.nongnu.org/tarlz.html</a>.</p>
  2266. <h5><a id="FOOT2" href="#DOCF2">(2)</a></h3>
  2267. <p>The official guide for Graft can be found at
  2268. <a href="https://peters.gormand.com.au/Home/tools/graft/graft.html">https://peters.gormand.com.au/Home/tools/graft/graft.html</a>.</p>
  2269. <h5><a id="FOOT3" href="#DOCF3">(3)</a></h3>
  2270. <p>About the &lsquo;<samp>--bsolid</samp>&rsquo; granularity option of tarlz(1),
  2271. <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>
  2272. <h5><a id="FOOT4" href="#DOCF4">(4)</a></h3>
  2273. <p>The proposal for &lsquo;<samp>license</samp>&rsquo; was made by Richard M. Stallman at
  2274. <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>
  2275. </div>
  2276. <hr>
  2277. </body>
  2278. </html>