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

osproc.html 97 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868 
  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/osproc</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/osproc</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="#Process" title="Process = ref ProcessObj">Process</a></li>
    62. 

  62. <li><a class="reference" href="#ProcessOption" title="ProcessOption = enum
    63. 

  63.   poEchoCmd,                ## Echo the command before execution.
    64. 

  64.   poUsePath, ## Asks system to search for executable using PATH environment
    65. 

  65.               ## variable.
    66. 

  66.               ## On Windows, this is the default.
    67. 

  67.   poEvalCommand, ## Pass `command` directly to the shell, without quoting.
    68. 

  68.                   ## Use it only if `command` comes from trusted source.
    69. 

  69.   poStdErrToStdOut,         ## Merge stdout and stderr to the stdout stream.
    70. 

  70.   poParentStreams,          ## Use the parent's streams.
    71. 

  71.   poInteractive, ## Optimize the buffer handling for responsiveness for
    72. 

  72.                   ## UI applications. Currently this only affects
    73. 

  73.                   ## Windows: Named pipes are used so that you can peek
    74. 

  74.                   ## at the process' output streams.
    75. 

  75.   poDaemon                   ## Windows: The program creates no Window.
    76. 

  76.                              ## Unix: Start the program as a daemon. This is still
    77. 

  77.                              ## work in progress!">ProcessOption</a></li>
    78. 

  78. 

  79.     </ul>
    80. 

  80.   </details>
    81. 

  81. </li>
    82. 

  82. <li>
    83. 

  83.   <details open>
    84. 

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

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

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

  87.   <li><a class="reference" href="#close%2CProcess" title="close(p: Process)">close(p: Process)</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">countProcessors
    91. 

  91.   <li><a class="reference" href="#countProcessors" title="countProcessors(): int">countProcessors(): int</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">errorHandle
    95. 

  95.   <li><a class="reference" href="#errorHandle%2CProcess" title="errorHandle(p: Process): FileHandle">errorHandle(p: Process): FileHandle</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">errorStream
    99. 

  99.   <li><a class="reference" href="#errorStream%2CProcess" title="errorStream(p: Process): Stream">errorStream(p: Process): Stream</a></li>
    100. 

  100. 

  101. </ul>
    102. 

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

  103.   <li><a class="reference" href="#execCmd%2Cstring" title="execCmd(command: string): int">execCmd(command: string): int</a></li>
    104. 

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#execCmdEx%2Cstring%2Cset%5BProcessOption%5D%2CStringTableRef%2Cstring%2Cstring" title="execCmdEx(command: string;
    108. 

  108.           options: set[ProcessOption] = {poStdErrToStdOut, poUsePath};
    109. 

  109.           env: StringTableRef = nil; workingDir = &quot;&quot;; input = &quot;&quot;): tuple[
    110. 

  110.     output: string, exitCode: int]">execCmdEx(command: string;
    111. 

  111.           options: set[ProcessOption] = {poStdErrToStdOut, poUsePath};
    112. 

  112.           env: StringTableRef = nil; workingDir = &quot;&quot;; input = &quot;&quot;): tuple[
    113. 

  113.     output: string, exitCode: int]</a></li>
    114. 

  114. 

  115. </ul>
    116. 

  116. <ul class="simple nested-toc-section">execProcess
    117. 

  117.   <li><a class="reference" href="#execProcess%2Cstring%2Cstring%2CopenArray%5Bstring%5D%2CStringTableRef%2Cset%5BProcessOption%5D" title="execProcess(command: string; workingDir: string = &quot;&quot;;
    118. 

  118.             args: openArray[string] = []; env: StringTableRef = nil; options: set[
    119. 

  119.     ProcessOption] = {poStdErrToStdOut, poUsePath, poEvalCommand}): string">execProcess(command: string; workingDir: string = &quot;&quot;;
    120. 

  120.             args: openArray[string] = []; env: StringTableRef = nil; options: set[
    121. 

  121.     ProcessOption] = {poStdErrToStdOut, poUsePath, poEvalCommand}): string</a></li>
    122. 

  122. 

  123. </ul>
    124. 

  124. <ul class="simple nested-toc-section">execProcesses
    125. 

  125.   <li><a class="reference" href="#execProcesses%2CopenArray%5Bstring%5D%2Cproc%28int%29%2Cproc%28int%2CProcess%29" title="execProcesses(cmds: openArray[string];
    126. 

  126.               options = {poStdErrToStdOut, poParentStreams};
    127. 

  127.               n = countProcessors(); beforeRunEvent: proc (idx: int) = nil;
    128. 

  128.               afterRunEvent: proc (idx: int; p: Process) = nil): int">execProcesses(cmds: openArray[string];
    129. 

  129.               options = {poStdErrToStdOut, poParentStreams};
    130. 

  130.               n = countProcessors(); beforeRunEvent: proc (idx: int) = nil;
    131. 

  131.               afterRunEvent: proc (idx: int; p: Process) = nil): int</a></li>
    132. 

  132. 

  133. </ul>
    134. 

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

  135.   <li><a class="reference" href="#hasData%2CProcess" title="hasData(p: Process): bool">hasData(p: Process): bool</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">inputHandle
    139. 

  139.   <li><a class="reference" href="#inputHandle%2CProcess" title="inputHandle(p: Process): FileHandle">inputHandle(p: Process): FileHandle</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">inputStream
    143. 

  143.   <li><a class="reference" href="#inputStream%2CProcess" title="inputStream(p: Process): Stream">inputStream(p: Process): Stream</a></li>
    144. 

  144. 

  145. </ul>
    146. 

  146. <ul class="simple nested-toc-section">kill
    147. 

  147.   <li><a class="reference" href="#kill%2CProcess" title="kill(p: Process)">kill(p: Process)</a></li>
    148. 

  148. 

  149. </ul>
    150. 

  150. <ul class="simple nested-toc-section">outputHandle
    151. 

  151.   <li><a class="reference" href="#outputHandle%2CProcess" title="outputHandle(p: Process): FileHandle">outputHandle(p: Process): FileHandle</a></li>
    152. 

  152. 

  153. </ul>
    154. 

  154. <ul class="simple nested-toc-section">outputStream
    155. 

  155.   <li><a class="reference" href="#outputStream%2CProcess" title="outputStream(p: Process): Stream">outputStream(p: Process): Stream</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">peekableErrorStream
    159. 

  159.   <li><a class="reference" href="#peekableErrorStream%2CProcess" title="peekableErrorStream(p: Process): Stream">peekableErrorStream(p: Process): Stream</a></li>
    160. 

  160. 

  161. </ul>
    162. 

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

  163.   <li><a class="reference" href="#peekableOutputStream%2CProcess" title="peekableOutputStream(p: Process): Stream">peekableOutputStream(p: Process): Stream</a></li>
    164. 

  164. 

  165. </ul>
    166. 

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

  167.   <li><a class="reference" href="#peekExitCode%2CProcess" title="peekExitCode(p: Process): int">peekExitCode(p: Process): int</a></li>
    168. 

  168. 

  169. </ul>
    170. 

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

  171.   <li><a class="reference" href="#processID%2CProcess" title="processID(p: Process): int">processID(p: Process): int</a></li>
    172. 

  172. 

  173. </ul>
    174. 

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

  175.   <li><a class="reference" href="#readLines%2CProcess" title="readLines(p: Process): (seq[string], int)">readLines(p: Process): (seq[string], int)</a></li>
    176. 

  176. 

  177. </ul>
    178. 

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

  179.   <li><a class="reference" href="#resume%2CProcess" title="resume(p: Process)">resume(p: Process)</a></li>
    180. 

  180. 

  181. </ul>
    182. 

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

  183.   <li><a class="reference" href="#running%2CProcess" title="running(p: Process): bool">running(p: Process): bool</a></li>
    184. 

  184. 

  185. </ul>
    186. 

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

  187.   <li><a class="reference" href="#startProcess%2Cstring%2Cstring%2CopenArray%5Bstring%5D%2CStringTableRef%2Cset%5BProcessOption%5D" title="startProcess(command: string; workingDir: string = &quot;&quot;;
    188. 

  188.              args: openArray[string] = []; env: StringTableRef = nil;
    189. 

  189.              options: set[ProcessOption] = {poStdErrToStdOut}): owned(Process)">startProcess(command: string; workingDir: string = &quot;&quot;;
    190. 

  190.              args: openArray[string] = []; env: StringTableRef = nil;
    191. 

  191.              options: set[ProcessOption] = {poStdErrToStdOut}): owned(Process)</a></li>
    192. 

  192. 

  193. </ul>
    194. 

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

  195.   <li><a class="reference" href="#suspend%2CProcess" title="suspend(p: Process)">suspend(p: Process)</a></li>
    196. 

  196. 

  197. </ul>
    198. 

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

  199.   <li><a class="reference" href="#terminate%2CProcess" title="terminate(p: Process)">terminate(p: Process)</a></li>
    200. 

  200. 

  201. </ul>
    202. 

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

  203.   <li><a class="reference" href="#waitForExit%2CProcess%2Cint" title="waitForExit(p: Process; timeout: int = -1): int">waitForExit(p: Process; timeout: int = -1): int</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. 

  207.     </ul>
    208. 

  208.   </details>
    209. 

  209. </li>
    210. 

  210. <li>
    211. 

  211.   <details open>
    212. 

  212.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    213. 

  213.     <ul class="simple simple-toc-section">
    214. 

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

  215.   <li><a class="reference" href="#lines.i%2CProcess" title="lines(p: Process; keepNewLines = false): string">lines(p: Process; keepNewLines = false): string</a></li>
    216. 

  216. 

  217. </ul>
    218. 

  218. 

  219.     </ul>
    220. 

  220.   </details>
    221. 

  221. </li>
    222. 

  222. 

  223. </ul>
    224. 

  224. 

  225.   </div>
    226. 

  226.   <div class="nine columns" id="content">
    227. 

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

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

  229. 

  230.     <div id="tocRoot"></div>
    231. 

  231.     
    232. 

  232.     <p class="module-desc"><p>This module implements an advanced facility for executing OS processes and process communication.</p>
    233. 

  233. <p><strong>See also:</strong></p>
    234. 

  234. <ul class="simple"><li><a class="reference external" href="os.html">os module</a></li>
    235. 

  235. <li><a class="reference external" href="streams.html">streams module</a></li>
    236. 

  236. <li><a class="reference external" href="memfiles.html">memfiles module</a></li>
    237. 

  237. </ul>
    238. 

  238. </p>
    239. 

  239.     <div class="section" id="6">
    240. 

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

  241.   <dl class="item">
    242. 

  242.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strtabs.html">strtabs</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="cpuinfo.html">cpuinfo</a>, <a class="reference external" href="streamwrapper.html">streamwrapper</a>, <a class="reference external" href="since.html">since</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="monotimes.html">monotimes</a>
    243. 

  243.   </dl>
    244. 

  244. </div>
    245. 

  245. <div class="section" id="7">
    246. 

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

  247.   <dl class="item">
    248. 

  248.     <div id="Process">
    249. 

  249.   <dt><pre><a href="osproc.html#Process"><span class="Identifier">Process</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">ProcessObj</span></pre></dt>
    250. 

  250.   <dd>
    251. 

  251.     
    252. 

  252.     Represents an operating system process.
    253. 

  253.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L73" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    254. 

  254. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L73" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    255. 

  255. 

  256.   </dd>
    257. 

  257. </div>
    258. 

  258. <div id="ProcessOption">
    259. 

  259.   <dt><pre><a href="osproc.html#ProcessOption"><span class="Identifier">ProcessOption</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    260. 

  260.   <span class="Identifier">poEchoCmd</span><span class="Other">,</span>                <span class="Comment">## Echo the command before execution.</span>
    261. 

  261.   <span class="Identifier">poUsePath</span><span class="Other">,</span> <span class="Comment">## Asks system to search for executable using PATH environment</span>
    262. 

  262.               <span class="Comment">## variable.</span>
    263. 

  263.               <span class="Comment">## On Windows, this is the default.</span>
    264. 

  264.   <span class="Identifier">poEvalCommand</span><span class="Other">,</span> <span class="Comment">## Pass `command` directly to the shell, without quoting.</span>
    265. 

  265.                   <span class="Comment">## Use it only if `command` comes from trusted source.</span>
    266. 

  266.   <span class="Identifier">poStdErrToStdOut</span><span class="Other">,</span>         <span class="Comment">## Merge stdout and stderr to the stdout stream.</span>
    267. 

  267.   <span class="Identifier">poParentStreams</span><span class="Other">,</span>          <span class="Comment">## Use the parent's streams.</span>
    268. 

  268.   <span class="Identifier">poInteractive</span><span class="Other">,</span> <span class="Comment">## Optimize the buffer handling for responsiveness for</span>
    269. 

  269.                   <span class="Comment">## UI applications. Currently this only affects</span>
    270. 

  270.                   <span class="Comment">## Windows: Named pipes are used so that you can peek</span>
    271. 

  271.                   <span class="Comment">## at the process' output streams.</span>
    272. 

  272.   <span class="Identifier">poDaemon</span>                   <span class="Comment">## Windows: The program creates no Window.</span>
    273. 

  273.                              <span class="Comment">## Unix: Start the program as a daemon. This is still</span>
    274. 

  274.                              <span class="Comment">## work in progress!</span></pre></dt>
    275. 

  275.   <dd>
    276. 

  276.     
    277. 

  277.     Options that can be passed to <a class="reference external" href="#startProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">startProcess proc</a>.
    278. 

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

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

  280. 

  281.   </dd>
    282. 

  282. </div>
    283. 

  283. 

  284.   </dl>
    285. 

  285. </div>
    286. 

  286. <div class="section" id="12">
    287. 

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

  288.   <dl class="item">
    289. 

  289.     <div id="close-procs-all">
    290. 

  290.   <div id="close,Process">
    291. 

  291.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CProcess"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    292. 

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

  293.   <dd>
    294. 

  294.     
    295. 

  295.     When the process has finished executing, cleanup related handles.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    296. 

  296. If the process has not finished executing, this will forcibly terminate the process. Doing so may result in zombie processes and <a class="reference external" href="https://stackoverflow.com/questions/27021641/how-to-fix-request-failed-on-channel-0">pty leaks</a>.</div>
    297. 

  297. 

  298.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L155" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    299. 

  299. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L155" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    300. 

  300. 

  301.   </dd>
    302. 

  302. </div>
    303. 

  303. 

  304. </div>
    305. 

  305. <div id="countProcessors-procs-all">
    306. 

  306.   <div id="countProcessors">
    307. 

  307.   <dt><pre><span class="Keyword">proc</span> <a href="#countProcessors"><span class="Identifier">countProcessors</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">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> <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>
    308. 

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

  309.   <dd>
    310. 

  310.     
    311. 

  311.     Returns the number of the processors/cores the machine has. Returns 0 if it cannot be detected. It is implemented just calling <tt class="docutils literal"><span class="pre"><span class="Identifier">cpuinfo</span><span class="Operator">.</span><span class="Identifier">countProcessors</span></span></tt>.
    312. 

  312.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L332" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    313. 

  313. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L332" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    314. 

  314. 

  315.   </dd>
    316. 

  316. </div>
    317. 

  317. 

  318. </div>
    319. 

  319. <div id="errorHandle-procs-all">
    320. 

  320.   <div id="errorHandle,Process">
    321. 

  321.   <dt><pre><span class="Keyword">proc</span> <a href="#errorHandle%2CProcess"><span class="Identifier">errorHandle</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</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;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>
    322. 

  322.     <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>
    323. 

  323.   <dd>
    324. 

  324.     
    325. 

  325.     Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s error file handle for reading from.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    326. 

  326. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">FileHandle</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    327. 

  327. <p>See also:</p>
    328. 

  328. <ul class="simple"><li><a class="reference external" href="#inputHandle,Process">inputHandle proc</a></li>
    329. 

  329. <li><a class="reference external" href="#outputHandle,Process">outputHandle proc</a></li>
    330. 

  330. </ul>
    331. 

  331. 

  332.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L320" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    333. 

  333. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L320" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    334. 

  334. 

  335.   </dd>
    336. 

  336. </div>
    337. 

  337. 

  338. </div>
    339. 

  339. <div id="errorStream-procs-all">
    340. 

  340.   <div id="errorStream,Process">
    341. 

  341.   <dt><pre><span class="Keyword">proc</span> <a href="#errorStream%2CProcess"><span class="Identifier">errorStream</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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;nosp$1&quot;</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>
    342. 

  342.                                        <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>
    343. 

  343.   <dd>
    344. 

  344.     
    345. 

  345.     <p>Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s error stream for reading from.</p>
    346. 

  346. <p>You cannot perform peek/write/setOption operations to this stream. Use <a class="reference external" href="#peekableErrorStream,Process">peekableErrorStream proc</a> if you need to peek stream.</p>
    347. 

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

  348. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">Stream</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    349. 

  349. <p>See also:</p>
    350. 

  350. <ul class="simple"><li><a class="reference external" href="#inputStream,Process">inputStream proc</a></li>
    351. 

  351. <li><a class="reference external" href="#outputStream,Process">outputStream proc</a></li>
    352. 

  352. </ul>
    353. 

  353. 

  354.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L258" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    355. 

  355. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L258" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    356. 

  356. 

  357.   </dd>
    358. 

  358. </div>
    359. 

  359. 

  360. </div>
    361. 

  361. <div id="execCmd-procs-all">
    362. 

  362.   <div id="execCmd,string">
    363. 

  363.   <dt><pre><span class="Keyword">proc</span> <a href="#execCmd%2Cstring"><span class="Identifier">execCmd</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;nosp$1&quot;</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span>
    364. 

  364.     <a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</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>
    365. 

  365.   <dd>
    366. 

  366.     
    367. 

  367.     <p>Executes <tt class="docutils literal"><span class="pre">command</span></tt> and returns its error code.</p>
    368. 

  368. <p>Standard input, output, error streams are inherited from the calling process. This operation is also often called <span id="system_1">system</span>.</p>
    369. 

  369. <p>See also:</p>
    370. 

  370. <ul class="simple"><li><a class="reference external" href="#execCmdEx,string,set[ProcessOption],StringTableRef,string,string">execCmdEx proc</a></li>
    371. 

  371. <li><a class="reference external" href="#startProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">startProcess proc</a></li>
    372. 

  372. <li><a class="reference external" href="#execProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">execProcess proc</a></li>
    373. 

  373. </ul>
    374. 

  374. <p>Example:</p>
    375. 

  375. <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">errC</span> <span class="Operator">=</span> <span class="Identifier">execCmd</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim c -r mytestfile.nim&quot;</span><span class="Punctuation">)</span></pre></p>
    376. 

  376. 

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

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

  379. 

  380.   </dd>
    381. 

  381. </div>
    382. 

  382. 

  383. </div>
    384. 

  384. <div id="execCmdEx-procs-all">
    385. 

  385.   <div id="execCmdEx,string,set[ProcessOption],StringTableRef,string,string">
    386. 

  386.   <dt><pre><span class="Keyword">proc</span> <a href="#execCmdEx%2Cstring%2Cset%5BProcessOption%5D%2CStringTableRef%2Cstring%2Cstring"><span class="Identifier">execCmdEx</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>
    387. 

  387.                <span class="Identifier">options</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osproc.html#ProcessOption"><span class="Identifier">ProcessOption</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">poStdErrToStdOut</span><span class="Other">,</span> <span class="Identifier">poUsePath</span><span class="Other">}</span><span class="Other">;</span>
    388. 

  388.                <span class="Identifier">env</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span> <span class="Identifier">workingDir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">input</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
    389. 

  389.     <span class="Identifier">output</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">exitCode</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">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span>
    390. 

  390.     <a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</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>
    391. 

  391.   <dd>
    392. 

  392.     
    393. 

  393.     <p>A convenience proc that runs the <tt class="docutils literal"><span class="pre"><span class="Identifier">command</span></span></tt>, and returns its <tt class="docutils literal"><span class="pre"><span class="Identifier">output</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">exitCode</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">env</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">workingDir</span></span></tt> params behave as for <tt class="docutils literal"><span class="pre"><span class="Identifier">startProcess</span></span></tt>. If <tt class="docutils literal"><span class="pre"><span class="Identifier">input</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">&gt;</span> <span class="DecNumber">0</span></span></tt>, it is passed as stdin.</p>
    394. 

  394. <p>Note: this could block if <tt class="docutils literal"><span class="pre"><span class="Identifier">input</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> is greater than your OS's maximum pipe buffer size.</p>
    395. 

  395. <p>See also:</p>
    396. 

  396. <ul class="simple"><li><a class="reference external" href="#execCmd,string">execCmd proc</a></li>
    397. 

  397. <li><a class="reference external" href="#startProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">startProcess proc</a></li>
    398. 

  398. <li><a class="reference external" href="#execProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">execProcess proc</a></li>
    399. 

  399. </ul>
    400. 

  400. <p>Example:</p>
    401. 

  401. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Identifier">execCmdEx</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim r --hints:off -&quot;</span><span class="Punctuation">,</span> <span class="Identifier">options</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Punctuation">}</span><span class="Punctuation">,</span> <span class="Identifier">input</span> <span class="Operator">=</span> <span class="StringLit">&quot;echo 3*4&quot;</span><span class="Punctuation">)</span>
    402. 

  402. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">strutils</span><span class="Punctuation">,</span> <span class="Identifier">strtabs</span><span class="Punctuation">]</span>
    403. 

  403. <span class="Identifier">stripLineEnd</span><span class="Punctuation">(</span><span class="Identifier">result</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Comment">## portable way to remove trailing newline, if any</span>
    404. 

  404. <span class="Identifier">doAssert</span> <span class="Identifier">result</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;12&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span>
    405. 

  405. <span class="Identifier">doAssert</span> <span class="Identifier">execCmdEx</span><span class="Punctuation">(</span><span class="StringLit">&quot;ls --nonexistent&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">exitCode</span> <span class="Operator">!=</span> <span class="DecNumber">0</span>
    406. 

  406. <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>
    407. 

  407.   <span class="Identifier">assert</span> <span class="Identifier">execCmdEx</span><span class="Punctuation">(</span><span class="StringLit">&quot;echo $FO&quot;</span><span class="Punctuation">,</span> <span class="Identifier">env</span> <span class="Operator">=</span> <span class="Identifier">newStringTable</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="StringLit">&quot;FO&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;B&quot;</span><span class="Punctuation">}</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;B</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span>
    408. 

  408.   <span class="Identifier">assert</span> <span class="Identifier">execCmdEx</span><span class="Punctuation">(</span><span class="StringLit">&quot;echo $PWD&quot;</span><span class="Punctuation">,</span> <span class="Identifier">workingDir</span> <span class="Operator">=</span> <span class="StringLit">&quot;/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;/</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span></pre></p>
    409. 

  409. 

  410.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L1522" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    411. 

  411. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L1522" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    412. 

  412. 

  413.   </dd>
    414. 

  414. </div>
    415. 

  415. 

  416. </div>
    417. 

  417. <div id="execProcess-procs-all">
    418. 

  418.   <div id="execProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">
    419. 

  419.   <dt><pre><span class="Keyword">proc</span> <a href="#execProcess%2Cstring%2Cstring%2CopenArray%5Bstring%5D%2CStringTableRef%2Cset%5BProcessOption%5D"><span class="Identifier">execProcess</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">workingDir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    420. 

  420.                  <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><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">env</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    421. 

  421.     <span class="Identifier">options</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osproc.html#ProcessOption"><span class="Identifier">ProcessOption</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">poStdErrToStdOut</span><span class="Other">,</span> <span class="Identifier">poUsePath</span><span class="Other">,</span> <span class="Identifier">poEvalCommand</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    422. 

  422.     <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> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span>
    423. 

  423.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    424. 

  424.   <dd>
    425. 

  425.     
    426. 

  426.     A convenience procedure that executes <tt class="docutils literal"><span class="pre">command</span></tt> with <tt class="docutils literal"><span class="pre">startProcess</span></tt> and returns its output as a string.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    427. 

  427. This function uses <tt class="docutils literal"><span class="pre"><span class="Identifier">poEvalCommand</span></span></tt> by default for backwards compatibility. Make sure to pass options explicitly.</div>
    428. 

  428. <p>See also:</p>
    429. 

  429. <ul class="simple"><li><a class="reference external" href="#startProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">startProcess proc</a></li>
    430. 

  430. <li><a class="reference external" href="#execProcesses,openArray[string],proc(int),proc(int,Process)">execProcesses proc</a></li>
    431. 

  431. <li><a class="reference external" href="#execCmd,string">execCmd proc</a></li>
    432. 

  432. </ul>
    433. 

  433. <p>Example:</p>
    434. 

  434. <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">outp</span> <span class="Operator">=</span> <span class="Identifier">execProcess</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim&quot;</span><span class="Punctuation">,</span> <span class="Identifier">args</span><span class="Operator">=</span><span class="Punctuation">[</span><span class="StringLit">&quot;c&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-r&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;mytestfile.nim&quot;</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">options</span><span class="Operator">=</span><span class="Punctuation">{</span><span class="Identifier">poUsePath</span><span class="Punctuation">}</span><span class="Punctuation">)</span>
    435. 

  435. <span class="Keyword">let</span> <span class="Identifier">outp_shell</span> <span class="Operator">=</span> <span class="Identifier">execProcess</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim c -r mytestfile.nim&quot;</span><span class="Punctuation">)</span>
    436. 

  436. <span class="Comment"># Note: outp may have an interleave of text from the nim compile</span>
    437. 

  437. <span class="Comment"># and any output from mytestfile when it runs</span></pre></p>
    438. 

  438. 

  439.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L76" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    440. 

  440. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L76" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    441. 

  441. 

  442.   </dd>
    443. 

  443. </div>
    444. 

  444. 

  445. </div>
    446. 

  446. <div id="execProcesses-procs-all">
    447. 

  447.   <div id="execProcesses,openArray[string],proc(int),proc(int,Process)">
    448. 

  448.   <dt><pre><span class="Keyword">proc</span> <a href="#execProcesses%2CopenArray%5Bstring%5D%2Cproc%28int%29%2Cproc%28int%2CProcess%29"><span class="Identifier">execProcesses</span></a><span class="Other">(</span><span class="Identifier">cmds</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>
    449. 

  449.                    <span class="Identifier">options</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">poStdErrToStdOut</span><span class="Other">,</span> <span class="Identifier">poParentStreams</span><span class="Other">}</span><span class="Other">;</span>
    450. 

  450.                    <span class="Identifier">n</span> <span class="Other">=</span> <span class="Identifier">countProcessors</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">beforeRunEvent</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">idx</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    451. 

  451.                    <span class="Identifier">afterRunEvent</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">idx</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    452. 

  452.     <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> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span>
    453. 

  453.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">,</span> <a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    454. 

  454.     </span><span class="Identifier">effectsOf</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">beforeRunEvent</span><span class="Other">,</span> <span class="Identifier">afterRunEvent</span><span class="Other">]</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    455. 

  455.   <dd>
    456. 

  456.     
    457. 

  457.     <p>Executes the commands <tt class="docutils literal"><span class="pre"><span class="Identifier">cmds</span></span></tt> in parallel. Creates <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> processes that execute in parallel.</p>
    458. 

  458. <p>The highest (absolute) return value of all processes is returned. Runs <tt class="docutils literal"><span class="pre"><span class="Identifier">beforeRunEvent</span></span></tt> before running each command.</p>
    459. 

  459. 

  460.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    461. 

  461. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    462. 

  462. 

  463.   </dd>
    464. 

  464. </div>
    465. 

  465. 

  466. </div>
    467. 

  467. <div id="hasData-procs-all">
    468. 

  468.   <div id="hasData,Process">
    469. 

  469.   <dt><pre><span class="Keyword">proc</span> <a href="#hasData%2CProcess"><span class="Identifier">hasData</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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>
    470. 

  470.   <dd>
    471. 

  471.     
    472. 

  472.     
    473. 

  473.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L1512" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    474. 

  474. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L1512" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    475. 

  475. 

  476.   </dd>
    477. 

  477. </div>
    478. 

  478. 

  479. </div>
    480. 

  480. <div id="inputHandle-procs-all">
    481. 

  481.   <div id="inputHandle,Process">
    482. 

  482.   <dt><pre><span class="Keyword">proc</span> <a href="#inputHandle%2CProcess"><span class="Identifier">inputHandle</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</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">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nosp$1&quot;</span><span class="Other">,</span>
    483. 

  483.     <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>
    484. 

  484.   <dd>
    485. 

  485.     
    486. 

  486.     Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s input file handle for writing to.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    487. 

  487. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">FileHandle</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    488. 

  488. <p>See also:</p>
    489. 

  489. <ul class="simple"><li><a class="reference external" href="#outputHandle,Process">outputHandle proc</a></li>
    490. 

  490. <li><a class="reference external" href="#errorHandle,Process">errorHandle proc</a></li>
    491. 

  491. </ul>
    492. 

  492. 

  493.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    494. 

  494. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    495. 

  495. 

  496.   </dd>
    497. 

  497. </div>
    498. 

  498. 

  499. </div>
    500. 

  500. <div id="inputStream-procs-all">
    501. 

  501.   <div id="inputStream,Process">
    502. 

  502.   <dt><pre><span class="Keyword">proc</span> <a href="#inputStream%2CProcess"><span class="Identifier">inputStream</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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;nosp$1&quot;</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>
    503. 

  503.                                        <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>
    504. 

  504.   <dd>
    505. 

  505.     
    506. 

  506.     Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s input stream for writing to.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    507. 

  507. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">Stream</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    508. 

  508. <p>See also:</p>
    509. 

  509. <ul class="simple"><li><a class="reference external" href="#outputStream,Process">outputStream proc</a></li>
    510. 

  510. <li><a class="reference external" href="#errorStream,Process">errorStream proc</a></li>
    511. 

  511. </ul>
    512. 

  512. 

  513.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L234" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    514. 

  514. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L234" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    515. 

  515. 

  516.   </dd>
    517. 

  517. </div>
    518. 

  518. 

  519. </div>
    520. 

  520. <div id="kill-procs-all">
    521. 

  521.   <div id="kill,Process">
    522. 

  522.   <dt><pre><span class="Keyword">proc</span> <a href="#kill%2CProcess"><span class="Identifier">kill</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    523. 

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

  524.   <dd>
    525. 

  525.     
    526. 

  526.     <p>Kill the process <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>.</p>
    527. 

  527. <p>On Posix OSes the procedure sends <tt class="docutils literal"><span class="pre">SIGKILL</span></tt> to the process. On Windows <tt class="docutils literal"><span class="pre">kill</span></tt> is simply an alias for <a class="reference external" href="#terminate,Process">terminate()</a>.</p>
    528. 

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

  529. <ul class="simple"><li><a class="reference external" href="#suspend,Process">suspend proc</a></li>
    530. 

  530. <li><a class="reference external" href="#resume,Process">resume proc</a></li>
    531. 

  531. <li><a class="reference external" href="#terminate,Process">terminate proc</a></li>
    532. 

  532. <li><a class="reference external" href="posix_utils.html#sendSignal,Pid,int">posix_utils.sendSignal(pid: Pid, signal: int)</a></li>
    533. 

  533. </ul>
    534. 

  534. 

  535.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L192" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    536. 

  536. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L192" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    537. 

  537. 

  538.   </dd>
    539. 

  539. </div>
    540. 

  540. 

  541. </div>
    542. 

  542. <div id="outputHandle-procs-all">
    543. 

  543.   <div id="outputHandle,Process">
    544. 

  544.   <dt><pre><span class="Keyword">proc</span> <a href="#outputHandle%2CProcess"><span class="Identifier">outputHandle</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</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;nosp$1&quot;</span><span class="Other">,</span>
    545. 

  545.     <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>
    546. 

  546.   <dd>
    547. 

  547.     
    548. 

  548.     Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s output file handle for reading from.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    549. 

  549. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">FileHandle</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    550. 

  550. <p>See also:</p>
    551. 

  551. <ul class="simple"><li><a class="reference external" href="#inputHandle,Process">inputHandle proc</a></li>
    552. 

  552. <li><a class="reference external" href="#errorHandle,Process">errorHandle proc</a></li>
    553. 

  553. </ul>
    554. 

  554. 

  555.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L308" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    556. 

  556. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L308" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    557. 

  557. 

  558.   </dd>
    559. 

  559. </div>
    560. 

  560. 

  561. </div>
    562. 

  562. <div id="outputStream-procs-all">
    563. 

  563.   <div id="outputStream,Process">
    564. 

  564.   <dt><pre><span class="Keyword">proc</span> <a href="#outputStream%2CProcess"><span class="Identifier">outputStream</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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;nosp$1&quot;</span><span class="Other">,</span>
    565. 

  565.                                         <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    566. 

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

  567.   <dd>
    568. 

  568.     
    569. 

  569.     <p>Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s output stream for reading from.</p>
    570. 

  570. <p>You cannot perform peek/write/setOption operations to this stream. Use <a class="reference external" href="#peekableOutputStream,Process">peekableOutputStream proc</a> if you need to peek stream.</p>
    571. 

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

  572. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">Stream</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    573. 

  573. <p>See also:</p>
    574. 

  574. <ul class="simple"><li><a class="reference external" href="#inputStream,Process">inputStream proc</a></li>
    575. 

  575. <li><a class="reference external" href="#errorStream,Process">errorStream proc</a></li>
    576. 

  576. </ul>
    577. 

  577. 

  578.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L244" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    579. 

  579. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L244" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    580. 

  580. 

  581.   </dd>
    582. 

  582. </div>
    583. 

  583. 

  584. </div>
    585. 

  585. <div id="peekableErrorStream-procs-all">
    586. 

  586.   <div id="peekableErrorStream,Process">
    587. 

  587.   <dt><pre><span class="Keyword">proc</span> <a href="#peekableErrorStream%2CProcess"><span class="Identifier">peekableErrorStream</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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;nosp$1&quot;</span><span class="Other">,</span>
    588. 

  588.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><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>
    589. 

  589.   <dd>
    590. 

  590.     
    591. 

  591.     <p>Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s error stream for reading from.</p>
    592. 

  592. <p>You can run peek operation to returned stream.</p>
    593. 

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

  594. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">Stream</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    595. 

  595. <p>See also:</p>
    596. 

  596. <ul class="simple"><li><a class="reference external" href="#errorStream,Process">errorStream proc</a></li>
    597. 

  597. <li><a class="reference external" href="#peekableOutputStream,Process">peekableOutputStream proc</a></li>
    598. 

  598. </ul>
    599. 

  599. 

  600.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    601. 

  601. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    602. 

  602. 

  603.   </dd>
    604. 

  604. </div>
    605. 

  605. 

  606. </div>
    607. 

  607. <div id="peekableOutputStream-procs-all">
    608. 

  608.   <div id="peekableOutputStream,Process">
    609. 

  609.   <dt><pre><span class="Keyword">proc</span> <a href="#peekableOutputStream%2CProcess"><span class="Identifier">peekableOutputStream</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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;nosp$1&quot;</span><span class="Other">,</span>
    610. 

  610.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><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>
    611. 

  611.   <dd>
    612. 

  612.     
    613. 

  613.     <p>Returns <tt class="docutils literal"><span class="pre">p</span></tt>'s output stream for reading from.</p>
    614. 

  614. <p>You can peek returned stream.</p>
    615. 

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

  616. The returned <tt class="docutils literal"><span class="pre"><span class="Identifier">Stream</span></span></tt> should not be closed manually as it is closed when closing the Process <tt class="docutils literal"><span class="pre">p</span></tt>.</div>
    617. 

  617. <p>See also:</p>
    618. 

  618. <ul class="simple"><li><a class="reference external" href="#outputStream,Process">outputStream proc</a></li>
    619. 

  619. <li><a class="reference external" href="#peekableErrorStream,Process">peekableErrorStream proc</a></li>
    620. 

  620. </ul>
    621. 

  621. 

  622.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L272" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    623. 

  623. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L272" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    624. 

  624. 

  625.   </dd>
    626. 

  626. </div>
    627. 

  627. 

  628. </div>
    629. 

  629. <div id="peekExitCode-procs-all">
    630. 

  630.   <div id="peekExitCode,Process">
    631. 

  631.   <dt><pre><span class="Keyword">proc</span> <a href="#peekExitCode%2CProcess"><span class="Identifier">peekExitCode</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</span><span class="Other">,</span>
    632. 

  632.                                      <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    633. 

  633.   <dd>
    634. 

  634.     
    635. 

  635.     <p>Return <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> if the process is still running. Otherwise the process' exit code.</p>
    636. 

  636. <p>On posix, if the process has exited because of a signal, 128 + signal number will be returned.</p>
    637. 

  637. 

  638.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L228" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    639. 

  639. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L228" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    640. 

  640. 

  641.   </dd>
    642. 

  642. </div>
    643. 

  643. 

  644. </div>
    645. 

  645. <div id="processID-procs-all">
    646. 

  646.   <div id="processID,Process">
    647. 

  647.   <dt><pre><span class="Keyword">proc</span> <a href="#processID%2CProcess"><span class="Identifier">processID</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;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>
    648. 

  648.                                   <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>Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>'s process ID.</p>
    652. 

  652. <p>See also:</p>
    653. 

  653. <ul class="simple"><li><a class="reference external" href="os.html#getCurrentProcessId">os.getCurrentProcessId proc</a></li>
    654. 

  654. </ul>
    655. 

  655. 

  656.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L207" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    657. 

  657. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L207" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    658. 

  658. 

  659.   </dd>
    660. 

  660. </div>
    661. 

  661. 

  662. </div>
    663. 

  663. <div id="readLines-procs-all">
    664. 

  664.   <div id="readLines,Process">
    665. 

  665.   <dt><pre><span class="Keyword">proc</span> <a href="#readLines%2CProcess"><span class="Identifier">readLines</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.
    666. 

  666.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">]</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> <a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    667. 

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

  668.   <dd>
    669. 

  669.     
    670. 

  670.     <p>Convenience function for working with <tt class="docutils literal"><span class="pre"><span class="Identifier">startProcess</span></span></tt> to read data from a background process.</p>
    671. 

  671. <p>See also:</p>
    672. 

  672. <ul class="simple"><li><a class="reference external" href="#lines.i,Process">lines iterator</a></li>
    673. 

  673. </ul>
    674. 

  674. <p>Example:</p>
    675. 

  675. <p><pre class="listing"><span class="Keyword">const</span> <span class="Identifier">opts</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Identifier">poUsePath</span><span class="Punctuation">,</span> <span class="Identifier">poDaemon</span><span class="Punctuation">,</span> <span class="Identifier">poStdErrToStdOut</span><span class="Punctuation">}</span>
    676. 

  676. <span class="Keyword">var</span> <span class="Identifier">ps</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">Process</span><span class="Punctuation">]</span>
    677. 

  677. <span class="Keyword">for</span> <span class="Identifier">prog</span> <span class="Keyword">in</span> <span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">:</span> <span class="Comment"># run 2 progs in parallel</span>
    678. 

  678.   <span class="Identifier">ps</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">startProcess</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">[</span><span class="StringLit">&quot;r&quot;</span><span class="Punctuation">,</span> <span class="Identifier">prog</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Keyword">nil</span><span class="Punctuation">,</span> <span class="Identifier">opts</span><span class="Punctuation">)</span>
    679. 

  679. <span class="Keyword">for</span> <span class="Identifier">p</span> <span class="Keyword">in</span> <span class="Identifier">ps</span><span class="Punctuation">:</span>
    680. 

  680.   <span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">lines</span><span class="Punctuation">,</span> <span class="Identifier">exCode</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">readLines</span>
    681. 

  681.   <span class="Keyword">if</span> <span class="Identifier">exCode</span> <span class="Operator">!=</span> <span class="DecNumber">0</span><span class="Punctuation">:</span>
    682. 

  682.     <span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">lines</span><span class="Punctuation">:</span> <span class="Identifier">echo</span> <span class="Identifier">line</span>
    683. 

  683.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">close</span></pre></p>
    684. 

  684. 

  685.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L489" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    686. 

  686. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L489" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    687. 

  687. 

  688.   </dd>
    689. 

  689. </div>
    690. 

  690. 

  691. </div>
    692. 

  692. <div id="resume-procs-all">
    693. 

  693.   <div id="resume,Process">
    694. 

  694.   <dt><pre><span class="Keyword">proc</span> <a href="#resume%2CProcess"><span class="Identifier">resume</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    695. 

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

  696.   <dd>
    697. 

  697.     
    698. 

  698.     <p>Resumes the process <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>.</p>
    699. 

  699. <p>See also:</p>
    700. 

  700. <ul class="simple"><li><a class="reference external" href="#suspend,Process">suspend proc</a></li>
    701. 

  701. <li><a class="reference external" href="#terminate,Process">terminate proc</a></li>
    702. 

  702. <li><a class="reference external" href="#kill,Process">kill proc</a></li>
    703. 

  703. </ul>
    704. 

  704. 

  705.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L171" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    706. 

  706. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L171" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    707. 

  707. 

  708.   </dd>
    709. 

  709. </div>
    710. 

  710. 

  711. </div>
    712. 

  712. <div id="running-procs-all">
    713. 

  713.   <div id="running,Process">
    714. 

  714.   <dt><pre><span class="Keyword">proc</span> <a href="#running%2CProcess"><span class="Identifier">running</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    715. 

  715.                                  <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>
    716. 

  716.   <dd>
    717. 

  717.     
    718. 

  718.     Returns true if the process <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is still running. Returns immediately.
    719. 

  719.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L204" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    720. 

  720. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L204" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    721. 

  721. 

  722.   </dd>
    723. 

  723. </div>
    724. 

  724. 

  725. </div>
    726. 

  726. <div id="startProcess-procs-all">
    727. 

  727.   <div id="startProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">
    728. 

  728.   <dt><pre><span class="Keyword">proc</span> <a href="#startProcess%2Cstring%2Cstring%2CopenArray%5Bstring%5D%2CStringTableRef%2Cset%5BProcessOption%5D"><span class="Identifier">startProcess</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">workingDir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    729. 

  729.                   <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><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">env</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    730. 

  730.                   <span class="Identifier">options</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="osproc.html#ProcessOption"><span class="Identifier">ProcessOption</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">poStdErrToStdOut</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    731. 

  731.     <span class="Identifier">Process</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> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">]</span><span class="Other">,</span>
    732. 

  732.                <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ExecIOEffect"><span class="Identifier">ExecIOEffect</span></a><span class="Other">,</span> <a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    733. 

  733.   <dd>
    734. 

  734.     
    735. 

  735.     <p>Starts a process. <tt class="docutils literal"><span class="pre"><span class="Identifier">Command</span></span></tt> is the executable file, <tt class="docutils literal"><span class="pre"><span class="Identifier">workingDir</span></span></tt> is the process's working directory. If <tt class="docutils literal"><span class="pre">workingDir == &quot;&quot;</span></tt> the current directory is used (default). <tt class="docutils literal"><span class="pre"><span class="Identifier">args</span></span></tt> are the command line arguments that are passed to the process. On many operating systems, the first command line argument is the name of the executable. <tt class="docutils literal"><span class="pre"><span class="Identifier">args</span></span></tt> should <em>not</em> contain this argument! <tt class="docutils literal"><span class="pre"><span class="Identifier">env</span></span></tt> is the environment that will be passed to the process. If <tt class="docutils literal"><span class="pre">env == nil</span></tt> (default) the environment is inherited of the parent process. <tt class="docutils literal"><span class="pre"><span class="Identifier">options</span></span></tt> are additional flags that may be passed to <tt class="docutils literal"><span class="pre"><span class="Identifier">startProcess</span></span></tt>. See the documentation of <a class="reference external" href="#ProcessOption">ProcessOption</a> for the meaning of these flags.</p>
    736. 

  736. <p>You need to <a class="reference external" href="#close,Process">close</a> the process when done.</p>
    737. 

  737. <p>Note that you can't pass any <tt class="docutils literal"><span class="pre"><span class="Identifier">args</span></span></tt> if you use the option <tt class="docutils literal"><span class="pre">poEvalCommand</span></tt>, which invokes the system shell to run the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">command</span></span></tt>. In this situation you have to concatenate manually the contents of <tt class="docutils literal"><span class="pre"><span class="Identifier">args</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">command</span></span></tt> carefully escaping/quoting any special characters, since it will be passed <em>as is</em> to the system shell. Each system/shell may feature different escaping rules, so try to avoid this kind of shell invocation if possible as it leads to non portable software.</p>
    738. 

  738. <p>Return value: The newly created process object. Nil is never returned, but <tt class="docutils literal"><span class="pre">OSError</span></tt> is raised in case of an error.</p>
    739. 

  739. <p>See also:</p>
    740. 

  740. <ul class="simple"><li><a class="reference external" href="#execProcesses,openArray[string],proc(int),proc(int,Process)">execProcesses proc</a></li>
    741. 

  741. <li><a class="reference external" href="#execProcess,string,string,openArray[string],StringTableRef,set[ProcessOption]">execProcess proc</a></li>
    742. 

  742. <li><a class="reference external" href="#execCmd,string">execCmd proc</a></li>
    743. 

  743. </ul>
    744. 

  744. 

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

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

  747. 

  748.   </dd>
    749. 

  749. </div>
    750. 

  750. 

  751. </div>
    752. 

  752. <div id="suspend-procs-all">
    753. 

  753.   <div id="suspend,Process">
    754. 

  754.   <dt><pre><span class="Keyword">proc</span> <a href="#suspend%2CProcess"><span class="Identifier">suspend</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</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>
    755. 

  755.                            <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>
    756. 

  756.   <dd>
    757. 

  757.     
    758. 

  758.     <p>Suspends the process <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>.</p>
    759. 

  759. <p>See also:</p>
    760. 

  760. <ul class="simple"><li><a class="reference external" href="#resume,Process">resume proc</a></li>
    761. 

  761. <li><a class="reference external" href="#terminate,Process">terminate proc</a></li>
    762. 

  762. <li><a class="reference external" href="#kill,Process">kill proc</a></li>
    763. 

  763. </ul>
    764. 

  764. 

  765.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L162" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    766. 

  766. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L162" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    767. 

  767. 

  768.   </dd>
    769. 

  769. </div>
    770. 

  770. 

  771. </div>
    772. 

  772. <div id="terminate-procs-all">
    773. 

  773.   <div id="terminate,Process">
    774. 

  774.   <dt><pre><span class="Keyword">proc</span> <a href="#terminate%2CProcess"><span class="Identifier">terminate</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</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;nosp$1&quot;</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>
    775. 

  775.                              <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>
    776. 

  776.   <dd>
    777. 

  777.     
    778. 

  778.     <p>Stop the process <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>.</p>
    779. 

  779. <p>On Posix OSes the procedure sends <tt class="docutils literal"><span class="pre">SIGTERM</span></tt> to the process. On Windows the Win32 API function <tt class="docutils literal"><span class="pre">TerminateProcess()</span></tt> is called to stop the process.</p>
    780. 

  780. <p>See also:</p>
    781. 

  781. <ul class="simple"><li><a class="reference external" href="#suspend,Process">suspend proc</a></li>
    782. 

  782. <li><a class="reference external" href="#resume,Process">resume proc</a></li>
    783. 

  783. <li><a class="reference external" href="#kill,Process">kill proc</a></li>
    784. 

  784. <li><a class="reference external" href="posix_utils.html#sendSignal,Pid,int">posix_utils.sendSignal(pid: Pid, signal: int)</a></li>
    785. 

  785. </ul>
    786. 

  786. 

  787.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L179" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    788. 

  788. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L179" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    789. 

  789. 

  790.   </dd>
    791. 

  791. </div>
    792. 

  792. 

  793. </div>
    794. 

  794. <div id="waitForExit-procs-all">
    795. 

  795.   <div id="waitForExit,Process,int">
    796. 

  796.   <dt><pre><span class="Keyword">proc</span> <a href="#waitForExit%2CProcess%2Cint"><span class="Identifier">waitForExit</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</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">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>
    797. 

  797.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">]</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    798. 

  798.   <dd>
    799. 

  799.     
    800. 

  800.     Waits for the process to finish and returns <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>'s error code.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    801. 

  801. Be careful when using <tt class="docutils literal"><span class="pre"><span class="Identifier">waitForExit</span></span></tt> for processes created without <tt class="docutils literal"><span class="pre"><span class="Identifier">poParentStreams</span></span></tt> because they may fill output buffers, causing deadlock.</div>
    802. 

  802. <p>On posix, if the process has exited because of a signal, 128 + signal number will be returned.</p>
    803. 

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

  804. When working with <tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> parameters, remember that the value is typically expressed in milliseconds, and ensure that the correct unit of time is used to avoid unexpected behavior.</div>
    805. 

  805. 

  806.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L214" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    807. 

  807. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L214" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    808. 

  808. 

  809.   </dd>
    810. 

  810. </div>
    811. 

  811. 

  812. </div>
    813. 

  813. 

  814.   </dl>
    815. 

  815. </div>
    816. 

  816. <div class="section" id="15">
    817. 

  817.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    818. 

  818.   <dl class="item">
    819. 

  819.     <div id="lines-iterators-all">
    820. 

  820.   <div id="lines.i,Process">
    821. 

  821.   <dt><pre><span class="Keyword">iterator</span> <a href="#lines.i%2CProcess"><span class="Identifier">lines</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="osproc.html#Process"><span class="Identifier">Process</span></a><span class="Other">;</span> <span class="Identifier">keepNewLines</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    822. 

  822.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">]</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> <a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    823. 

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

  824.   <dd>
    825. 

  825.     
    826. 

  826.     <p>Convenience iterator for working with <tt class="docutils literal"><span class="pre"><span class="Identifier">startProcess</span></span></tt> to read data from a background process.</p>
    827. 

  827. <p>See also:</p>
    828. 

  828. <ul class="simple"><li><a class="reference external" href="#readLines,Process">readLines proc</a></li>
    829. 

  829. </ul>
    830. 

  830. <p>Example:</p>
    831. 

  831. <p><pre class="listing"><span class="Keyword">const</span> <span class="Identifier">opts</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Identifier">poUsePath</span><span class="Punctuation">,</span> <span class="Identifier">poDaemon</span><span class="Punctuation">,</span> <span class="Identifier">poStdErrToStdOut</span><span class="Punctuation">}</span>
    832. 

  832. <span class="Keyword">var</span> <span class="Identifier">ps</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">Process</span><span class="Punctuation">]</span>
    833. 

  833. <span class="Keyword">for</span> <span class="Identifier">prog</span> <span class="Keyword">in</span> <span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">:</span> <span class="Comment"># run 2 progs in parallel</span>
    834. 

  834.   <span class="Identifier">ps</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">startProcess</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">[</span><span class="StringLit">&quot;r&quot;</span><span class="Punctuation">,</span> <span class="Identifier">prog</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Keyword">nil</span><span class="Punctuation">,</span> <span class="Identifier">opts</span><span class="Punctuation">)</span>
    835. 

  835. <span class="Keyword">for</span> <span class="Identifier">p</span> <span class="Keyword">in</span> <span class="Identifier">ps</span><span class="Punctuation">:</span>
    836. 

  836.   <span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
    837. 

  837.   <span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">lines</span><span class="Punctuation">:</span>
    838. 

  838.     <span class="Identifier">echo</span> <span class="Identifier">line</span>
    839. 

  839.     <span class="Identifier">i</span><span class="Operator">.</span><span class="Identifier">inc</span>
    840. 

  840.     <span class="Keyword">if</span> <span class="Identifier">i</span> <span class="Operator">&gt;</span> <span class="DecNumber">100</span><span class="Punctuation">:</span> <span class="Keyword">break</span>
    841. 

  841.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">close</span></pre></p>
    842. 

  842. 

  843.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/osproc.nim#L460" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    844. 

  844. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/osproc.nim#L460" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    845. 

  845. 

  846.   </dd>
    847. 

  847. </div>
    848. 

  848. 

  849. </div>
    850. 

  850. 

  851.   </dl>
    852. 

  852. </div>
    853. 

  853. 

  854.   </div>
    855. 

  855. </div>
    856. 

  856. 

  857.       <div class="twelve-columns footer">
    858. 

  858.         <span class="nim-sprite"></span>
    859. 

  859.         <br>
    860. 

  860.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:21 UTC</small>
    861. 

  861.       </div>
    862. 

  862.     </div>
    863. 

  863.   </div>
    864. 

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

  865.     
    866. 

  866. </body>
    867. 

  867. </html>
    868. 

  868.