dragora-handbook.html 112 KB

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