ホーム エクスプローラ ヘルプ
サインイン
levovix
/
Nim
同期ミラー https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
ファイル 課題 0 Wiki
ブランチ: gh-pages
ブランチ タグ
Nim
/
os.html

os.html 102 KB
パーマリンク 履歴 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977 
  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>std/os</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">std/os</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.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    56. 

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#DeviceId" title="DeviceId = Dev">DeviceId</a></li>
    62. 

  62. <li><a class="reference" href="#FileId" title="FileId = Ino">FileId</a></li>
    63. 

  63. <li><a class="reference" href="#FileInfo" title="FileInfo = object
    64. 

  64.   id*: tuple[device: DeviceId, file: FileId] ## Device and file id.
    65. 

  65.   kind*: PathComponent       ## Kind of file object - directory, symlink, etc.
    66. 

  66.   size*: BiggestInt          ## Size of file.
    67. 

  67.   permissions*: set[FilePermission] ## File permissions
    68. 

  68.   linkCount*: BiggestInt     ## Number of hard links the file object has.
    69. 

  69.   lastAccessTime*: times.Time ## Time file was last accessed.
    70. 

  70.   lastWriteTime*: times.Time ## Time file was last modified/written to.
    71. 

  71.   creationTime*: times.Time  ## Time file was created. Not supported on all systems!
    72. 

  72.   blockSize*: int            ## Preferred I/O block size for this object.
    73. 

  73.                              ## In some filesystems, this may vary from file to file.
    74. 

  74.   isSpecial*: bool           ## Is file special? (on Unix some &quot;files&quot;
    75. 

  75.                              ## can be special=non-regular like FIFOs,
    76. 

  76.                              ## devices); for directories `isSpecial`
    77. 

  77.                              ## is always `false`, for symlinks it is
    78. 

  78.                              ## the same as for the link's target.">FileInfo</a></li>
    79. 

  79. 

  80.     </ul>
    81. 

  81.   </details>
    82. 

  82. </li>
    83. 

  83. <li>
    84. 

  84.   <details open>
    85. 

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

  86.     <ul class="simple simple-toc-section">
    87. 

  87.       <li><a class="reference" href="#ExeExts" title="ExeExts = [&quot;&quot;]">ExeExts</a></li>
    88. 

  88. <li><a class="reference" href="#invalidFilenameChars" title="invalidFilenameChars = {'/', '\\', ':', '*', '?', '\&quot;', '&lt;', '&gt;', '|', '^',
    89. 

  89.                         '\x00'}">invalidFilenameChars</a></li>
    90. 

  90. <li><a class="reference" href="#invalidFilenames" title="invalidFilenames = [&quot;CON&quot;, &quot;PRN&quot;, &quot;AUX&quot;, &quot;NUL&quot;, &quot;COM0&quot;, &quot;COM1&quot;, &quot;COM2&quot;, &quot;COM3&quot;,
    91. 

  91.                     &quot;COM4&quot;, &quot;COM5&quot;, &quot;COM6&quot;, &quot;COM7&quot;, &quot;COM8&quot;, &quot;COM9&quot;, &quot;LPT0&quot;,
    92. 

  92.                     &quot;LPT1&quot;, &quot;LPT2&quot;, &quot;LPT3&quot;, &quot;LPT4&quot;, &quot;LPT5&quot;, &quot;LPT6&quot;, &quot;LPT7&quot;,
    93. 

  93.                     &quot;LPT8&quot;, &quot;LPT9&quot;]">invalidFilenames</a></li>
    94. 

  94. 

  95.     </ul>
    96. 

  96.   </details>
    97. 

  97. </li>
    98. 

  98. <li>
    99. 

  99.   <details open>
    100. 

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

  101.     <ul class="simple simple-toc-section">
    102. 

  102.       <ul class="simple nested-toc-section">createHardlink
    103. 

  103.   <li><a class="reference" href="#createHardlink%2Cstring%2Cstring" title="createHardlink(src, dest: string)">createHardlink(src, dest: string)</a></li>
    104. 

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#exclFilePermissions%2Cstring%2Cset%5BFilePermission%5D" title="exclFilePermissions(filename: string; permissions: set[FilePermission])">exclFilePermissions(filename: string; permissions: set[FilePermission])</a></li>
    108. 

  108. 

  109. </ul>
    110. 

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

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

  112. 

  113. </ul>
    114. 

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

  115.   <li><a class="reference" href="#exitStatusLikeShell%2Ccint" title="exitStatusLikeShell(status: cint): cint">exitStatusLikeShell(status: cint): cint</a></li>
    116. 

  116. 

  117. </ul>
    118. 

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

  119.   <li><a class="reference" href="#expandFilename%2Cstring" title="expandFilename(filename: string): string">expandFilename(filename: string): string</a></li>
    120. 

  120. 

  121. </ul>
    122. 

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

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

  124. 

  125. </ul>
    126. 

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

  127.   <li><a class="reference" href="#fileNewer%2Cstring%2Cstring" title="fileNewer(a, b: string): bool">fileNewer(a, b: string): bool</a></li>
    128. 

  128. 

  129. </ul>
    130. 

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

  131.   <li><a class="reference" href="#findExe%2Cstring%2Cbool%2CopenArray%5Bstring%5D" title="findExe(exe: string; followSymlinks: bool = true;
    132. 

  132.         extensions: openArray[string] = ExeExts): string">findExe(exe: string; followSymlinks: bool = true;
    133. 

  133.         extensions: openArray[string] = ExeExts): string</a></li>
    134. 

  134. 

  135. </ul>
    136. 

  136. <ul class="simple nested-toc-section">getAppDir
    137. 

  137.   <li><a class="reference" href="#getAppDir" title="getAppDir(): string">getAppDir(): string</a></li>
    138. 

  138. 

  139. </ul>
    140. 

  140. <ul class="simple nested-toc-section">getAppFilename
    141. 

  141.   <li><a class="reference" href="#getAppFilename" title="getAppFilename(): string">getAppFilename(): string</a></li>
    142. 

  142. 

  143. </ul>
    144. 

  144. <ul class="simple nested-toc-section">getCreationTime
    145. 

  145.   <li><a class="reference" href="#getCreationTime%2Cstring" title="getCreationTime(file: string): times.Time">getCreationTime(file: string): times.Time</a></li>
    146. 

  146. 

  147. </ul>
    148. 

  148. <ul class="simple nested-toc-section">getCurrentCompilerExe
    149. 

  149.   <li><a class="reference" href="#getCurrentCompilerExe" title="getCurrentCompilerExe(): string">getCurrentCompilerExe(): string</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">getCurrentProcessId
    153. 

  153.   <li><a class="reference" href="#getCurrentProcessId" title="getCurrentProcessId(): int">getCurrentProcessId(): int</a></li>
    154. 

  154. 

  155. </ul>
    156. 

  156. <ul class="simple nested-toc-section">getFileInfo
    157. 

  157.   <li><a class="reference" href="#getFileInfo%2CFile" title="getFileInfo(file: File): FileInfo">getFileInfo(file: File): FileInfo</a></li>
    158. 

  158. <li><a class="reference" href="#getFileInfo%2CFileHandle" title="getFileInfo(handle: FileHandle): FileInfo">getFileInfo(handle: FileHandle): FileInfo</a></li>
    159. 

  159. <li><a class="reference" href="#getFileInfo%2Cstring" title="getFileInfo(path: string; followSymlink = true): FileInfo">getFileInfo(path: string; followSymlink = true): FileInfo</a></li>
    160. 

  160. 

  161. </ul>
    162. 

  162. <ul class="simple nested-toc-section">getFileSize
    163. 

  163.   <li><a class="reference" href="#getFileSize%2Cstring" title="getFileSize(file: string): BiggestInt">getFileSize(file: string): BiggestInt</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">getLastAccessTime
    167. 

  167.   <li><a class="reference" href="#getLastAccessTime%2Cstring" title="getLastAccessTime(file: string): times.Time">getLastAccessTime(file: string): times.Time</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">getLastModificationTime
    171. 

  171.   <li><a class="reference" href="#getLastModificationTime%2Cstring" title="getLastModificationTime(file: string): times.Time">getLastModificationTime(file: string): times.Time</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">inclFilePermissions
    175. 

  175.   <li><a class="reference" href="#inclFilePermissions%2Cstring%2Cset%5BFilePermission%5D" title="inclFilePermissions(filename: string; permissions: set[FilePermission])">inclFilePermissions(filename: string; permissions: set[FilePermission])</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">isAdmin
    179. 

  179.   <li><a class="reference" href="#isAdmin" title="isAdmin(): bool">isAdmin(): bool</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">isHidden
    183. 

  183.   <li><a class="reference" href="#isHidden%2Cstring" title="isHidden(path: string): bool">isHidden(path: string): bool</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">isValidFilename
    187. 

  187.   <li><a class="reference" href="#isValidFilename%2Cstring" title="isValidFilename(filename: string; maxLen = 259.Positive): bool">isValidFilename(filename: string; maxLen = 259.Positive): bool</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">quoteShell
    191. 

  191.   <li><a class="reference" href="#quoteShell%2Cstring" title="quoteShell(s: string): string">quoteShell(s: string): string</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">quoteShellCommand
    195. 

  195.   <li><a class="reference" href="#quoteShellCommand%2CopenArray%5Bstring%5D" title="quoteShellCommand(args: openArray[string]): string">quoteShellCommand(args: openArray[string]): string</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">quoteShellPosix
    199. 

  199.   <li><a class="reference" href="#quoteShellPosix%2Cstring" title="quoteShellPosix(s: string): string">quoteShellPosix(s: string): string</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">quoteShellWindows
    203. 

  203.   <li><a class="reference" href="#quoteShellWindows%2Cstring" title="quoteShellWindows(s: string): string">quoteShellWindows(s: string): string</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. <ul class="simple nested-toc-section">sameFileContent
    207. 

  207.   <li><a class="reference" href="#sameFileContent%2Cstring%2Cstring" title="sameFileContent(path1, path2: string): bool">sameFileContent(path1, path2: string): bool</a></li>
    208. 

  208. 

  209. </ul>
    210. 

  210. <ul class="simple nested-toc-section">setLastModificationTime
    211. 

  211.   <li><a class="reference" href="#setLastModificationTime%2Cstring%2C" title="setLastModificationTime(file: string; t: times.Time)">setLastModificationTime(file: string; t: times.Time)</a></li>
    212. 

  212. 

  213. </ul>
    214. 

  214. <ul class="simple nested-toc-section">sleep
    215. 

  215.   <li><a class="reference" href="#sleep%2Cint" title="sleep(milsecs: int)">sleep(milsecs: int)</a></li>
    216. 

  216. 

  217. </ul>
    218. 

  218. 

  219.     </ul>
    220. 

  220.   </details>
    221. 

  221. </li>
    222. 

  222. <li>
    223. 

  223.   <details open>
    224. 

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

  225.     <ul class="simple simple-toc-section">
    226. 

  226.       <ul class="simple nested-toc-section">existsDir
    227. 

  227.   <li><a class="reference" href="#existsDir.t%2Cvarargs%5Buntyped%5D" title="existsDir(args: varargs[untyped]): untyped">existsDir(args: varargs[untyped]): untyped</a></li>
    228. 

  228. 

  229. </ul>
    230. 

  230. <ul class="simple nested-toc-section">existsFile
    231. 

  231.   <li><a class="reference" href="#existsFile.t%2Cvarargs%5Buntyped%5D" title="existsFile(args: varargs[untyped]): untyped">existsFile(args: varargs[untyped]): untyped</a></li>
    232. 

  232. 

  233. </ul>
    234. 

  234. 

  235.     </ul>
    236. 

  236.   </details>
    237. 

  237. </li>
    238. 

  238. 

  239. </ul>
    240. 

  240. 

  241.   </div>
    242. 

  242.   <div class="nine columns" id="content">
    243. 

  243.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    244. 

  244. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    245. 

  245. 

  246.     <div id="tocRoot"></div>
    247. 

  247.     
    248. 

  248.     <p class="module-desc">This module contains basic operating system facilities like retrieving environment variables, working with directories, running shell commands, etc.
    249. 

  249. <p><strong class="examples_text">Example:</strong></p>
    250. 

  250. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span>
    251. 

  251. <span class="Keyword">let</span> <span class="Identifier">myFile</span> <span class="Operator">=</span> <span class="StringLit">&quot;/path/to/my/file.nim&quot;</span>
    252. 

  252. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="Identifier">myFile</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="Identifier">head</span><span class="Punctuation">:</span> <span class="StringLit">&quot;/path/to/my&quot;</span><span class="Punctuation">,</span> <span class="Identifier">tail</span><span class="Punctuation">:</span> <span class="StringLit">&quot;file.nim&quot;</span><span class="Punctuation">)</span>
    253. 

  253. <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    254. 

  254.   <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="Identifier">myFile</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/path/to/my&quot;</span>
    255. 

  255. <span class="Identifier">assert</span> <span class="Identifier">splitFile</span><span class="Punctuation">(</span><span class="Identifier">myFile</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">:</span> <span class="StringLit">&quot;/path/to/my&quot;</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">:</span> <span class="StringLit">&quot;file&quot;</span><span class="Punctuation">,</span> <span class="Identifier">ext</span><span class="Punctuation">:</span> <span class="StringLit">&quot;.nim&quot;</span><span class="Punctuation">)</span>
    256. 

  256. <span class="Identifier">assert</span> <span class="Identifier">myFile</span><span class="Operator">.</span><span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;c&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/path/to/my/file.c&quot;</span></pre><strong>See also:</strong><ul class="simple"><li><a class="reference external" href="paths.html">paths</a> and <a class="reference external" href="files.html">files</a> modules for high-level file manipulation</li>
    257. 

  257. <li><a class="reference external" href="osproc.html">osproc module</a> for process communication beyond <a class="reference internal nimdoc" title="proc execShellCmd(command: string): int" href="#execShellCmd,string">execShellCmd proc</a></li>
    258. 

  258. <li><a class="reference external" href="uri.html">uri module</a></li>
    259. 

  259. <li><a class="reference external" href="distros.html">distros module</a></li>
    260. 

  260. <li><a class="reference external" href="dynlib.html">dynlib module</a></li>
    261. 

  261. <li><a class="reference external" href="streams.html">streams module</a></li>
    262. 

  262. </ul>
    263. 

  263. </p>
    264. 

  264.     <div class="section" id="6">
    265. 

  265.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    266. 

  266.   <dl class="item">
    267. 

  267.     <a class="reference external" href="ospaths2.html">ospaths2</a>, <a class="reference external" href="osfiles.html">osfiles</a>, <a class="reference external" href="osdirs.html">osdirs</a>, <a class="reference external" href="ossymlinks.html">ossymlinks</a>, <a class="reference external" href="osappdirs.html">osappdirs</a>, <a class="reference external" href="oscommon.html">oscommon</a>, <a class="reference external" href="since.html">since</a>, <a class="reference external" href="cmdline.html">cmdline</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="pathnorm.html">pathnorm</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="widestrs.html">widestrs</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="oserrors.html">oserrors</a>, <a class="reference external" href="envvars.html">envvars</a>, <a class="reference external" href="osseps.html">osseps</a>
    268. 

  268.   </dl>
    269. 

  269. </div>
    270. 

  270. <div class="section" id="7">
    271. 

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

  272.   <dl class="item">
    273. 

  273.     <div id="DeviceId">
    274. 

  274.   <dt><pre><a href="os.html#DeviceId"><span class="Identifier">DeviceId</span></a> <span class="Other">=</span> <a href="posix.html#Dev"><span class="Identifier">Dev</span></a></pre></dt>
    275. 

  275.   <dd>
    276. 

  276.     
    277. 

  277.     
    278. 

  278.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L731" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    279. 

  279. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L731" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    280. 

  280. 

  281.   </dd>
    282. 

  282. </div>
    283. 

  283. <div id="FileId">
    284. 

  284.   <dt><pre><a href="os.html#FileId"><span class="Identifier">FileId</span></a> <span class="Other">=</span> <a href="posix.html#Ino"><span class="Identifier">Ino</span></a></pre></dt>
    285. 

  285.   <dd>
    286. 

  286.     
    287. 

  287.     
    288. 

  288.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L732" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    289. 

  289. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L732" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    290. 

  290. 

  291.   </dd>
    292. 

  292. </div>
    293. 

  293. <div id="FileInfo">
    294. 

  294.   <dt><pre><a href="os.html#FileInfo"><span class="Identifier">FileInfo</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    295. 

  295.   <span class="Identifier">id</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">device</span><span class="Other">:</span> <a href="os.html#DeviceId"><span class="Identifier">DeviceId</span></a><span class="Other">,</span> <span class="Identifier">file</span><span class="Other">:</span> <a href="os.html#FileId"><span class="Identifier">FileId</span></a><span class="Other">]</span> <span class="Comment">## Device and file id.</span>
    296. 

  296.   <span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="oscommon.html#PathComponent"><span class="Identifier">PathComponent</span></a>       <span class="Comment">## Kind of file object - directory, symlink, etc.</span>
    297. 

  297.   <span class="Identifier">size</span><span class="Operator">*</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a>          <span class="Comment">## Size of file.</span>
    298. 

  298.   <span class="Identifier">permissions</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osfiles.html#FilePermission"><span class="Identifier">FilePermission</span></a><span class="Other">]</span> <span class="Comment">## File permissions</span>
    299. 

  299.   <span class="Identifier">linkCount</span><span class="Operator">*</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a>     <span class="Comment">## Number of hard links the file object has.</span>
    300. 

  300.   <span class="Identifier">lastAccessTime</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span> <span class="Comment">## Time file was last accessed.</span>
    301. 

  301.   <span class="Identifier">lastWriteTime</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span> <span class="Comment">## Time file was last modified/written to.</span>
    302. 

  302.   <span class="Identifier">creationTime</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span>  <span class="Comment">## Time file was created. Not supported on all systems!</span>
    303. 

  303.   <span class="Identifier">blockSize</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>            <span class="Comment">## Preferred I/O block size for this object.</span>
    304. 

  304.                              <span class="Comment">## In some filesystems, this may vary from file to file.</span>
    305. 

  305.   <span class="Identifier">isSpecial</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>           <span class="Comment">## Is file special? (on Unix some &quot;files&quot;</span>
    306. 

  306.                              <span class="Comment">## can be special=non-regular like FIFOs,</span>
    307. 

  307.                              <span class="Comment">## devices); for directories `isSpecial`</span>
    308. 

  308.                              <span class="Comment">## is always `false`, for symlinks it is</span>
    309. 

  309.                              <span class="Comment">## the same as for the link's target.</span></pre></dt>
    310. 

  310.   <dd>
    311. 

  311.     
    312. 

  312.     <p>Contains information associated with a file object.</p>
    313. 

  313. <p>See also:</p>
    314. 

  314. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getFileInfo(handle: FileHandle): FileInfo" href="#getFileInfo,FileHandle">getFileInfo(handle) proc</a></li>
    315. 

  315. <li><a class="reference internal nimdoc" title="proc getFileInfo(file: File): FileInfo" href="#getFileInfo,File">getFileInfo(file) proc</a></li>
    316. 

  316. <li><a class="reference internal nimdoc" title="proc getFileInfo(path: string; followSymlink = true): FileInfo" href="#getFileInfo,string">getFileInfo(path, followSymlink) proc</a></li>
    317. 

  317. </ul>
    318. 

  318. 

  319.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L735" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    320. 

  320. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L735" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    321. 

  321. 

  322.   </dd>
    323. 

  323. </div>
    324. 

  324. 

  325.   </dl>
    326. 

  326. </div>
    327. 

  327. <div class="section" id="10">
    328. 

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

  329.   <dl class="item">
    330. 

  330.     <div id="ExeExts">
    331. 

  331.   <dt><pre><a href="os.html#ExeExts"><span class="Identifier">ExeExts</span></a> <span class="Other">=</span> <span class="Other">[</span><span class="StringLit">&quot;&quot;</span><span class="Other">]</span></pre></dt>
    332. 

  332.   <dd>
    333. 

  333.     
    334. 

  334.     Platform specific file extension for executables. On Windows <tt class="docutils literal"><span class="pre">[&quot;exe&quot;, &quot;cmd&quot;, &quot;bat&quot;]</span></tt>, on Posix <tt class="docutils literal"><span class="pre">[&quot;&quot;]</span></tt>.
    335. 

  335.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L220" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    336. 

  336. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L220" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    337. 

  337. 

  338.   </dd>
    339. 

  339. </div>
    340. 

  340. <div id="invalidFilenameChars">
    341. 

  341.   <dt><pre><a href="os.html#invalidFilenameChars"><span class="Identifier">invalidFilenameChars</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="CharLit">'/'</span><span class="Other">,</span> <span class="CharLit">'\\'</span><span class="Other">,</span> <span class="CharLit">':'</span><span class="Other">,</span> <span class="CharLit">'*'</span><span class="Other">,</span> <span class="CharLit">'?'</span><span class="Other">,</span> <span class="CharLit">'\&quot;'</span><span class="Other">,</span> <span class="CharLit">'&lt;'</span><span class="Other">,</span> <span class="CharLit">'&gt;'</span><span class="Other">,</span> <span class="CharLit">'|'</span><span class="Other">,</span> <span class="CharLit">'^'</span><span class="Other">,</span>
    342. 

  342.                         <span class="CharLit">'\x00'</span><span class="Other">}</span></pre></dt>
    343. 

  343.   <dd>
    344. 

  344.     
    345. 

  345.     
    346. 

  346. Characters that may produce invalid filenames across Linux, Windows and Mac. You can check if your filename contains any of these chars and strip them for safety. Mac bans <tt class="docutils literal"><span class="pre">':'</span></tt>, Linux bans <tt class="docutils literal"><span class="pre">'/'</span></tt>, Windows bans all others.
    347. 

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

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

  349. 

  350.   </dd>
    351. 

  351. </div>
    352. 

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

  353.   <dt><pre><a href="os.html#invalidFilenames"><span class="Identifier">invalidFilenames</span></a> <span class="Other">=</span> <span class="Other">[</span><span class="StringLit">&quot;CON&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;PRN&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;AUX&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;NUL&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM0&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM1&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM2&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM3&quot;</span><span class="Other">,</span>
    354. 

  354.                     <span class="StringLit">&quot;COM4&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM5&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM6&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM7&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM8&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;COM9&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT0&quot;</span><span class="Other">,</span>
    355. 

  355.                     <span class="StringLit">&quot;LPT1&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT2&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT3&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT4&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT5&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT6&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT7&quot;</span><span class="Other">,</span>
    356. 

  356.                     <span class="StringLit">&quot;LPT8&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;LPT9&quot;</span><span class="Other">]</span></pre></dt>
    357. 

  357.   <dd>
    358. 

  358.     
    359. 

  359.     
    360. 

  360. Filenames that may be invalid across Linux, Windows, Mac, etc. You can check if your filename match these and rename it for safety (Currently all invalid filenames are from Windows only).
    361. 

  361.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L68" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    362. 

  362. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L68" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    363. 

  363. 

  364.   </dd>
    365. 

  365. </div>
    366. 

  366. 

  367.   </dl>
    368. 

  368. </div>
    369. 

  369. <div class="section" id="12">
    370. 

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

  371.   <dl class="item">
    372. 

  372.     <div id="createHardlink-procs-all">
    373. 

  373.   <div id="createHardlink,string,string">
    374. 

  374.   <dt><pre><span class="Keyword">proc</span> <a href="#createHardlink%2Cstring%2Cstring"><span class="Identifier">createHardlink</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">,</span> <span class="Identifier">dest</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="Identifier">OSError</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>
    375. 

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

  376.   <dd>
    377. 

  377.     
    378. 

  378.     Create a hard link at <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> which points to the item specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">src</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    379. 

  379. Some OS's restrict the creation of hard links to root users (administrators).</div>
    380. 

  380. <p>See also:</p>
    381. 

  381. <ul class="simple"><li><a class="reference external" href="./symlinks.html#createSymlink,Path,Path">symlinks: createSymlink proc</a></li>
    382. 

  382. </ul>
    383. 

  383. 

  384.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L466" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    385. 

  385. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L466" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    386. 

  386. 

  387.   </dd>
    388. 

  388. </div>
    389. 

  389. 

  390. </div>
    391. 

  391. <div id="exclFilePermissions-procs-all">
    392. 

  392.   <div id="exclFilePermissions,string,set[FilePermission]">
    393. 

  393.   <dt><pre><span class="Keyword">proc</span> <a href="#exclFilePermissions%2Cstring%2Cset%5BFilePermission%5D"><span class="Identifier">exclFilePermissions</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="Identifier">permissions</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osfiles.html#FilePermission"><span class="Identifier">FilePermission</span></a><span class="Other">]</span><span class="Other">)</span> {.
    394. 

  394.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">,</span> <a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    395. 

  395.     <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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    396. 

  396.   <dd>
    397. 

  397.     
    398. 

  398.     <p>A convenience proc for:</p>
    399. 

  399. <p><pre class="listing"><span class="Identifier">setFilePermissions</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">,</span> <span class="Identifier">getFilePermissions</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">)</span><span class="Operator">-</span><span class="Identifier">permissions</span><span class="Punctuation">)</span></pre></p>
    400. 

  400. 

  401.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L493" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    402. 

  402. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L493" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    403. 

  403. 

  404.   </dd>
    405. 

  405. </div>
    406. 

  406. 

  407. </div>
    408. 

  408. <div id="execShellCmd-procs-all">
    409. 

  409.   <div id="execShellCmd,string">
    410. 

  410.   <dt><pre><span class="Keyword">proc</span> <a href="#execShellCmd%2Cstring"><span class="Identifier">execShellCmd</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="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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    411. 

  411.     <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><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>
    412. 

  412.   <dd>
    413. 

  413.     
    414. 

  414.     <p>Executes a <span id="shell-command_1">shell command</span>.</p>
    415. 

  415. <p>Command has the form 'program args' where args are the command line arguments given to program. The proc returns the error code of the shell when it has finished (zero if there is no error). The proc does not return until the process has finished.</p>
    416. 

  416. <p>To execute a program without having a shell involved, use <a class="reference external" href="osproc.html#execProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">osproc.execProcess proc</a>.</p>
    417. 

  417. <p><strong>Examples:</strong></p>
    418. 

  418. <p><pre class="listing"><span class="Keyword">discard</span> <span class="Identifier">execShellCmd</span><span class="Punctuation">(</span><span class="StringLit">&quot;ls -la&quot;</span><span class="Punctuation">)</span></pre></p>
    419. 

  419. 

  420.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L401" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    421. 

  421. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L401" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    422. 

  422. 

  423.   </dd>
    424. 

  424. </div>
    425. 

  425. 

  426. </div>
    427. 

  427. <div id="exitStatusLikeShell-procs-all">
    428. 

  428.   <div id="exitStatusLikeShell,cint">
    429. 

  429.   <dt><pre><span class="Keyword">proc</span> <a href="#exitStatusLikeShell%2Ccint"><span class="Identifier">exitStatusLikeShell</span></a><span class="Other">(</span><span class="Identifier">status</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</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>
    430. 

  430.   <dd>
    431. 

  431.     
    432. 

  432.     Converts exit code from <tt class="docutils literal"><span class="pre"><span class="Identifier">c_system</span></span></tt> into a shell exit code.
    433. 

  433.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L390" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    434. 

  434. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L390" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    435. 

  435. 

  436.   </dd>
    437. 

  437. </div>
    438. 

  438. 

  439. </div>
    440. 

  440. <div id="expandFilename-procs-all">
    441. 

  441.   <div id="expandFilename,string">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#expandFilename%2Cstring"><span class="Identifier">expandFilename</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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    443. 

  443.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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="Identifier">OSError</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>
    444. 

  444.   <dd>
    445. 

  445.     
    446. 

  446.     <p>Returns the full (<span id="absolute_1">absolute</span>) path of an existing file <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>.</p>
    447. 

  447. <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> in case of an error. Follows symlinks.</p>
    448. 

  448. 

  449.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L419" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    450. 

  450. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L419" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    451. 

  451. 

  452.   </dd>
    453. 

  453. </div>
    454. 

  454. 

  455. </div>
    456. 

  456. <div id="expandTilde-procs-all">
    457. 

  457.   <div id="expandTilde,string">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#expandTilde%2Cstring"><span class="Identifier">expandTilde</span></a><span class="Other">(</span><span class="Identifier">path</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">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">,</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    459. 

  459.     <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>
    460. 

  460.   <dd>
    461. 

  461.     
    462. 

  462.     <p>Expands <tt class="docutils literal"><span class="pre">~</span></tt> or a path starting with <tt class="docutils literal"><span class="pre">~/</span></tt> to a full path, replacing <tt class="docutils literal"><span class="pre">~</span></tt> with <a class="reference external" href="./appdirs.html#getHomeDir">appdirs: getHomeDir()</a> (otherwise returns <tt class="docutils literal"><span class="pre">path</span></tt> unmodified).</p>
    463. 

  463. <p>Windows: this is still supported despite the Windows platform not having this convention; also, both <tt class="docutils literal"><span class="pre">~/</span></tt> and <tt class="docutils literal"><span class="pre">~\</span></tt> are handled.</p>
    464. 

  464. <p>See also:</p>
    465. 

  465. <ul class="simple"><li><a class="reference external" href="./appdirs.html#getHomeDir">appdirs: getHomeDir proc</a></li>
    466. 

  466. <li><a class="reference external" href="./appdirs.html#getConfigDir">appdirs: getConfigDir proc</a></li>
    467. 

  467. <li><a class="reference external" href="./appdirs.html#getTempDir">appdirs: getTempDir proc</a></li>
    468. 

  468. <li><a class="reference external" href="./ospaths2.html#getCurrentDir">ospaths2: getCurrentDir proc</a></li>
    469. 

  469. <li><a class="reference external" href="./dirs.html#setCurrentDir,Path">dirs: setCurrentDir proc</a></li>
    470. 

  470. </ul>
    471. 

  471. 

  472. <p><strong class="examples_text">Example:</strong></p>
    473. 

  473. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">expandTilde</span><span class="Punctuation">(</span><span class="StringLit">&quot;~&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;appname.cfg&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">getHomeDir</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">/</span> <span class="StringLit">&quot;appname.cfg&quot;</span>
    474. 

  474. <span class="Identifier">assert</span> <span class="Identifier">expandTilde</span><span class="Punctuation">(</span><span class="StringLit">&quot;~/foo/bar&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">getHomeDir</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">/</span> <span class="StringLit">&quot;foo/bar&quot;</span>
    475. 

  475. <span class="Identifier">assert</span> <span class="Identifier">expandTilde</span><span class="Punctuation">(</span><span class="StringLit">&quot;/foo/bar&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/foo/bar&quot;</span></pre>
    476. 

  476.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L112" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    477. 

  477. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L112" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    478. 

  478. 

  479.   </dd>
    480. 

  480. </div>
    481. 

  481. 

  482. </div>
    483. 

  483. <div id="fileNewer-procs-all">
    484. 

  484.   <div id="fileNewer,string,string">
    485. 

  485.   <dt><pre><span class="Keyword">proc</span> <a href="#fileNewer%2Cstring%2Cstring"><span class="Identifier">fileNewer</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#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <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>
    486. 

  486.                                      <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>
    487. 

  487.   <dd>
    488. 

  488.     
    489. 

  489.     <p>Returns true if the file <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is newer than file <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>, i.e. if <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>'s modification time is later than <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>'s.</p>
    490. 

  490. <p>See also:</p>
    491. 

  491. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getLastModificationTime(file: string): times.Time" href="#getLastModificationTime,string">getLastModificationTime proc</a></li>
    492. 

  492. <li><a class="reference internal nimdoc" title="proc getLastAccessTime(file: string): times.Time" href="#getLastAccessTime,string">getLastAccessTime proc</a></li>
    493. 

  493. <li><a class="reference internal nimdoc" title="proc getCreationTime(file: string): times.Time" href="#getCreationTime,string">getCreationTime proc</a></li>
    494. 

  494. </ul>
    495. 

  495. 

  496.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L340" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    497. 

  497. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L340" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    498. 

  498. 

  499.   </dd>
    500. 

  500. </div>
    501. 

  501. 

  502. </div>
    503. 

  503. <div id="findExe-procs-all">
    504. 

  504.   <div id="findExe,string,bool,openArray[string]">
    505. 

  505.   <dt><pre><span class="Keyword">proc</span> <a href="#findExe%2Cstring%2Cbool%2CopenArray%5Bstring%5D"><span class="Identifier">findExe</span></a><span class="Other">(</span><span class="Identifier">exe</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">followSymlinks</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
    506. 

  506.              <span class="Identifier">extensions</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</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="Identifier">ExeExts</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    507. 

  507.     <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="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">,</span> <a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><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="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    508. 

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

  509.   <dd>
    510. 

  510.     
    511. 

  511.     <p>Searches for <tt class="docutils literal"><span class="pre"><span class="Identifier">exe</span></span></tt> in the current working directory and then in directories listed in the <tt class="docutils literal"><span class="pre">PATH</span></tt> environment variable.</p>
    512. 

  512. <p>Returns <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt> if the <tt class="docutils literal"><span class="pre"><span class="Identifier">exe</span></span></tt> cannot be found. <tt class="docutils literal"><span class="pre"><span class="Identifier">exe</span></span></tt> is added the <a class="reference internal nimdoc" title="const ExeExts" href="#ExeExts">ExeExts</a> file extensions if it has none.</p>
    513. 

  513. <p>If the system supports symlinks it also resolves them until it meets the actual file. This behavior can be disabled if desired by setting <tt class="docutils literal"><span class="pre"><span class="Identifier">followSymlinks</span> <span class="Operator">=</span> <span class="Identifier">false</span></span></tt>.</p>
    514. 

  514. 

  515.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L224" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    516. 

  516. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L224" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    517. 

  517. 

  518.   </dd>
    519. 

  519. </div>
    520. 

  520. 

  521. </div>
    522. 

  522. <div id="getAppDir-procs-all">
    523. 

  523.   <div id="getAppDir">
    524. 

  524.   <dt><pre><span class="Keyword">proc</span> <a href="#getAppDir"><span class="Identifier">getAppDir</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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <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>
    525. 

  525.                            <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>
    526. 

  526.   <dd>
    527. 

  527.     
    528. 

  528.     <p>Returns the directory of the application's executable.</p>
    529. 

  529. <p>See also:</p>
    530. 

  530. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getAppFilename(): string" href="#getAppFilename">getAppFilename proc</a></li>
    531. 

  531. </ul>
    532. 

  532. 

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

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

  535. 

  536.   </dd>
    537. 

  537. </div>
    538. 

  538. 

  539. </div>
    540. 

  540. <div id="getAppFilename-procs-all">
    541. 

  541.   <div id="getAppFilename">
    542. 

  542.   <dt><pre><span class="Keyword">proc</span> <a href="#getAppFilename"><span class="Identifier">getAppFilename</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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <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>
    543. 

  543.                                 <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>
    544. 

  544.   <dd>
    545. 

  545.     
    546. 

  546.     <p>Returns the filename of the application's executable. This proc will resolve symlinks.</p>
    547. 

  547. <p>Returns empty string when name is unavailable</p>
    548. 

  548. <p>See also:</p>
    549. 

  549. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getAppDir(): string" href="#getAppDir">getAppDir proc</a></li>
    550. 

  550. <li><a class="reference internal nimdoc" title="proc getCurrentCompilerExe(): string" href="#getCurrentCompilerExe">getCurrentCompilerExe proc</a></li>
    551. 

  551. </ul>
    552. 

  552. 

  553.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L630" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    554. 

  554. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L630" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    555. 

  555. 

  556.   </dd>
    557. 

  557. </div>
    558. 

  558. 

  559. </div>
    560. 

  560. <div id="getCreationTime-procs-all">
    561. 

  561.   <div id="getCreationTime,string">
    562. 

  562.   <dt><pre><span class="Keyword">proc</span> <a href="#getCreationTime%2Cstring"><span class="Identifier">getCreationTime</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 class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    563. 

  563.     <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> <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>
    564. 

  564.   <dd>
    565. 

  565.     
    566. 

  566.     <p>Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>'s creation time.</p>
    567. 

  567. <p><strong>Note:</strong> Under POSIX OS's, the returned time may actually be the time at which the file's attribute's were last modified. See <a class="reference external" href="https://github.com/nim-lang/Nim/issues/1058">here</a> for details.</p>
    568. 

  568. <p>See also:</p>
    569. 

  569. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getLastModificationTime(file: string): times.Time" href="#getLastModificationTime,string">getLastModificationTime proc</a></li>
    570. 

  570. <li><a class="reference internal nimdoc" title="proc getLastAccessTime(file: string): times.Time" href="#getLastAccessTime,string">getLastAccessTime proc</a></li>
    571. 

  571. <li><a class="reference internal nimdoc" title="proc fileNewer(a, b: string): bool" href="#fileNewer,string,string">fileNewer proc</a></li>
    572. 

  572. </ul>
    573. 

  573. 

  574.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L318" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    575. 

  575. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L318" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    576. 

  576. 

  577.   </dd>
    578. 

  578. </div>
    579. 

  579. 

  580. </div>
    581. 

  581. <div id="getCurrentCompilerExe-procs-all">
    582. 

  582.   <div id="getCurrentCompilerExe">
    583. 

  583.   <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentCompilerExe"><span class="Identifier">getCurrentCompilerExe</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 class="Identifier">compileTime</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>
    584. 

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

  585.   <dd>
    586. 

  586.     
    587. 

  587.     
    588. 

  588.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L456" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    589. 

  589. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L456" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    590. 

  590. 

  591.   </dd>
    592. 

  592. </div>
    593. 

  593. 

  594. </div>
    595. 

  595. <div id="getCurrentProcessId-procs-all">
    596. 

  596.   <div id="getCurrentProcessId">
    597. 

  597.   <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentProcessId"><span class="Identifier">getCurrentProcessId</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>
    598. 

  598.   <dd>
    599. 

  599.     
    600. 

  600.     <p>Return current process ID.</p>
    601. 

  601. <p>See also:</p>
    602. 

  602. <ul class="simple"><li><a class="reference external" href="osproc.html#processID,Process">osproc.processID(p: Process)</a></li>
    603. 

  603. </ul>
    604. 

  604. 

  605.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L970" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    606. 

  606. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L970" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    607. 

  607. 

  608.   </dd>
    609. 

  609. </div>
    610. 

  610. 

  611. </div>
    612. 

  612. <div id="getFileInfo-procs-all">
    613. 

  613.   <div id="getFileInfo,File">
    614. 

  614.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileInfo%2CFile"><span class="Identifier">getFileInfo</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span><span class="Other">:</span> <a href="os.html#FileInfo"><span class="Identifier">FileInfo</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="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</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>
    615. 

  615.     <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.     <p>Retrieves file information for the file object.</p>
    619. 

  619. <p>See also:</p>
    620. 

  620. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getFileInfo(handle: FileHandle): FileInfo" href="#getFileInfo,FileHandle">getFileInfo(handle) proc</a></li>
    621. 

  621. <li><a class="reference internal nimdoc" title="proc getFileInfo(path: string; followSymlink = true): FileInfo" href="#getFileInfo,string">getFileInfo(path, followSymlink) proc</a></li>
    622. 

  622. </ul>
    623. 

  623. 

  624.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L859" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    625. 

  625. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L859" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    626. 

  626. 

  627.   </dd>
    628. 

  628. </div>
    629. 

  629. <div id="getFileInfo,FileHandle">
    630. 

  630.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileInfo%2CFileHandle"><span class="Identifier">getFileInfo</span></a><span class="Other">(</span><span class="Identifier">handle</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a><span class="Other">)</span><span class="Other">:</span> <a href="os.html#FileInfo"><span class="Identifier">FileInfo</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="Identifier">OSError</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>
    631. 

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

  632.   <dd>
    633. 

  633.     
    634. 

  634.     <p>Retrieves file information for the file object represented by the given handle.</p>
    635. 

  635. <p>If the information cannot be retrieved, such as when the file handle is invalid, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
    636. 

  636. <p>See also:</p>
    637. 

  637. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getFileInfo(file: File): FileInfo" href="#getFileInfo,File">getFileInfo(file) proc</a></li>
    638. 

  638. <li><a class="reference internal nimdoc" title="proc getFileInfo(path: string; followSymlink = true): FileInfo" href="#getFileInfo,string">getFileInfo(path, followSymlink) proc</a></li>
    639. 

  639. </ul>
    640. 

  640. 

  641.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L832" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    642. 

  642. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L832" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    643. 

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. <div id="getFileInfo,string">
    647. 

  647.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileInfo%2Cstring"><span class="Identifier">getFileInfo</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">followSymlink</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="os.html#FileInfo"><span class="Identifier">FileInfo</span></a> {.
    648. 

  648.     <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> <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>
    649. 

  649.   <dd>
    650. 

  650.     
    651. 

  651.     <p>Retrieves file information for the file object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
    652. 

  652. <p>Due to intrinsic differences between operating systems, the information contained by the returned <a class="reference internal nimdoc" title="object FileInfo" href="#FileInfo">FileInfo object</a> will be slightly different across platforms, and in some cases, incomplete or inaccurate.</p>
    653. 

  653. <p>When <tt class="docutils literal"><span class="pre"><span class="Identifier">followSymlink</span></span></tt> is true (default), symlinks are followed and the information retrieved is information related to the symlink's target. Otherwise, information on the symlink itself is retrieved (however, field <tt class="docutils literal"><span class="pre"><span class="Identifier">isSpecial</span></span></tt> is still determined from the target on Unix).</p>
    654. 

  654. <p>If the information cannot be retrieved, such as when the path doesn't exist, or when permission restrictions prevent the program from retrieving file information, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
    655. 

  655. <p>See also:</p>
    656. 

  656. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getFileInfo(handle: FileHandle): FileInfo" href="#getFileInfo,FileHandle">getFileInfo(handle) proc</a></li>
    657. 

  657. <li><a class="reference internal nimdoc" title="proc getFileInfo(file: File): FileInfo" href="#getFileInfo,File">getFileInfo(file) proc</a></li>
    658. 

  658. </ul>
    659. 

  659. 

  660.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L869" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    661. 

  661. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L869" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    662. 

  662. 

  663.   </dd>
    664. 

  664. </div>
    665. 

  665. 

  666. </div>
    667. 

  667. <div id="getFileSize-procs-all">
    668. 

  668.   <div id="getFileSize,string">
    669. 

  669.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileSize%2Cstring"><span class="Identifier">getFileSize</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 class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    670. 

  670.     <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="Identifier">OSError</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>
    671. 

  671.   <dd>
    672. 

  672.     
    673. 

  673.     
    674. 

  674.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L709" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    675. 

  675. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L709" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    676. 

  676. 

  677.   </dd>
    678. 

  678. </div>
    679. 

  679. 

  680. </div>
    681. 

  681. <div id="getLastAccessTime-procs-all">
    682. 

  682.   <div id="getLastAccessTime,string">
    683. 

  683.   <dt><pre><span class="Keyword">proc</span> <a href="#getLastAccessTime%2Cstring"><span class="Identifier">getLastAccessTime</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 class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    684. 

  684.     <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> <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>
    685. 

  685.   <dd>
    686. 

  686.     
    687. 

  687.     <p>Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>'s last read or write access time.</p>
    688. 

  688. <p>See also:</p>
    689. 

  689. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getLastModificationTime(file: string): times.Time" href="#getLastModificationTime,string">getLastModificationTime proc</a></li>
    690. 

  690. <li><a class="reference internal nimdoc" title="proc getCreationTime(file: string): times.Time" href="#getCreationTime,string">getCreationTime proc</a></li>
    691. 

  691. <li><a class="reference internal nimdoc" title="proc fileNewer(a, b: string): bool" href="#fileNewer,string,string">fileNewer proc</a></li>
    692. 

  692. </ul>
    693. 

  693. 

  694.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L300" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    695. 

  695. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L300" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    696. 

  696. 

  697.   </dd>
    698. 

  698. </div>
    699. 

  699. 

  700. </div>
    701. 

  701. <div id="getLastModificationTime-procs-all">
    702. 

  702.   <div id="getLastModificationTime,string">
    703. 

  703.   <dt><pre><span class="Keyword">proc</span> <a href="#getLastModificationTime%2Cstring"><span class="Identifier">getLastModificationTime</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 class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    704. 

  704.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <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> <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>
    705. 

  705.   <dd>
    706. 

  706.     
    707. 

  707.     <p>Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>'s last modification time.</p>
    708. 

  708. <p>See also:</p>
    709. 

  709. <ul class="simple"><li><a class="reference internal nimdoc" title="proc getLastAccessTime(file: string): times.Time" href="#getLastAccessTime,string">getLastAccessTime proc</a></li>
    710. 

  710. <li><a class="reference internal nimdoc" title="proc getCreationTime(file: string): times.Time" href="#getCreationTime,string">getCreationTime proc</a></li>
    711. 

  711. <li><a class="reference internal nimdoc" title="proc fileNewer(a, b: string): bool" href="#fileNewer,string,string">fileNewer proc</a></li>
    712. 

  712. </ul>
    713. 

  713. 

  714.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L282" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    715. 

  715. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L282" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    716. 

  716. 

  717.   </dd>
    718. 

  718. </div>
    719. 

  719. 

  720. </div>
    721. 

  721. <div id="inclFilePermissions-procs-all">
    722. 

  722.   <div id="inclFilePermissions,string,set[FilePermission]">
    723. 

  723.   <dt><pre><span class="Keyword">proc</span> <a href="#inclFilePermissions%2Cstring%2Cset%5BFilePermission%5D"><span class="Identifier">inclFilePermissions</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="Identifier">permissions</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osfiles.html#FilePermission"><span class="Identifier">FilePermission</span></a><span class="Other">]</span><span class="Other">)</span> {.
    724. 

  724.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">,</span> <a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    725. 

  725.     <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> <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.     <p>A convenience proc for:</p>
    729. 

  729. <p><pre class="listing"><span class="Identifier">setFilePermissions</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">,</span> <span class="Identifier">getFilePermissions</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">)</span><span class="Operator">+</span><span class="Identifier">permissions</span><span class="Punctuation">)</span></pre></p>
    730. 

  730. 

  731.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L484" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    732. 

  732. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L484" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    733. 

  733. 

  734.   </dd>
    735. 

  735. </div>
    736. 

  736. 

  737. </div>
    738. 

  738. <div id="isAdmin-procs-all">
    739. 

  739.   <div id="isAdmin">
    740. 

  740.   <dt><pre><span class="Keyword">proc</span> <a href="#isAdmin"><span class="Identifier">isAdmin</span></a><span class="Other">(</span><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>
    741. 

  741.   <dd>
    742. 

  742.     
    743. 

  743.     Returns whether the caller's process is a member of the Administrators local group (on Windows) or a root (on POSIX), via <tt class="docutils literal"><span class="pre"><span class="Identifier">geteuid</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt>.
    744. 

  744.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    745. 

  745. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    746. 

  746. 

  747.   </dd>
    748. 

  748. </div>
    749. 

  749. 

  750. </div>
    751. 

  751. <div id="isHidden-procs-all">
    752. 

  752.   <div id="isHidden,string">
    753. 

  753.   <dt><pre><span class="Keyword">proc</span> <a href="#isHidden%2Cstring"><span class="Identifier">isHidden</span></a><span class="Other">(</span><span class="Identifier">path</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>
    754. 

  754.   <dd>
    755. 

  755.     
    756. 

  756.     <p>Determines whether <tt class="docutils literal"><span class="pre">path</span></tt> is hidden or not, using <a class="reference external" href="https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory">this reference</a>.</p>
    757. 

  757. <p>On Windows: returns true if it exists and its &quot;hidden&quot; attribute is set.</p>
    758. 

  758. <p>On posix: returns true if <tt class="docutils literal"><span class="pre">lastPathPart(path)</span></tt> starts with <tt class="docutils literal"><span class="pre">.</span></tt> and is not <tt class="docutils literal"><span class="pre">.</span></tt> or <tt class="docutils literal"><span class="pre">..</span></tt>.</p>
    759. 

  759. <p><strong>Note</strong>: paths are not normalized to determine <tt class="docutils literal"><span class="pre"><span class="Identifier">isHidden</span></span></tt>.</p>
    760. 

  760. 

  761. <p><strong class="examples_text">Example:</strong></p>
    762. 

  762. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    763. 

  763.   <span class="Identifier">assert</span> <span class="StringLit">&quot;.foo&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span>
    764. 

  764.   <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;.foo/bar&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span>
    765. 

  765.   <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;.&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span>
    766. 

  766.   <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;..&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span>
    767. 

  767.   <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span>
    768. 

  768.   <span class="Identifier">assert</span> <span class="StringLit">&quot;.foo/&quot;</span><span class="Operator">.</span><span class="Identifier">isHidden</span></pre>
    769. 

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

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

  771. 

  772.   </dd>
    773. 

  773. </div>
    774. 

  774. 

  775. </div>
    776. 

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

  777.   <div id="isValidFilename,string">
    778. 

  778.   <dt><pre><span class="Keyword">func</span> <a href="#isValidFilename%2Cstring"><span class="Identifier">isValidFilename</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="Identifier">maxLen</span> <span class="Other">=</span> <span class="DecNumber">259</span><span class="Other">.</span><span class="Identifier">Positive</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    779. 

  779.     <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>
    780. 

  780.   <dd>
    781. 

  781.     
    782. 

  782.     <p>Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> is valid for crossplatform use.</p>
    783. 

  783. <p>This is useful if you want to copy or save files across Windows, Linux, Mac, etc. It uses <tt class="docutils literal"><span class="pre"><span class="Identifier">invalidFilenameChars</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">invalidFilenames</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">maxLen</span></span></tt> to verify the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>.</p>
    784. 

  784. <p>See also:</p>
    785. 

  785. <ul class="simple"><li><a class="reference external" href="https://docs.microsoft.com/en-us/dotnet/api/system.io.pathtoolongexception">https://docs.microsoft.com/en-us/dotnet/api/system.io.pathtoolongexception</a></li>
    786. 

  786. <li><a class="reference external" href="https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file">https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file</a></li>
    787. 

  787. <li><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx">https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx</a></li>
    788. 

  788. </ul>
    789. 

  789. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    790. 

  790. This only checks filenames, not whole paths (because basically you can mount anything as a path on Linux).</div>
    791. 

  791. 

  792. <p><strong class="examples_text">Example:</strong></p>
    793. 

  793. <pre class="listing"><span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot; foo&quot;</span><span class="Punctuation">)</span>     <span class="Comment"># Leading white space</span>
    794. 

  794. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo &quot;</span><span class="Punctuation">)</span>     <span class="Comment"># Trailing white space</span>
    795. 

  795. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo.&quot;</span><span class="Punctuation">)</span>     <span class="Comment"># Ends with dot</span>
    796. 

  796. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;con.txt&quot;</span><span class="Punctuation">)</span>  <span class="Comment"># &quot;CON&quot; is invalid (Windows)</span>
    797. 

  797. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;OwO:UwU&quot;</span><span class="Punctuation">)</span>  <span class="Comment"># &quot;:&quot; is invalid (Mac)</span>
    798. 

  798. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;aux.bat&quot;</span><span class="Punctuation">)</span>  <span class="Comment"># &quot;AUX&quot; is invalid (Windows)</span>
    799. 

  799. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>         <span class="Comment"># Empty string</span>
    800. 

  800. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isValidFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/&quot;</span><span class="Punctuation">)</span>     <span class="Comment"># Filename is empty</span></pre>
    801. 

  801.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L1000" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    802. 

  802. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L1000" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    803. 

  803. 

  804.   </dd>
    805. 

  805. </div>
    806. 

  806. 

  807. </div>
    808. 

  808. <div id="quoteShell-procs-all">
    809. 

  809.   <div id="quoteShell,string">
    810. 

  810.   <dt><pre><span class="Keyword">proc</span> <a href="#quoteShell%2Cstring"><span class="Identifier">quoteShell</span></a><span class="Other">(</span><span class="Identifier">s</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nosp$1&quot;</span><span class="Other">,</span>
    811. 

  811.                                      <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>
    812. 

  812.   <dd>
    813. 

  813.     
    814. 

  814.     <p>Quote <tt class="docutils literal"><span class="pre">s</span></tt>, so it can be safely passed to shell.</p>
    815. 

  815. <p>When on Windows, it calls <a class="reference internal nimdoc" title="proc quoteShellWindows(s: string): string" href="#quoteShellWindows,string">quoteShellWindows proc</a>. Otherwise, calls <a class="reference internal nimdoc" title="proc quoteShellPosix(s: string): string" href="#quoteShellPosix,string">quoteShellPosix proc</a>.</p>
    816. 

  816. 

  817.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L186" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    818. 

  818. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L186" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    819. 

  819. 

  820.   </dd>
    821. 

  821. </div>
    822. 

  822. 

  823. </div>
    824. 

  824. <div id="quoteShellCommand-procs-all">
    825. 

  825.   <div id="quoteShellCommand,openArray[string]">
    826. 

  826.   <dt><pre><span class="Keyword">proc</span> <a href="#quoteShellCommand%2CopenArray%5Bstring%5D"><span class="Identifier">quoteShellCommand</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</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="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>
    827. 

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

  828.   <dd>
    829. 

  829.     
    830. 

  830.     Concatenates and quotes shell arguments <tt class="docutils literal"><span class="pre"><span class="Identifier">args</span></span></tt>.
    831. 

  831. <p><strong class="examples_text">Example:</strong></p>
    832. 

  832. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    833. 

  833.   <span class="Identifier">assert</span> <span class="Identifier">quoteShellCommand</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;aaa&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c d&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;aaa '' 'c d'&quot;</span>
    834. 

  834. <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">windows</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    835. 

  835.   <span class="Identifier">assert</span> <span class="Identifier">quoteShellCommand</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;aaa&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c d&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;aaa </span><span class="EscapeSequence">\&quot;</span><span class="EscapeSequence">\&quot;</span><span class="StringLit"> </span><span class="EscapeSequence">\&quot;</span><span class="StringLit">c d</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">&quot;</span></pre>
    836. 

  836.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L196" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    837. 

  837. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L196" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    838. 

  838. 

  839.   </dd>
    840. 

  840. </div>
    841. 

  841. 

  842. </div>
    843. 

  843. <div id="quoteShellPosix-procs-all">
    844. 

  844.   <div id="quoteShellPosix,string">
    845. 

  845.   <dt><pre><span class="Keyword">proc</span> <a href="#quoteShellPosix%2Cstring"><span class="Identifier">quoteShellPosix</span></a><span class="Other">(</span><span class="Identifier">s</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    846. 

  846.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nosp$1&quot;</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">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>
    847. 

  847.   <dd>
    848. 

  848.     
    849. 

  849.     Quote <tt class="docutils literal"><span class="pre">s</span></tt>, so it can be safely passed to POSIX shell.
    850. 

  850.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L174" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    851. 

  851. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L174" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    852. 

  852. 

  853.   </dd>
    854. 

  854. </div>
    855. 

  855. 

  856. </div>
    857. 

  857. <div id="quoteShellWindows-procs-all">
    858. 

  858.   <div id="quoteShellWindows,string">
    859. 

  859.   <dt><pre><span class="Keyword">proc</span> <a href="#quoteShellWindows%2Cstring"><span class="Identifier">quoteShellWindows</span></a><span class="Other">(</span><span class="Identifier">s</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    860. 

  860.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nosp$1&quot;</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">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.     <p>Quote <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>, so it can be safely passed to Windows API.</p>
    864. 

  864. <p>Based on Python's <tt class="docutils literal"><span class="pre"><span class="Identifier">subprocess</span><span class="Operator">.</span><span class="Identifier">list2cmdline</span></span></tt>. See <a class="reference external" href="https://msdn.microsoft.com/en-us/library/17w5ykft.aspx">this link</a> for more details.</p>
    865. 

  865. 

  866.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    867. 

  867. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    868. 

  868. 

  869.   </dd>
    870. 

  870. </div>
    871. 

  871. 

  872. </div>
    873. 

  873. <div id="sameFileContent-procs-all">
    874. 

  874.   <div id="sameFileContent,string,string">
    875. 

  875.   <dt><pre><span class="Keyword">proc</span> <a href="#sameFileContent%2Cstring%2Cstring"><span class="Identifier">sameFileContent</span></a><span class="Other">(</span><span class="Identifier">path1</span><span class="Other">,</span> <span class="Identifier">path2</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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
    876. 

  876.     <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="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</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>
    877. 

  877.   <dd>
    878. 

  878.     
    879. 

  879.     <p>Returns true if both pathname arguments refer to files with identical binary content.</p>
    880. 

  880. <p>See also:</p>
    881. 

  881. <ul class="simple"><li><a class="reference external" href="./ospaths2.html#sameFile,string,string">ospaths2: sameFile proc</a></li>
    882. 

  882. </ul>
    883. 

  883. 

  884.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L909" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    885. 

  885. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L909" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    886. 

  886. 

  887.   </dd>
    888. 

  888. </div>
    889. 

  889. 

  890. </div>
    891. 

  891. <div id="setLastModificationTime-procs-all">
    892. 

  892.   <div id="setLastModificationTime,string,">
    893. 

  893.   <dt><pre><span class="Keyword">proc</span> <a href="#setLastModificationTime%2Cstring%2C"><span class="Identifier">setLastModificationTime</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 class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Time</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="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    894. 

  894.     <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>
    895. 

  895.   <dd>
    896. 

  896.     
    897. 

  897.     Sets the <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>'s last modification time. <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised in case of an error.
    898. 

  898.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L982" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    899. 

  899. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L982" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    900. 

  900. 

  901.   </dd>
    902. 

  902. </div>
    903. 

  903. 

  904. </div>
    905. 

  905. <div id="sleep-procs-all">
    906. 

  906.   <div id="sleep,int">
    907. 

  907.   <dt><pre><span class="Keyword">proc</span> <a href="#sleep%2Cint"><span class="Identifier">sleep</span></a><span class="Other">(</span><span class="Identifier">milsecs</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    908. 

  908.                            <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>
    909. 

  909.   <dd>
    910. 

  910.     
    911. 

  911.     Sleeps <tt class="docutils literal"><span class="pre"><span class="Identifier">milsecs</span></span></tt> milliseconds. A negative <tt class="docutils literal"><span class="pre"><span class="Identifier">milsecs</span></span></tt> causes sleep to return immediately.
    912. 

  912.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L696" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    913. 

  913. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L696" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    914. 

  914. 

  915.   </dd>
    916. 

  916. </div>
    917. 

  917. 

  918. </div>
    919. 

  919. 

  920.   </dl>
    921. 

  921. </div>
    922. 

  922. <div class="section" id="18">
    923. 

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

  924.   <dl class="item">
    925. 

  925.     <div id="existsDir-templates-all">
    926. 

  926.   <div id="existsDir.t,varargs[untyped]">
    927. 

  927.   <dt><pre><span class="Keyword">template</span> <a href="#existsDir.t%2Cvarargs%5Buntyped%5D"><span class="Identifier">existsDir</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.
    928. 

  928.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use dirExists&quot;</span></span>.}</pre></dt>
    929. 

  929.   <dd>
    930. 

  930.     <div class="deprecation-message">
    931. 

  931.   <b>Deprecated:</b> use dirExists
    932. 

  932. </div>
    933. 

  933. 

  934.     
    935. 

  935.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L1037" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    936. 

  936. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L1037" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    937. 

  937. 

  938.   </dd>
    939. 

  939. </div>
    940. 

  940. 

  941. </div>
    942. 

  942. <div id="existsFile-templates-all">
    943. 

  943.   <div id="existsFile.t,varargs[untyped]">
    944. 

  944.   <dt><pre><span class="Keyword">template</span> <a href="#existsFile.t%2Cvarargs%5Buntyped%5D"><span class="Identifier">existsFile</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.
    945. 

  945.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use fileExists&quot;</span></span>.}</pre></dt>
    946. 

  946.   <dd>
    947. 

  947.     <div class="deprecation-message">
    948. 

  948.   <b>Deprecated:</b> use fileExists
    949. 

  949. </div>
    950. 

  950. 

  951.     
    952. 

  952.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/os.nim#L1035" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    953. 

  953. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/os.nim#L1035" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    954. 

  954. 

  955.   </dd>
    956. 

  956. </div>
    957. 

  957. 

  958. </div>
    959. 

  959. 

  960.   </dl>
    961. 

  961. </div>
    962. 

  962. 

  963.   </div>
    964. 

  964. </div>
    965. 

  965. 

  966.       <div class="twelve-columns footer">
    967. 

  967.         <span class="nim-sprite"></span>
    968. 

  968.         <br>
    969. 

  969.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 08:36:03 UTC</small>
    970. 

  970.       </div>
    971. 

  971.     </div>
    972. 

  972.   </div>
    973. 

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

  974.     
    975. 

  975. </body>
    976. 

  976. </html>
    977. 

  977.