Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
Nim
/
nimscript.html

nimscript.html 108 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>system/nimscript</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">system/nimscript</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <details open>
    56. 

  56.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    57. 

  57.     <ul class="simple simple-toc-section">
    58. 

  58.       <li><a class="reference" href="#ScriptMode" title="ScriptMode {.pure.} = enum
    59. 

  59.   Silent,                   ## Be silent.
    60. 

  60.   Verbose,                  ## Be verbose.
    61. 

  61.   Whatif                     ## Do not run commands, instead just echo what
    62. 

  62.                              ## would have been done.">ScriptMode</a></li>
    63. 

  63. 

  64.     </ul>
    65. 

  65.   </details>
    66. 

  66. </li>
    67. 

  67. <li>
    68. 

  68.   <details open>
    69. 

  69.     <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
    70. 

  70.     <ul class="simple simple-toc-section">
    71. 

  71.       <li><a class="reference" href="#author" title="author: string">author</a></li>
    72. 

  72. <li><a class="reference" href="#backend" title="backend: string">backend</a></li>
    73. 

  73. <li><a class="reference" href="#bin" title="bin: seq[string] = @[]">bin</a></li>
    74. 

  74. <li><a class="reference" href="#binDir" title="binDir: string">binDir</a></li>
    75. 

  75. <li><a class="reference" href="#description" title="description: string">description</a></li>
    76. 

  76. <li><a class="reference" href="#installDirs" title="installDirs: seq[string] = @[]">installDirs</a></li>
    77. 

  77. <li><a class="reference" href="#installExt" title="installExt: seq[string] = @[]">installExt</a></li>
    78. 

  78. <li><a class="reference" href="#installFiles" title="installFiles: seq[string] = @[]">installFiles</a></li>
    79. 

  79. <li><a class="reference" href="#license" title="license: string">license</a></li>
    80. 

  80. <li><a class="reference" href="#mode" title="mode: ScriptMode">mode</a></li>
    81. 

  81. <li><a class="reference" href="#packageName" title="packageName = &quot;&quot;">packageName</a></li>
    82. 

  82. <li><a class="reference" href="#requiresData" title="requiresData: seq[string] = @[]">requiresData</a></li>
    83. 

  83. <li><a class="reference" href="#skipDirs" title="skipDirs: seq[string] = @[]">skipDirs</a></li>
    84. 

  84. <li><a class="reference" href="#skipExt" title="skipExt: seq[string] = @[]">skipExt</a></li>
    85. 

  85. <li><a class="reference" href="#skipFiles" title="skipFiles: seq[string] = @[]">skipFiles</a></li>
    86. 

  86. <li><a class="reference" href="#srcDir" title="srcDir: string">srcDir</a></li>
    87. 

  87. <li><a class="reference" href="#version" title="version: string">version</a></li>
    88. 

  88. 

  89.     </ul>
    90. 

  90.   </details>
    91. 

  91. </li>
    92. 

  92. <li>
    93. 

  93.   <details open>
    94. 

  94.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    95. 

  95.     <ul class="simple simple-toc-section">
    96. 

  96.       <li><a class="reference" href="#buildCPU" title="buildCPU {.magic: &quot;BuildCPU&quot;.}: string = &quot;&quot;">buildCPU</a></li>
    97. 

  97. <li><a class="reference" href="#buildOS" title="buildOS {.magic: &quot;BuildOS&quot;.}: string = &quot;&quot;">buildOS</a></li>
    98. 

  98. 

  99.     </ul>
    100. 

  100.   </details>
    101. 

  101. </li>
    102. 

  102. <li>
    103. 

  103.   <details open>
    104. 

  104.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    105. 

  105.     <ul class="simple simple-toc-section">
    106. 

  106.       <ul class="simple nested-toc-section">cd
    107. 

  107.   <li><a class="reference" href="#cd%2Cstring" title="cd(dir: string)">cd(dir: string)</a></li>
    108. 

  108. 

  109. </ul>
    110. 

  110. <ul class="simple nested-toc-section">cmpic
    111. 

  111.   <li><a class="reference" href="#cmpic%2Cstring%2Cstring" title="cmpic(a, b: string): int">cmpic(a, b: string): int</a></li>
    112. 

  112. 

  113. </ul>
    114. 

  114. <ul class="simple nested-toc-section">cpDir
    115. 

  115.   <li><a class="reference" href="#cpDir%2Cstring%2Cstring" title="cpDir(from, to: string)">cpDir(from, to: string)</a></li>
    116. 

  116. 

  117. </ul>
    118. 

  118. <ul class="simple nested-toc-section">cpFile
    119. 

  119.   <li><a class="reference" href="#cpFile%2Cstring%2Cstring" title="cpFile(from, to: string)">cpFile(from, to: string)</a></li>
    120. 

  120. 

  121. </ul>
    122. 

  122. <ul class="simple nested-toc-section">cppDefine
    123. 

  123.   <li><a class="reference" href="#cppDefine%2Cstring" title="cppDefine(define: string)">cppDefine(define: string)</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. <ul class="simple nested-toc-section">delEnv
    127. 

  127.   <li><a class="reference" href="#delEnv%2Cstring" title="delEnv(key: string)">delEnv(key: string)</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">dirExists
    131. 

  131.   <li><a class="reference" href="#dirExists%2Cstring" title="dirExists(dir: string): bool">dirExists(dir: string): bool</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">exec
    135. 

  135.   <li><a class="reference" href="#exec%2Cstring" title="exec(command: string)">exec(command: string)</a></li>
    136. 

  136. <li><a class="reference" href="#exec%2Cstring%2Cstring%2Cstring" title="exec(command: string; input: string; cache = &quot;&quot;)">exec(command: string; input: string; cache = &quot;&quot;)</a></li>
    137. 

  137. 

  138. </ul>
    139. 

  139. <ul class="simple nested-toc-section">exists
    140. 

  140.   <li><a class="reference" href="#exists%2Cstring" title="exists(key: string): bool">exists(key: string): bool</a></li>
    141. 

  141. 

  142. </ul>
    143. 

  143. <ul class="simple nested-toc-section">existsEnv
    144. 

  144.   <li><a class="reference" href="#existsEnv%2Cstring" title="existsEnv(key: string): bool">existsEnv(key: string): bool</a></li>
    145. 

  145. 

  146. </ul>
    147. 

  147. <ul class="simple nested-toc-section">fileExists
    148. 

  148.   <li><a class="reference" href="#fileExists%2Cstring" title="fileExists(filename: string): bool">fileExists(filename: string): bool</a></li>
    149. 

  149. 

  150. </ul>
    151. 

  151. <ul class="simple nested-toc-section">findExe
    152. 

  152.   <li><a class="reference" href="#findExe%2Cstring" title="findExe(bin: string): string">findExe(bin: string): string</a></li>
    153. 

  153. 

  154. </ul>
    155. 

  155. <ul class="simple nested-toc-section">get
    156. 

  156.   <li><a class="reference" href="#get%2Cstring" title="get(key: string): string">get(key: string): string</a></li>
    157. 

  157. 

  158. </ul>
    159. 

  159. <ul class="simple nested-toc-section">getCommand
    160. 

  160.   <li><a class="reference" href="#getCommand" title="getCommand(): string">getCommand(): string</a></li>
    161. 

  161. 

  162. </ul>
    163. 

  163. <ul class="simple nested-toc-section">getCurrentDir
    164. 

  164.   <li><a class="reference" href="#getCurrentDir" title="getCurrentDir(): string">getCurrentDir(): string</a></li>
    165. 

  165. 

  166. </ul>
    167. 

  167. <ul class="simple nested-toc-section">getEnv
    168. 

  168.   <li><a class="reference" href="#getEnv%2Cstring%2Cstring" title="getEnv(key: string; default = &quot;&quot;): string">getEnv(key: string; default = &quot;&quot;): string</a></li>
    169. 

  169. 

  170. </ul>
    171. 

  171. <ul class="simple nested-toc-section">hint
    172. 

  172.   <li><a class="reference" href="#hint%2Cstring%2Cbool" title="hint(name: string; val: bool)">hint(name: string; val: bool)</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">listDirs
    176. 

  176.   <li><a class="reference" href="#listDirs%2Cstring" title="listDirs(dir: string): seq[string]">listDirs(dir: string): seq[string]</a></li>
    177. 

  177. 

  178. </ul>
    179. 

  179. <ul class="simple nested-toc-section">listFiles
    180. 

  180.   <li><a class="reference" href="#listFiles%2Cstring" title="listFiles(dir: string): seq[string]">listFiles(dir: string): seq[string]</a></li>
    181. 

  181. 

  182. </ul>
    183. 

  183. <ul class="simple nested-toc-section">mkDir
    184. 

  184.   <li><a class="reference" href="#mkDir%2Cstring" title="mkDir(dir: string)">mkDir(dir: string)</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">mvDir
    188. 

  188.   <li><a class="reference" href="#mvDir%2Cstring%2Cstring" title="mvDir(from, to: string)">mvDir(from, to: string)</a></li>
    189. 

  189. 

  190. </ul>
    191. 

  191. <ul class="simple nested-toc-section">mvFile
    192. 

  192.   <li><a class="reference" href="#mvFile%2Cstring%2Cstring" title="mvFile(from, to: string)">mvFile(from, to: string)</a></li>
    193. 

  193. 

  194. </ul>
    195. 

  195. <ul class="simple nested-toc-section">nimcacheDir
    196. 

  196.   <li><a class="reference" href="#nimcacheDir" title="nimcacheDir(): string">nimcacheDir(): string</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">paramCount
    200. 

  200.   <li><a class="reference" href="#paramCount" title="paramCount(): int">paramCount(): int</a></li>
    201. 

  201. 

  202. </ul>
    203. 

  203. <ul class="simple nested-toc-section">paramStr
    204. 

  204.   <li><a class="reference" href="#paramStr%2Cint" title="paramStr(i: int): string">paramStr(i: int): string</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. <ul class="simple nested-toc-section">patchFile
    208. 

  208.   <li><a class="reference" href="#patchFile%2Cstring%2Cstring%2Cstring" title="patchFile(package, filename, replacement: string)">patchFile(package, filename, replacement: string)</a></li>
    209. 

  209. 

  210. </ul>
    211. 

  211. <ul class="simple nested-toc-section">projectDir
    212. 

  212.   <li><a class="reference" href="#projectDir" title="projectDir(): string">projectDir(): string</a></li>
    213. 

  213. 

  214. </ul>
    215. 

  215. <ul class="simple nested-toc-section">projectName
    216. 

  216.   <li><a class="reference" href="#projectName" title="projectName(): string">projectName(): string</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. <ul class="simple nested-toc-section">projectPath
    220. 

  220.   <li><a class="reference" href="#projectPath" title="projectPath(): string">projectPath(): string</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. <ul class="simple nested-toc-section">put
    224. 

  224.   <li><a class="reference" href="#put%2Cstring%2Cstring" title="put(key, value: string)">put(key, value: string)</a></li>
    225. 

  225. 

  226. </ul>
    227. 

  227. <ul class="simple nested-toc-section">putEnv
    228. 

  228.   <li><a class="reference" href="#putEnv%2Cstring%2Cstring" title="putEnv(key, val: string)">putEnv(key, val: string)</a></li>
    229. 

  229. 

  230. </ul>
    231. 

  231. <ul class="simple nested-toc-section">readAllFromStdin
    232. 

  232.   <li><a class="reference" href="#readAllFromStdin" title="readAllFromStdin(): string">readAllFromStdin(): string</a></li>
    233. 

  233. 

  234. </ul>
    235. 

  235. <ul class="simple nested-toc-section">readLineFromStdin
    236. 

  236.   <li><a class="reference" href="#readLineFromStdin" title="readLineFromStdin(): string">readLineFromStdin(): string</a></li>
    237. 

  237. 

  238. </ul>
    239. 

  239. <ul class="simple nested-toc-section">requires
    240. 

  240.   <li><a class="reference" href="#requires%2Cvarargs%5Bstring%5D" title="requires(deps: varargs[string])">requires(deps: varargs[string])</a></li>
    241. 

  241. 

  242. </ul>
    243. 

  243. <ul class="simple nested-toc-section">rmDir
    244. 

  244.   <li><a class="reference" href="#rmDir%2Cstring" title="rmDir(dir: string; checkDir = false)">rmDir(dir: string; checkDir = false)</a></li>
    245. 

  245. 

  246. </ul>
    247. 

  247. <ul class="simple nested-toc-section">rmFile
    248. 

  248.   <li><a class="reference" href="#rmFile%2Cstring" title="rmFile(file: string)">rmFile(file: string)</a></li>
    249. 

  249. 

  250. </ul>
    251. 

  251. <ul class="simple nested-toc-section">selfExe
    252. 

  252.   <li><a class="reference" href="#selfExe" title="selfExe(): string">selfExe(): string</a></li>
    253. 

  253. 

  254. </ul>
    255. 

  255. <ul class="simple nested-toc-section">selfExec
    256. 

  256.   <li><a class="reference" href="#selfExec%2Cstring" title="selfExec(command: string)">selfExec(command: string)</a></li>
    257. 

  257. 

  258. </ul>
    259. 

  259. <ul class="simple nested-toc-section">setCommand
    260. 

  260.   <li><a class="reference" href="#setCommand%2Cstring%2Cstring" title="setCommand(cmd: string; project = &quot;&quot;)">setCommand(cmd: string; project = &quot;&quot;)</a></li>
    261. 

  261. 

  262. </ul>
    263. 

  263. <ul class="simple nested-toc-section">switch
    264. 

  264.   <li><a class="reference" href="#switch%2Cstring%2Cstring" title="switch(key: string; val = &quot;&quot;)">switch(key: string; val = &quot;&quot;)</a></li>
    265. 

  265. 

  266. </ul>
    267. 

  267. <ul class="simple nested-toc-section">thisDir
    268. 

  268.   <li><a class="reference" href="#thisDir" title="thisDir(): string">thisDir(): string</a></li>
    269. 

  269. 

  270. </ul>
    271. 

  271. <ul class="simple nested-toc-section">toDll
    272. 

  272.   <li><a class="reference" href="#toDll%2Cstring" title="toDll(filename: string): string">toDll(filename: string): string</a></li>
    273. 

  273. 

  274. </ul>
    275. 

  275. <ul class="simple nested-toc-section">toExe
    276. 

  276.   <li><a class="reference" href="#toExe%2Cstring" title="toExe(filename: string): string">toExe(filename: string): string</a></li>
    277. 

  277. 

  278. </ul>
    279. 

  279. <ul class="simple nested-toc-section">warning
    280. 

  280.   <li><a class="reference" href="#warning%2Cstring%2Cbool" title="warning(name: string; val: bool)">warning(name: string; val: bool)</a></li>
    281. 

  281. 

  282. </ul>
    283. 

  283. 

  284.     </ul>
    285. 

  285.   </details>
    286. 

  286. </li>
    287. 

  287. <li>
    288. 

  288.   <details open>
    289. 

  289.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    290. 

  290.     <ul class="simple simple-toc-section">
    291. 

  291.       <ul class="simple nested-toc-section">--
    292. 

  292.   <li><a class="reference" href="#--.t%2Cuntyped%2Cuntyped" title="`--`(key, val: untyped)">`--`(key, val: untyped)</a></li>
    293. 

  293. <li><a class="reference" href="#--.t%2Cuntyped" title="`--`(key: untyped)">`--`(key: untyped)</a></li>
    294. 

  294. 

  295. </ul>
    296. 

  296. <ul class="simple nested-toc-section">task
    297. 

  297.   <li><a class="reference" href="#task.t%2Cuntyped%2Cstring%2Cuntyped" title="task(name: untyped; description: string; body: untyped): untyped">task(name: untyped; description: string; body: untyped): untyped</a></li>
    298. 

  298. 

  299. </ul>
    300. 

  300. <ul class="simple nested-toc-section">withDir
    301. 

  301.   <li><a class="reference" href="#withDir.t%2Cstring%2Cuntyped" title="withDir(dir: string; body: untyped): untyped">withDir(dir: string; body: untyped): untyped</a></li>
    302. 

  302. 

  303. </ul>
    304. 

  304. 

  305.     </ul>
    306. 

  306.   </details>
    307. 

  307. </li>
    308. 

  308. 

  309. </ul>
    310. 

  310. 

  311.   </div>
    312. 

  312.   <div class="nine columns" id="content">
    313. 

  313.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    314. 

  314. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    315. 

  315. 

  316.     <div id="tocRoot"></div>
    317. 

  317.     
    318. 

  318.     <p class="module-desc">To learn about scripting in Nim see <a class="reference external" href="nims.html">NimScript</a></p>
    319. 

  319.     <div class="section" id="7">
    320. 

  320.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    321. 

  321.   <dl class="item">
    322. 

  322.     <div id="ScriptMode">
    323. 

  323.   <dt><pre><a href="nimscript.html#ScriptMode"><span class="Identifier">ScriptMode</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
    324. 

  324.   <span class="Identifier">Silent</span><span class="Other">,</span>                   <span class="Comment">## Be silent.</span>
    325. 

  325.   <span class="Identifier">Verbose</span><span class="Other">,</span>                  <span class="Comment">## Be verbose.</span>
    326. 

  326.   <span class="Identifier">Whatif</span>                     <span class="Comment">## Do not run commands, instead just echo what</span>
    327. 

  327.                              <span class="Comment">## would have been done.</span></pre></dt>
    328. 

  328.   <dd>
    329. 

  329.     
    330. 

  330.     Controls the behaviour of the script.
    331. 

  331.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L177" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    332. 

  332. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L177" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    333. 

  333. 

  334.   </dd>
    335. 

  335. </div>
    336. 

  336. 

  337.   </dl>
    338. 

  338. </div>
    339. 

  339. <div class="section" id="8">
    340. 

  340.   <h1><a class="toc-backref" href="#8">Vars</a></h1>
    341. 

  341.   <dl class="item">
    342. 

  342.     <div id="author">
    343. 

  343.   <dt><pre><a href="nimscript.html#author"><span class="Identifier">author</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    344. 

  344.   <dd>
    345. 

  345.     
    346. 

  346.     Nimble support: The package's author.
    347. 

  347.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L435" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    348. 

  348. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L435" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    349. 

  349. 

  350.   </dd>
    351. 

  351. </div>
    352. 

  352. <div id="backend">
    353. 

  353.   <dt><pre><a href="nimscript.html#backend"><span class="Identifier">backend</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    354. 

  354.   <dd>
    355. 

  355.     
    356. 

  356.     Nimble support: The package's backend.
    357. 

  357.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L440" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    358. 

  358. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L440" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    359. 

  359. 

  360.   </dd>
    361. 

  361. </div>
    362. 

  362. <div id="bin">
    363. 

  363.   <dt><pre><a href="nimscript.html#bin"><span class="Identifier">bin</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    364. 

  364.   <dd>
    365. 

  365.     
    366. 

  366.     
    367. 

  367.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    368. 

  368. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    369. 

  369. 

  370.   </dd>
    371. 

  371. </div>
    372. 

  372. <div id="binDir">
    373. 

  373.   <dt><pre><a href="nimscript.html#binDir"><span class="Identifier">binDir</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    374. 

  374.   <dd>
    375. 

  375.     
    376. 

  376.     Nimble support: The package's binary directory.
    377. 

  377.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L439" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    378. 

  378. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L439" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    379. 

  379. 

  380.   </dd>
    381. 

  381. </div>
    382. 

  382. <div id="description">
    383. 

  383.   <dt><pre><a href="nimscript.html#description"><span class="Identifier">description</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    384. 

  384.   <dd>
    385. 

  385.     
    386. 

  386.     Nimble support: The package's description.
    387. 

  387.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L436" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    388. 

  388. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L436" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    389. 

  389. 

  390.   </dd>
    391. 

  391. </div>
    392. 

  392. <div id="installDirs">
    393. 

  393.   <dt><pre><a href="nimscript.html#installDirs"><span class="Identifier">installDirs</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    394. 

  394.   <dd>
    395. 

  395.     
    396. 

  396.     
    397. 

  397.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    398. 

  398. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    399. 

  399. 

  400.   </dd>
    401. 

  401. </div>
    402. 

  402. <div id="installExt">
    403. 

  403.   <dt><pre><a href="nimscript.html#installExt"><span class="Identifier">installExt</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    404. 

  404.   <dd>
    405. 

  405.     
    406. 

  406.     
    407. 

  407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    408. 

  408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    409. 

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. <div id="installFiles">
    413. 

  413.   <dt><pre><a href="nimscript.html#installFiles"><span class="Identifier">installFiles</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    414. 

  414.   <dd>
    415. 

  415.     
    416. 

  416.     
    417. 

  417.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    418. 

  418. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    419. 

  419. 

  420.   </dd>
    421. 

  421. </div>
    422. 

  422. <div id="license">
    423. 

  423.   <dt><pre><a href="nimscript.html#license"><span class="Identifier">license</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    424. 

  424.   <dd>
    425. 

  425.     
    426. 

  426.     Nimble support: The package's license.
    427. 

  427.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L437" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    428. 

  428. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L437" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    429. 

  429. 

  430.   </dd>
    431. 

  431. </div>
    432. 

  432. <div id="mode">
    433. 

  433.   <dt><pre><a href="nimscript.html#mode"><span class="Identifier">mode</span></a><span class="Other">:</span> <a href="nimscript.html#ScriptMode"><span class="Identifier">ScriptMode</span></a></pre></dt>
    434. 

  434.   <dd>
    435. 

  435.     
    436. 

  436.     Set this to influence how mkDir, rmDir, rmFile etc. behave
    437. 

  437.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L184" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    438. 

  438. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L184" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    439. 

  439. 

  440.   </dd>
    441. 

  441. </div>
    442. 

  442. <div id="packageName">
    443. 

  443.   <dt><pre><a href="nimscript.html#packageName"><span class="Identifier">packageName</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span></pre></dt>
    444. 

  444.   <dd>
    445. 

  445.     
    446. 

  446.     Nimble support: Set this to the package name. It is usually not required to do that, nims' filename is the default.
    447. 

  447.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L431" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    448. 

  448. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L431" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    449. 

  449. 

  450.   </dd>
    451. 

  451. </div>
    452. 

  452. <div id="requiresData">
    453. 

  453.   <dt><pre><a href="nimscript.html#requiresData"><span class="Identifier">requiresData</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    454. 

  454.   <dd>
    455. 

  455.     
    456. 

  456.     Exposes the list of requirements for read and write accesses.
    457. 

  457.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L444" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    458. 

  458. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L444" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    459. 

  459. 

  460.   </dd>
    461. 

  461. </div>
    462. 

  462. <div id="skipDirs">
    463. 

  463.   <dt><pre><a href="nimscript.html#skipDirs"><span class="Identifier">skipDirs</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    464. 

  464.   <dd>
    465. 

  465.     
    466. 

  466.     
    467. 

  467.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    468. 

  468. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    469. 

  469. 

  470.   </dd>
    471. 

  471. </div>
    472. 

  472. <div id="skipExt">
    473. 

  473.   <dt><pre><a href="nimscript.html#skipExt"><span class="Identifier">skipExt</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    474. 

  474.   <dd>
    475. 

  475.     
    476. 

  476.     
    477. 

  477.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    478. 

  478. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    479. 

  479. 

  480.   </dd>
    481. 

  481. </div>
    482. 

  482. <div id="skipFiles">
    483. 

  483.   <dt><pre><a href="nimscript.html#skipFiles"><span class="Identifier">skipFiles</span></a><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
    484. 

  484.   <dd>
    485. 

  485.     
    486. 

  486.     
    487. 

  487.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    488. 

  488. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    489. 

  489. 

  490.   </dd>
    491. 

  491. </div>
    492. 

  492. <div id="srcDir">
    493. 

  493.   <dt><pre><a href="nimscript.html#srcDir"><span class="Identifier">srcDir</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    494. 

  494.   <dd>
    495. 

  495.     
    496. 

  496.     Nimble support: The package's source directory.
    497. 

  497.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L438" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    498. 

  498. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L438" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    499. 

  499. 

  500.   </dd>
    501. 

  501. </div>
    502. 

  502. <div id="version">
    503. 

  503.   <dt><pre><a href="nimscript.html#version"><span class="Identifier">version</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    504. 

  504.   <dd>
    505. 

  505.     
    506. 

  506.     Nimble support: The package's version.
    507. 

  507.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L434" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    508. 

  508. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L434" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    509. 

  509. 

  510.   </dd>
    511. 

  511. </div>
    512. 

  512. 

  513.   </dl>
    514. 

  514. </div>
    515. 

  515. <div class="section" id="10">
    516. 

  516.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    517. 

  517.   <dl class="item">
    518. 

  518.     <div id="buildCPU">
    519. 

  519.   <dt><pre><a href="nimscript.html#buildCPU"><span class="Identifier">buildCPU</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;BuildCPU&quot;</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span></pre></dt>
    520. 

  520.   <dd>
    521. 

  521.     
    522. 

  522.     The CPU this build is running on. Can be different from <tt class="docutils literal"><span class="pre"><span class="Identifier">system</span><span class="Operator">.</span><span class="Identifier">hostCPU</span></span></tt> for cross compilations.
    523. 

  523.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L20" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    524. 

  524. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L20" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    525. 

  525. 

  526.   </dd>
    527. 

  527. </div>
    528. 

  528. <div id="buildOS">
    529. 

  529.   <dt><pre><a href="nimscript.html#buildOS"><span class="Identifier">buildOS</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;BuildOS&quot;</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span></pre></dt>
    530. 

  530.   <dd>
    531. 

  531.     
    532. 

  532.     The OS this build is running on. Can be different from <tt class="docutils literal"><span class="pre"><span class="Identifier">system</span><span class="Operator">.</span><span class="Identifier">hostOS</span></span></tt> for cross compilations.
    533. 

  533.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L16" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    534. 

  534. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L16" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    535. 

  535. 

  536.   </dd>
    537. 

  537. </div>
    538. 

  538. 

  539.   </dl>
    540. 

  540. </div>
    541. 

  541. <div class="section" id="12">
    542. 

  542.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    543. 

  543.   <dl class="item">
    544. 

  544.     <div id="cd-procs-all">
    545. 

  545.   <div id="cd,string">
    546. 

  546.   <dt><pre><span class="Keyword">proc</span> <a href="#cd%2Cstring"><span class="Identifier">cd</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    547. 

  547.   <dd>
    548. 

  548.     
    549. 

  549.     <p>Changes the current directory.</p>
    550. 

  550. <p>The change is permanent for the rest of the execution, since this is just a shortcut for <a class="reference external" href="os.html#setCurrentDir,string">os.setCurrentDir()</a> . Use the <a class="reference external" href="#withDir.t,string,untyped">withDir()</a> template if you want to perform a temporary change only.</p>
    551. 

  551. 

  552.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L328" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    553. 

  553. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L328" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    554. 

  554. 

  555.   </dd>
    556. 

  556. </div>
    557. 

  557. 

  558. </div>
    559. 

  559. <div id="cmpic-procs-all">
    560. 

  560.   <div id="cmpic,string,string">
    561. 

  561.   <dt><pre><span class="Keyword">proc</span> <a href="#cmpic%2Cstring%2Cstring"><span class="Identifier">cmpic</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    562. 

  562.   <dd>
    563. 

  563.     
    564. 

  564.     Compares <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> ignoring case.
    565. 

  565.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L110" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    566. 

  566. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L110" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    567. 

  567. 

  568.   </dd>
    569. 

  569. </div>
    570. 

  570. 

  571. </div>
    572. 

  572. <div id="cpDir-procs-all">
    573. 

  573.   <div id="cpDir,string,string">
    574. 

  574.   <dt><pre><span class="Keyword">proc</span> <a href="#cpDir%2Cstring%2Cstring"><span class="Identifier">cpDir</span></a><span class="Other">(</span><span class="Identifier">from</span><span class="Other">,</span> <span class="Identifier">to</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    575. 

  575.                                <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    576. 

  576.   <dd>
    577. 

  577.     
    578. 

  578.     Copies the dir <tt class="docutils literal"><span class="pre"><span class="Keyword">from</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">to</span></span></tt>.
    579. 

  579.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L247" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    580. 

  580. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L247" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    581. 

  581. 

  582.   </dd>
    583. 

  583. </div>
    584. 

  584. 

  585. </div>
    586. 

  586. <div id="cpFile-procs-all">
    587. 

  587.   <div id="cpFile,string,string">
    588. 

  588.   <dt><pre><span class="Keyword">proc</span> <a href="#cpFile%2Cstring%2Cstring"><span class="Identifier">cpFile</span></a><span class="Other">(</span><span class="Identifier">from</span><span class="Other">,</span> <span class="Identifier">to</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    589. 

  589.                                 <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    590. 

  590.   <dd>
    591. 

  591.     
    592. 

  592.     Copies the file <tt class="docutils literal"><span class="pre"><span class="Keyword">from</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">to</span></span></tt>.
    593. 

  593.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L241" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    594. 

  594. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L241" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    595. 

  595. 

  596.   </dd>
    597. 

  597. </div>
    598. 

  598. 

  599. </div>
    600. 

  600. <div id="cppDefine-procs-all">
    601. 

  601.   <div id="cppDefine,string">
    602. 

  602.   <dt><pre><span class="Keyword">proc</span> <a href="#cppDefine%2Cstring"><span class="Identifier">cppDefine</span></a><span class="Other">(</span><span class="Identifier">define</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    603. 

  603.   <dd>
    604. 

  604.     
    605. 

  605.     tell Nim that <tt class="docutils literal"><span class="pre"><span class="Identifier">define</span></span></tt> is a C preprocessor <tt class="docutils literal"><span class="pre"><span class="Comment">#define</span></span></tt> and so always needs to be mangled.
    606. 

  606.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L368" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    607. 

  607. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L368" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    608. 

  608. 

  609.   </dd>
    610. 

  610. </div>
    611. 

  611. 

  612. </div>
    613. 

  613. <div id="delEnv-procs-all">
    614. 

  614.   <div id="delEnv,string">
    615. 

  615.   <dt><pre><span class="Keyword">proc</span> <a href="#delEnv%2Cstring"><span class="Identifier">delEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    616. 

  616.   <dd>
    617. 

  617.     
    618. 

  618.     Deletes the environment variable named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>.
    619. 

  619.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    620. 

  620. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    621. 

  621. 

  622.   </dd>
    623. 

  623. </div>
    624. 

  624. 

  625. </div>
    626. 

  626. <div id="dirExists-procs-all">
    627. 

  627.   <div id="dirExists,string">
    628. 

  628.   <dt><pre><span class="Keyword">proc</span> <a href="#dirExists%2Cstring"><span class="Identifier">dirExists</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    629. 

  629.                                     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    630. 

  630.   <dd>
    631. 

  631.     
    632. 

  632.     Checks if the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> exists.
    633. 

  633.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L134" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    634. 

  634. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L134" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    635. 

  635. 

  636.   </dd>
    637. 

  637. </div>
    638. 

  638. 

  639. </div>
    640. 

  640. <div id="exec-procs-all">
    641. 

  641.   <div id="exec,string">
    642. 

  642.   <dt><pre><span class="Keyword">proc</span> <a href="#exec%2Cstring"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    643. 

  643.                              <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    644. 

  644.   <dd>
    645. 

  645.     
    646. 

  646.     Executes an external process. If the external process terminates with a non-zero exit code, an OSError exception is raised. The command is executed relative to the current source path.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    647. 

  647. If you need a version of <tt class="docutils literal"><span class="pre"><span class="Identifier">exec</span></span></tt> that returns the exit code and text output of the command, you can use <a class="reference external" href="system.html#gorgeEx,string,string,string">system.gorgeEx</a>.</div>
    648. 

  648. 

  649.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L253" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    650. 

  650. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L253" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    651. 

  651. 

  652.   </dd>
    653. 

  653. </div>
    654. 

  654. <div id="exec,string,string,string">
    655. 

  655.   <dt><pre><span class="Keyword">proc</span> <a href="#exec%2Cstring%2Cstring%2Cstring"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">cache</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    656. 

  656.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    657. 

  657.   <dd>
    658. 

  658.     
    659. 

  659.     Executes an external process. If the external process terminates with a non-zero exit code, an OSError exception is raised.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    660. 

  660. This version of <tt class="docutils literal"><span class="pre"><span class="Identifier">exec</span></span></tt> is executed relative to the nimscript module path, which affects how the command resolves relative paths. Thus it is generally better to use <tt class="docutils literal"><span class="pre"><span class="Identifier">gorgeEx</span></span></tt> directly when you need more control over the execution environment or when working with commands that deal with relative paths.</div>
    661. 

  661. 

  662.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L267" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    663. 

  663. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L267" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    664. 

  664. 

  665.   </dd>
    666. 

  666. </div>
    667. 

  667. 

  668. </div>
    669. 

  669. <div id="exists-procs-all">
    670. 

  670.   <div id="exists,string">
    671. 

  671.   <dt><pre><span class="Keyword">proc</span> <a href="#exists%2Cstring"><span class="Identifier">exists</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    672. 

  672.   <dd>
    673. 

  673.     
    674. 

  674.     Checks for the existence of a configuration 'key' like 'gcc.options.always'.
    675. 

  675.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L301" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    676. 

  676. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L301" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    677. 

  677. 

  678.   </dd>
    679. 

  679. </div>
    680. 

  680. 

  681. </div>
    682. 

  682. <div id="existsEnv-procs-all">
    683. 

  683.   <div id="existsEnv,string">
    684. 

  684.   <dt><pre><span class="Keyword">proc</span> <a href="#existsEnv%2Cstring"><span class="Identifier">existsEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    685. 

  685.                                     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    686. 

  686.   <dd>
    687. 

  687.     
    688. 

  688.     Checks for the existence of an environment variable named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>.
    689. 

  689.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L118" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    690. 

  690. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L118" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    691. 

  691. 

  692.   </dd>
    693. 

  693. </div>
    694. 

  694. 

  695. </div>
    696. 

  696. <div id="fileExists-procs-all">
    697. 

  697.   <div id="fileExists,string">
    698. 

  698.   <dt><pre><span class="Keyword">proc</span> <a href="#fileExists%2Cstring"><span class="Identifier">fileExists</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    699. 

  699.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    700. 

  700.   <dd>
    701. 

  701.     
    702. 

  702.     Checks if the file exists.
    703. 

  703.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    704. 

  704. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    705. 

  705. 

  706.   </dd>
    707. 

  707. </div>
    708. 

  708. 

  709. </div>
    710. 

  710. <div id="findExe-procs-all">
    711. 

  711.   <div id="findExe,string">
    712. 

  712.   <dt><pre><span class="Keyword">proc</span> <a href="#findExe%2Cstring"><span class="Identifier">findExe</span></a><span class="Other">(</span><span class="Identifier">bin</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    713. 

  713.   <dd>
    714. 

  714.     
    715. 

  715.     Searches for bin in the current working directory and then in directories listed in the PATH environment variable. Returns &quot;&quot; if the exe cannot be found.
    716. 

  716.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L338" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    717. 

  717. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L338" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    718. 

  718. 

  719.   </dd>
    720. 

  720. </div>
    721. 

  721. 

  722. </div>
    723. 

  723. <div id="get-procs-all">
    724. 

  724.   <div id="get,string">
    725. 

  725.   <dt><pre><span class="Keyword">proc</span> <a href="#get%2Cstring"><span class="Identifier">get</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    726. 

  726.   <dd>
    727. 

  727.     
    728. 

  728.     Retrieves a configuration 'key' like 'gcc.options.always'.
    729. 

  729.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L297" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    730. 

  730. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L297" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    731. 

  731. 

  732.   </dd>
    733. 

  733. </div>
    734. 

  734. 

  735. </div>
    736. 

  736. <div id="getCommand-procs-all">
    737. 

  737.   <div id="getCommand">
    738. 

  738.   <dt><pre><span class="Keyword">proc</span> <a href="#getCommand"><span class="Identifier">getCommand</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    739. 

  739.   <dd>
    740. 

  740.     
    741. 

  741.     Gets the Nim command that the compiler has been invoked with, for example &quot;c&quot;, &quot;js&quot;, &quot;build&quot;, &quot;help&quot;.
    742. 

  742.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L97" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    743. 

  743. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L97" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    744. 

  744. 

  745.   </dd>
    746. 

  746. </div>
    747. 

  747. 

  748. </div>
    749. 

  749. <div id="getCurrentDir-procs-all">
    750. 

  750.   <div id="getCurrentDir">
    751. 

  751.   <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentDir"><span class="Identifier">getCurrentDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    752. 

  752.   <dd>
    753. 

  753.     
    754. 

  754.     Retrieves the current working directory.
    755. 

  755.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L50" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    756. 

  756. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L50" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    757. 

  757. 

  758.   </dd>
    759. 

  759. </div>
    760. 

  760. 

  761. </div>
    762. 

  762. <div id="getEnv-procs-all">
    763. 

  763.   <div id="getEnv,string,string">
    764. 

  764.   <dt><pre><span class="Keyword">proc</span> <a href="#getEnv%2Cstring%2Cstring"><span class="Identifier">getEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">default</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    765. 

  765.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    766. 

  766.   <dd>
    767. 

  767.     
    768. 

  768.     Retrieves the environment variable of name <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>.
    769. 

  769.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L114" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    770. 

  770. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L114" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    771. 

  771. 

  772.   </dd>
    773. 

  773. </div>
    774. 

  774. 

  775. </div>
    776. 

  776. <div id="hint-procs-all">
    777. 

  777.   <div id="hint,string,bool">
    778. 

  778.   <dt><pre><span class="Keyword">proc</span> <a href="#hint%2Cstring%2Cbool"><span class="Identifier">hint</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    779. 

  779.   <dd>
    780. 

  780.     
    781. 

  781.     Disables or enables a specific hint.
    782. 

  782.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    783. 

  783. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    784. 

  784. 

  785.   </dd>
    786. 

  786. </div>
    787. 

  787. 

  788. </div>
    789. 

  789. <div id="listDirs-procs-all">
    790. 

  790.   <div id="listDirs,string">
    791. 

  791.   <dt><pre><span class="Keyword">proc</span> <a href="#listDirs%2Cstring"><span class="Identifier">listDirs</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    792. 

  792.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    793. 

  793.   <dd>
    794. 

  794.     
    795. 

  795.     Lists all the subdirectories (non-recursively) in the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.
    796. 

  796.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L200" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    797. 

  797. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L200" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    798. 

  798. 

  799.   </dd>
    800. 

  800. </div>
    801. 

  801. 

  802. </div>
    803. 

  803. <div id="listFiles-procs-all">
    804. 

  804.   <div id="listFiles,string">
    805. 

  805.   <dt><pre><span class="Keyword">proc</span> <a href="#listFiles%2Cstring"><span class="Identifier">listFiles</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    806. 

  806.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    807. 

  807.   <dd>
    808. 

  808.     
    809. 

  809.     Lists all the files (non-recursively) in the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.
    810. 

  810.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L205" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    811. 

  811. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L205" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    812. 

  812. 

  813.   </dd>
    814. 

  814. </div>
    815. 

  815. 

  816. </div>
    817. 

  817. <div id="mkDir-procs-all">
    818. 

  818.   <div id="mkDir,string">
    819. 

  819.   <dt><pre><span class="Keyword">proc</span> <a href="#mkDir%2Cstring"><span class="Identifier">mkDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    820. 

  820.   <dd>
    821. 

  821.     
    822. 

  822.     Creates the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> including all necessary subdirectories. If the directory already exists, no error is raised.
    823. 

  823.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L222" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    824. 

  824. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L222" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    825. 

  825. 

  826.   </dd>
    827. 

  827. </div>
    828. 

  828. 

  829. </div>
    830. 

  830. <div id="mvDir-procs-all">
    831. 

  831.   <div id="mvDir,string,string">
    832. 

  832.   <dt><pre><span class="Keyword">proc</span> <a href="#mvDir%2Cstring%2Cstring"><span class="Identifier">mvDir</span></a><span class="Other">(</span><span class="Identifier">from</span><span class="Other">,</span> <span class="Identifier">to</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    833. 

  833.                                <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    834. 

  834.   <dd>
    835. 

  835.     
    836. 

  836.     Moves the dir <tt class="docutils literal"><span class="pre"><span class="Keyword">from</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">to</span></span></tt>.
    837. 

  837.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L235" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    838. 

  838. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L235" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    839. 

  839. 

  840.   </dd>
    841. 

  841. </div>
    842. 

  842. 

  843. </div>
    844. 

  844. <div id="mvFile-procs-all">
    845. 

  845.   <div id="mvFile,string,string">
    846. 

  846.   <dt><pre><span class="Keyword">proc</span> <a href="#mvFile%2Cstring%2Cstring"><span class="Identifier">mvFile</span></a><span class="Other">(</span><span class="Identifier">from</span><span class="Other">,</span> <span class="Identifier">to</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    847. 

  847.                                 <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    848. 

  848.   <dd>
    849. 

  849.     
    850. 

  850.     Moves the file <tt class="docutils literal"><span class="pre"><span class="Keyword">from</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">to</span></span></tt>.
    851. 

  851.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L229" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    852. 

  852. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L229" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    853. 

  853. 

  854.   </dd>
    855. 

  855. </div>
    856. 

  856. 

  857. </div>
    858. 

  858. <div id="nimcacheDir-procs-all">
    859. 

  859.   <div id="nimcacheDir">
    860. 

  860.   <dt><pre><span class="Keyword">proc</span> <a href="#nimcacheDir"><span class="Identifier">nimcacheDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    861. 

  861.   <dd>
    862. 

  862.     
    863. 

  863.     Retrieves the location of 'nimcache'.
    864. 

  864.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L306" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    865. 

  865. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L306" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    866. 

  866. 

  867.   </dd>
    868. 

  868. </div>
    869. 

  869. 

  870. </div>
    871. 

  871. <div id="paramCount-procs-all">
    872. 

  872.   <div id="paramCount">
    873. 

  873.   <dt><pre><span class="Keyword">proc</span> <a href="#paramCount"><span class="Identifier">paramCount</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    874. 

  874.   <dd>
    875. 

  875.     
    876. 

  876.     Retrieves the number of command line parameters.
    877. 

  877.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L63" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    878. 

  878. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L63" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    879. 

  879. 

  880.   </dd>
    881. 

  881. </div>
    882. 

  882. 

  883. </div>
    884. 

  884. <div id="paramStr-procs-all">
    885. 

  885.   <div id="paramStr,int">
    886. 

  886.   <dt><pre><span class="Keyword">proc</span> <a href="#paramStr%2Cint"><span class="Identifier">paramStr</span></a><span class="Other">(</span><span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    887. 

  887.   <dd>
    888. 

  888.     
    889. 

  889.     Retrieves the <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>'th command line parameter.
    890. 

  890.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    891. 

  891. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    892. 

  892. 

  893.   </dd>
    894. 

  894. </div>
    895. 

  895. 

  896. </div>
    897. 

  897. <div id="patchFile-procs-all">
    898. 

  898.   <div id="patchFile,string,string,string">
    899. 

  899.   <dt><pre><span class="Keyword">proc</span> <a href="#patchFile%2Cstring%2Cstring%2Cstring"><span class="Identifier">patchFile</span></a><span class="Other">(</span><span class="Identifier">package</span><span class="Other">,</span> <span class="Identifier">filename</span><span class="Other">,</span> <span class="Identifier">replacement</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    900. 

  900.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    901. 

  901.   <dd>
    902. 

  902.     
    903. 

  903.     <p>Overrides the location of a given file belonging to the passed package. If the <tt class="docutils literal"><span class="pre"><span class="Identifier">replacement</span></span></tt> is not an absolute path, the path is interpreted to be local to the Nimscript file that contains the call to <tt class="docutils literal"><span class="pre"><span class="Identifier">patchFile</span></span></tt>, Nim's <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">path</span></span></tt> is not used at all to resolve the filename! The compiler also performs <a class="reference external" href="nimc.html#compiler-usage-commandminusline-switches">path substitution</a> on <tt class="docutils literal"><span class="pre"><span class="Identifier">replacement</span></span></tt>.</p>
    904. 

  904. <p>Example:</p>
    905. 

  905. <p><pre class="listing"><span class="Identifier">patchFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;stdlib&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;asyncdispatch&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;patches/replacement&quot;</span><span class="Punctuation">)</span></pre></p>
    906. 

  906. 

  907.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L82" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    908. 

  908. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L82" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    909. 

  909. 

  910.   </dd>
    911. 

  911. </div>
    912. 

  912. 

  913. </div>
    914. 

  914. <div id="projectDir-procs-all">
    915. 

  915.   <div id="projectDir">
    916. 

  916.   <dt><pre><span class="Keyword">proc</span> <a href="#projectDir"><span class="Identifier">projectDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    917. 

  917.   <dd>
    918. 

  918.     
    919. 

  919.     Retrieves the absolute directory of the current project
    920. 

  920.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L314" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    921. 

  921. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L314" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    922. 

  922. 

  923.   </dd>
    924. 

  924. </div>
    925. 

  925. 

  926. </div>
    927. 

  927. <div id="projectName-procs-all">
    928. 

  928.   <div id="projectName">
    929. 

  929.   <dt><pre><span class="Keyword">proc</span> <a href="#projectName"><span class="Identifier">projectName</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    930. 

  930.   <dd>
    931. 

  931.     
    932. 

  932.     Retrieves the name of the current project
    933. 

  933.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L310" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    934. 

  934. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L310" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    935. 

  935. 

  936.   </dd>
    937. 

  937. </div>
    938. 

  938. 

  939. </div>
    940. 

  940. <div id="projectPath-procs-all">
    941. 

  941.   <div id="projectPath">
    942. 

  942.   <dt><pre><span class="Keyword">proc</span> <a href="#projectPath"><span class="Identifier">projectPath</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    943. 

  943.   <dd>
    944. 

  944.     
    945. 

  945.     Retrieves the absolute path of the current project
    946. 

  946.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L318" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    947. 

  947. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L318" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    948. 

  948. 

  949.   </dd>
    950. 

  950. </div>
    951. 

  951. 

  952. </div>
    953. 

  953. <div id="put-procs-all">
    954. 

  954.   <div id="put,string,string">
    955. 

  955.   <dt><pre><span class="Keyword">proc</span> <a href="#put%2Cstring%2Cstring"><span class="Identifier">put</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    956. 

  956.   <dd>
    957. 

  957.     
    958. 

  958.     Sets a configuration 'key' like 'gcc.options.always' to its value.
    959. 

  959.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L293" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    960. 

  960. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L293" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    961. 

  961. 

  962.   </dd>
    963. 

  963. </div>
    964. 

  964. 

  965. </div>
    966. 

  966. <div id="putEnv-procs-all">
    967. 

  967.   <div id="putEnv,string,string">
    968. 

  968.   <dt><pre><span class="Keyword">proc</span> <a href="#putEnv%2Cstring%2Cstring"><span class="Identifier">putEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    969. 

  969.   <dd>
    970. 

  970.     
    971. 

  971.     Sets the value of the environment variable named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt>.
    972. 

  972.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L122" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    973. 

  973. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L122" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    974. 

  974. 

  975.   </dd>
    976. 

  976. </div>
    977. 

  977. 

  978. </div>
    979. 

  979. <div id="readAllFromStdin-procs-all">
    980. 

  980.   <div id="readAllFromStdin">
    981. 

  981.   <dt><pre><span class="Keyword">proc</span> <a href="#readAllFromStdin"><span class="Identifier">readAllFromStdin</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    982. 

  982.                                   <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    983. 

  983.   <dd>
    984. 

  984.     
    985. 

  985.     Reads all data from stdin - blocks until EOF which happens when stdin is closed
    986. 

  986.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L387" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    987. 

  987. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L387" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    988. 

  988. 

  989.   </dd>
    990. 

  990. </div>
    991. 

  991. 

  992. </div>
    993. 

  993. <div id="readLineFromStdin-procs-all">
    994. 

  994.   <div id="readLineFromStdin">
    995. 

  995.   <dt><pre><span class="Keyword">proc</span> <a href="#readLineFromStdin"><span class="Identifier">readLineFromStdin</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    996. 

  996.                                    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    997. 

  997.   <dd>
    998. 

  998.     
    999. 

  999.     Reads a line of data from stdin - blocks until n or EOF which happens when stdin is closed
    1000. 

  1000.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1001. 

  1001. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1002. 

  1002. 

  1003.   </dd>
    1004. 

  1004. </div>
    1005. 

  1005. 

  1006. </div>
    1007. 

  1007. <div id="requires-procs-all">
    1008. 

  1008.   <div id="requires,varargs[string]">
    1009. 

  1009.   <dt><pre><span class="Keyword">proc</span> <a href="#requires%2Cvarargs%5Bstring%5D"><span class="Identifier">requires</span></a><span class="Other">(</span><span class="Identifier">deps</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1010. 

  1010.   <dd>
    1011. 

  1011.     
    1012. 

  1012.     Nimble support: Call this to set the list of requirements of your Nimble package.
    1013. 

  1013.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L447" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1014. 

  1014. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L447" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1015. 

  1015. 

  1016.   </dd>
    1017. 

  1017. </div>
    1018. 

  1018. 

  1019. </div>
    1020. 

  1020. <div id="rmDir-procs-all">
    1021. 

  1021.   <div id="rmDir,string">
    1022. 

  1022.   <dt><pre><span class="Keyword">proc</span> <a href="#rmDir%2Cstring"><span class="Identifier">rmDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">checkDir</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    1023. 

  1023.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1024. 

  1024.   <dd>
    1025. 

  1025.     
    1026. 

  1026.     Removes the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.
    1027. 

  1027.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L210" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1028. 

  1028. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L210" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1029. 

  1029. 

  1030.   </dd>
    1031. 

  1031. </div>
    1032. 

  1032. 

  1033. </div>
    1034. 

  1034. <div id="rmFile-procs-all">
    1035. 

  1035.   <div id="rmFile,string">
    1036. 

  1036.   <dt><pre><span class="Keyword">proc</span> <a href="#rmFile%2Cstring"><span class="Identifier">rmFile</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    1037. 

  1037.                             <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1038. 

  1038.   <dd>
    1039. 

  1039.     
    1040. 

  1040.     Removes the <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>.
    1041. 

  1041.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L216" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1042. 

  1042. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L216" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1043. 

  1043. 

  1044.   </dd>
    1045. 

  1045. </div>
    1046. 

  1046. 

  1047. </div>
    1048. 

  1048. <div id="selfExe-procs-all">
    1049. 

  1049.   <div id="selfExe">
    1050. 

  1050.   <dt><pre><span class="Keyword">proc</span> <a href="#selfExe"><span class="Identifier">selfExe</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;Deprecated since v1.7; Use getCurrentCompilerExe&quot;</span><span class="Other">,</span>
    1051. 

  1051.                          <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1052. 

  1052.   <dd>
    1053. 

  1053.     <div class="deprecation-message">
    1054. 

  1054.   <b>Deprecated:</b> Deprecated since v1.7; Use getCurrentCompilerExe
    1055. 

  1055. </div>
    1056. 

  1056. 

  1057.     Returns the currently running nim or nimble executable.
    1058. 

  1058.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L139" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1059. 

  1059. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L139" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1060. 

  1060. 

  1061.   </dd>
    1062. 

  1062. </div>
    1063. 

  1063. 

  1064. </div>
    1065. 

  1065. <div id="selfExec-procs-all">
    1066. 

  1066.   <div id="selfExec,string">
    1067. 

  1067.   <dt><pre><span class="Keyword">proc</span> <a href="#selfExec%2Cstring"><span class="Identifier">selfExec</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    1068. 

  1068.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    1069. 

  1069.                                  <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1070. 

  1070.   <dd>
    1071. 

  1071.     
    1072. 

  1072.     Executes an external command with the current nim/nimble executable. <tt class="docutils literal"><span class="pre"><span class="Identifier">Command</span></span></tt> must not contain the &quot;nim &quot; part.
    1073. 

  1073.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L283" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1074. 

  1074. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L283" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1075. 

  1075. 

  1076.   </dd>
    1077. 

  1077. </div>
    1078. 

  1078. 

  1079. </div>
    1080. 

  1080. <div id="setCommand-procs-all">
    1081. 

  1081.   <div id="setCommand,string,string">
    1082. 

  1082.   <dt><pre><span class="Keyword">proc</span> <a href="#setCommand%2Cstring%2Cstring"><span class="Identifier">setCommand</span></a><span class="Other">(</span><span class="Identifier">cmd</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">project</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1083. 

  1083.   <dd>
    1084. 

  1084.     
    1085. 

  1085.     Sets the Nim command that should be continued with after this Nimscript has finished.
    1086. 

  1086.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L102" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1087. 

  1087. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L102" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1088. 

  1088. 

  1089.   </dd>
    1090. 

  1090. </div>
    1091. 

  1091. 

  1092. </div>
    1093. 

  1093. <div id="switch-procs-all">
    1094. 

  1094.   <div id="switch,string,string">
    1095. 

  1095.   <dt><pre><span class="Keyword">proc</span> <a href="#switch%2Cstring%2Cstring"><span class="Identifier">switch</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">val</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1096. 

  1096.   <dd>
    1097. 

  1097.     
    1098. 

  1098.     Sets a Nim compiler command line switch, for example <tt class="docutils literal"><span class="pre"><span class="Identifier">switch</span><span class="Punctuation">(</span><span class="StringLit">&quot;checks&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;on&quot;</span><span class="Punctuation">)</span></span></tt>.
    1099. 

  1099.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L67" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1100. 

  1100. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L67" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1101. 

  1101. 

  1102.   </dd>
    1103. 

  1103. </div>
    1104. 

  1104. 

  1105. </div>
    1106. 

  1106. <div id="thisDir-procs-all">
    1107. 

  1107.   <div id="thisDir">
    1108. 

  1108.   <dt><pre><span class="Keyword">proc</span> <a href="#thisDir"><span class="Identifier">thisDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1109. 

  1109.   <dd>
    1110. 

  1110.     
    1111. 

  1111.     Retrieves the directory of the current <tt class="docutils literal"><span class="pre"><span class="Identifier">nims</span></span></tt> script file. Its path is obtained via <tt class="docutils literal"><span class="pre"><span class="Identifier">currentSourcePath</span></span></tt> (although, currently, <tt class="docutils literal"><span class="pre"><span class="Identifier">currentSourcePath</span></span></tt> resolves symlinks, unlike <tt class="docutils literal"><span class="pre"><span class="Identifier">thisDir</span></span></tt>).
    1112. 

  1112.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L322" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1113. 

  1113. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L322" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1114. 

  1114. 

  1115.   </dd>
    1116. 

  1116. </div>
    1117. 

  1117. 

  1118. </div>
    1119. 

  1119. <div id="toDll-procs-all">
    1120. 

  1120.   <div id="toDll,string">
    1121. 

  1121.   <dt><pre><span class="Keyword">proc</span> <a href="#toDll%2Cstring"><span class="Identifier">toDll</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1122. 

  1122.   <dd>
    1123. 

  1123.     
    1124. 

  1124.     On Windows adds &quot;.dll&quot; to <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>, on Posix produces &quot;lib$filename.so&quot;.
    1125. 

  1125.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L147" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1126. 

  1126. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L147" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1127. 

  1127. 

  1128.   </dd>
    1129. 

  1129. </div>
    1130. 

  1130. 

  1131. </div>
    1132. 

  1132. <div id="toExe-procs-all">
    1133. 

  1133.   <div id="toExe,string">
    1134. 

  1134.   <dt><pre><span class="Keyword">proc</span> <a href="#toExe%2Cstring"><span class="Identifier">toExe</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1135. 

  1135.   <dd>
    1136. 

  1136.     
    1137. 

  1137.     On Windows adds &quot;.exe&quot; to <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>, else returns <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> unmodified.
    1138. 

  1138.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L143" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1139. 

  1139. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L143" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1140. 

  1140. 

  1141.   </dd>
    1142. 

  1142. </div>
    1143. 

  1143. 

  1144. </div>
    1145. 

  1145. <div id="warning-procs-all">
    1146. 

  1146.   <div id="warning,string,bool">
    1147. 

  1147.   <dt><pre><span class="Keyword">proc</span> <a href="#warning%2Cstring%2Cbool"><span class="Identifier">warning</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1148. 

  1148.   <dd>
    1149. 

  1149.     
    1150. 

  1150.     Disables or enables a specific warning.
    1151. 

  1151.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L72" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1152. 

  1152. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L72" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1153. 

  1153. 

  1154.   </dd>
    1155. 

  1155. </div>
    1156. 

  1156. 

  1157. </div>
    1158. 

  1158. 

  1159.   </dl>
    1160. 

  1160. </div>
    1161. 

  1161. <div class="section" id="18">
    1162. 

  1162.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    1163. 

  1163.   <dl class="item">
    1164. 

  1164.     <div id="---templates-all">
    1165. 

  1165.   <div id="--.t,untyped,untyped">
    1166. 

  1166.   <dt><pre><span class="Keyword">template</span> <a href="#--.t%2Cuntyped%2Cuntyped"><span class="Identifier">`--`</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span></pre></dt>
    1167. 

  1167.   <dd>
    1168. 

  1168.     
    1169. 

  1169.     <p>A shortcut for <a class="reference external" href="#switch,string,string">switch</a> Example:</p>
    1170. 

  1170. <p><pre class="listing"><span class="Operator">--</span><span class="Identifier">path</span><span class="Punctuation">:</span><span class="Identifier">somePath</span> <span class="Comment"># same as switch(&quot;path&quot;, &quot;somePath&quot;)</span>
    1171. 

  1171. <span class="Operator">--</span><span class="Identifier">path</span><span class="Punctuation">:</span><span class="StringLit">&quot;someOtherPath&quot;</span> <span class="Comment"># same as switch(&quot;path&quot;, &quot;someOtherPath&quot;)</span>
    1172. 

  1172. <span class="Operator">--</span><span class="Identifier">hint</span><span class="Punctuation">:</span><span class="StringLit">&quot;[Conf]:off&quot;</span> <span class="Comment"># same as switch(&quot;hint&quot;, &quot;[Conf]:off&quot;)</span></pre></p>
    1173. 

  1173. 

  1174.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L158" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1175. 

  1175. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L158" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1176. 

  1176. 

  1177.   </dd>
    1178. 

  1178. </div>
    1179. 

  1179. <div id="--.t,untyped">
    1180. 

  1180.   <dt><pre><span class="Keyword">template</span> <a href="#--.t%2Cuntyped"><span class="Identifier">`--`</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span></pre></dt>
    1181. 

  1181.   <dd>
    1182. 

  1182.     
    1183. 

  1183.     <p>A shortcut for <a class="reference external" href="#switch,string,string">switch</a> Example:</p>
    1184. 

  1184. <p><pre class="listing"><span class="Operator">--</span><span class="Identifier">listCmd</span> <span class="Comment"># same as switch(&quot;listCmd&quot;)</span></pre></p>
    1185. 

  1185. 

  1186.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L168" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1187. 

  1187. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L168" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1188. 

  1188. 

  1189.   </dd>
    1190. 

  1190. </div>
    1191. 

  1191. 

  1192. </div>
    1193. 

  1193. <div id="task-templates-all">
    1194. 

  1194.   <div id="task.t,untyped,string,untyped">
    1195. 

  1195.   <dt><pre><span class="Keyword">template</span> <a href="#task.t%2Cuntyped%2Cstring%2Cuntyped"><span class="Identifier">task</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">;</span> <span class="Identifier">description</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    1196. 

  1196.   <dd>
    1197. 

  1197.     
    1198. 

  1198.     <p>Defines a task. Hidden tasks are supported via an empty description.</p>
    1199. 

  1199. <p>Example:</p>
    1200. 

  1200. <p><pre class="listing"><span class="Identifier">task</span> <span class="Identifier">build</span><span class="Punctuation">,</span> <span class="StringLit">&quot;default build is via the C backend&quot;</span><span class="Punctuation">:</span>
    1201. 

  1201.   <span class="Identifier">setCommand</span> <span class="StringLit">&quot;c&quot;</span></pre></p>
    1202. 

  1202. <p>For a task named <tt class="docutils literal"><span class="pre"><span class="Identifier">foo</span></span></tt>, this template generates a <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span></span></tt> named <tt class="docutils literal"><span class="pre"><span class="Identifier">fooTask</span></span></tt>.  This is useful if you need to call one task in another in your Nimscript.</p>
    1203. 

  1203. <p>Example:</p>
    1204. 

  1204. <p><pre class="listing"><span class="Identifier">task</span> <span class="Identifier">foo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">:</span>        <span class="Comment"># &gt; nim foo</span>
    1205. 

  1205.   <span class="Identifier">echo</span> <span class="StringLit">&quot;Running foo&quot;</span>    <span class="Comment"># Running foo</span>
    1206. 

  1206. 

  1207. <span class="Identifier">task</span> <span class="Identifier">bar</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bar&quot;</span><span class="Punctuation">:</span>        <span class="Comment"># &gt; nim bar</span>
    1208. 

  1208.   <span class="Identifier">echo</span> <span class="StringLit">&quot;Running bar&quot;</span>    <span class="Comment"># Running bar</span>
    1209. 

  1209.   <span class="Identifier">fooTask</span><span class="Punctuation">(</span><span class="Punctuation">)</span>             <span class="Comment"># Running foo</span></pre></p>
    1210. 

  1210. 

  1211.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L395" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1212. 

  1212. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L395" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1213. 

  1213. 

  1214.   </dd>
    1215. 

  1215. </div>
    1216. 

  1216. 

  1217. </div>
    1218. 

  1218. <div id="withDir-templates-all">
    1219. 

  1219.   <div id="withDir.t,string,untyped">
    1220. 

  1220.   <dt><pre><span class="Keyword">template</span> <a href="#withDir.t%2Cstring%2Cuntyped"><span class="Identifier">withDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    1221. 

  1221.   <dd>
    1222. 

  1222.     
    1223. 

  1223.     <p>Changes the current directory temporarily.</p>
    1224. 

  1224. <p>If you need a permanent change, use the <a class="reference external" href="#cd,string">cd()</a> proc. Usage example:</p>
    1225. 

  1225. <p><pre class="listing"><span class="Comment"># inside /some/path/</span>
    1226. 

  1226. <span class="Identifier">withDir</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">:</span>
    1227. 

  1227.   <span class="Comment"># move to /some/path/foo/</span>
    1228. 

  1228. <span class="Comment"># back in /some/path/</span></pre></p>
    1229. 

  1229. 

  1230.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/nimscript.nim#L344" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1231. 

  1231. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/nimscript.nim#L344" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1232. 

  1232. 

  1233.   </dd>
    1234. 

  1234. </div>
    1235. 

  1235. 

  1236. </div>
    1237. 

  1237. 

  1238.   </dl>
    1239. 

  1239. </div>
    1240. 

  1240. 

  1241.   </div>
    1242. 

  1242. </div>
    1243. 

  1243. 

  1244.       <div class="twelve-columns footer">
    1245. 

  1245.         <span class="nim-sprite"></span>
    1246. 

  1246.         <br>
    1247. 

  1247.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-01-09 12:00:25 UTC</small>
    1248. 

  1248.       </div>
    1249. 

  1249.     </div>
    1250. 

  1250.   </div>
    1251. 

  1251.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1252. 

  1252.     
    1253. 

  1253. </body>
    1254. 

  1254. </html>
    1255. 

  1255.