Home Esplora Aiuto
Accedi
levovix
/
Nim
mirror da https://github.com/nim-lang/Nim
Segui 1
Vota 0
Forka 1
File Problemi 0 Wiki
Ramo (Branch): gh-pages
Rami (Branch) Tag
Nim
/
terminal.html

terminal.html 113 KB
Permalink Cronologia Originale

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294 
  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/terminal</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/terminal</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><a class="reference" id="progress-bar_toc" href="#progress-bar">Progress bar</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="progress-bar-playing-with-colorful-and-styled-text_toc" href="#progress-bar-playing-with-colorful-and-styled-text">Playing with colorful and styled text</a></li>
    56. 

  56. </ul><li>
    57. 

  57.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    58. 

  58. </li>
    59. 

  59. <li>
    60. 

  60.   <details open>
    61. 

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

  62.     <ul class="simple simple-toc-section">
    63. 

  63.       <li><a class="reference" href="#BackgroundColor" title="BackgroundColor = enum
    64. 

  64.   bgBlack = 40,             ## black
    65. 

  65.   bgRed,                    ## red
    66. 

  66.   bgGreen,                  ## green
    67. 

  67.   bgYellow,                 ## yellow
    68. 

  68.   bgBlue,                   ## blue
    69. 

  69.   bgMagenta,                ## magenta
    70. 

  70.   bgCyan,                   ## cyan
    71. 

  71.   bgWhite,                  ## white
    72. 

  72.   bg8Bit,                   ## 256-color (not supported, see `enableTrueColors` instead.)
    73. 

  73.   bgDefault                  ## default terminal background color">BackgroundColor</a></li>
    74. 

  74. <li><a class="reference" href="#ForegroundColor" title="ForegroundColor = enum
    75. 

  75.   fgBlack = 30,             ## black
    76. 

  76.   fgRed,                    ## red
    77. 

  77.   fgGreen,                  ## green
    78. 

  78.   fgYellow,                 ## yellow
    79. 

  79.   fgBlue,                   ## blue
    80. 

  80.   fgMagenta,                ## magenta
    81. 

  81.   fgCyan,                   ## cyan
    82. 

  82.   fgWhite,                  ## white
    83. 

  83.   fg8Bit,                   ## 256-color (not supported, see `enableTrueColors` instead.)
    84. 

  84.   fgDefault                  ## default terminal foreground color">ForegroundColor</a></li>
    85. 

  85. <li><a class="reference" href="#Style" title="Style = enum
    86. 

  86.   styleBright = 1,          ## bright text
    87. 

  87.   styleDim,                 ## dim text
    88. 

  88.   styleItalic,              ## italic (or reverse on terminals not supporting)
    89. 

  89.   styleUnderscore,          ## underscored text
    90. 

  90.   styleBlink,               ## blinking/bold text
    91. 

  91.   styleBlinkRapid,          ## rapid blinking/bold text (not widely supported)
    92. 

  92.   styleReverse,             ## reverse
    93. 

  93.   styleHidden,              ## hidden text
    94. 

  94.   styleStrikethrough         ## strikethrough">Style</a></li>
    95. 

  95. <li><a class="reference" href="#TerminalCmd" title="TerminalCmd = enum
    96. 

  96.   resetStyle,               ## reset attributes
    97. 

  97.   fgColor,                  ## set foreground's true color
    98. 

  98.   bgColor                    ## set background's true color">TerminalCmd</a></li>
    99. 

  99. 

  100.     </ul>
    101. 

  101.   </details>
    102. 

  102. </li>
    103. 

  103. <li>
    104. 

  104.   <details open>
    105. 

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

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

  107.       <li><a class="reference" href="#ansiResetCode" title="ansiResetCode = &quot;\e[0m&quot;">ansiResetCode</a></li>
    108. 

  108. 

  109.     </ul>
    110. 

  110.   </details>
    111. 

  111. </li>
    112. 

  112. <li>
    113. 

  113.   <details open>
    114. 

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

  115.     <ul class="simple simple-toc-section">
    116. 

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

  117.   <li><a class="reference" href="#ansiBackgroundColorCode%2CColor" title="ansiBackgroundColorCode(color: Color): string">ansiBackgroundColorCode(color: Color): string</a></li>
    118. 

  118. 

  119. </ul>
    120. 

  120. <ul class="simple nested-toc-section">ansiForegroundColorCode
    121. 

  121.   <li><a class="reference" href="#ansiForegroundColorCode%2CColor" title="ansiForegroundColorCode(color: Color): string">ansiForegroundColorCode(color: Color): string</a></li>
    122. 

  122. <li><a class="reference" href="#ansiForegroundColorCode%2CForegroundColor" title="ansiForegroundColorCode(fg: ForegroundColor; bright = false): string">ansiForegroundColorCode(fg: ForegroundColor; bright = false): string</a></li>
    123. 

  123. 

  124. </ul>
    125. 

  125. <ul class="simple nested-toc-section">ansiStyleCode
    126. 

  126.   <li><a class="reference" href="#ansiStyleCode%2Cint" title="ansiStyleCode(style: int): string">ansiStyleCode(style: int): string</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">cursorBackward
    130. 

  130.   <li><a class="reference" href="#cursorBackward%2CFile%2Cint" title="cursorBackward(f: File; count = 1)">cursorBackward(f: File; count = 1)</a></li>
    131. 

  131. 

  132. </ul>
    133. 

  133. <ul class="simple nested-toc-section">cursorDown
    134. 

  134.   <li><a class="reference" href="#cursorDown%2CFile%2Cint" title="cursorDown(f: File; count = 1)">cursorDown(f: File; count = 1)</a></li>
    135. 

  135. 

  136. </ul>
    137. 

  137. <ul class="simple nested-toc-section">cursorForward
    138. 

  138.   <li><a class="reference" href="#cursorForward%2CFile%2Cint" title="cursorForward(f: File; count = 1)">cursorForward(f: File; count = 1)</a></li>
    139. 

  139. 

  140. </ul>
    141. 

  141. <ul class="simple nested-toc-section">cursorUp
    142. 

  142.   <li><a class="reference" href="#cursorUp%2CFile%2Cint" title="cursorUp(f: File; count = 1)">cursorUp(f: File; count = 1)</a></li>
    143. 

  143. 

  144. </ul>
    145. 

  145. <ul class="simple nested-toc-section">disableTrueColors
    146. 

  146.   <li><a class="reference" href="#disableTrueColors" title="disableTrueColors()">disableTrueColors()</a></li>
    147. 

  147. 

  148. </ul>
    149. 

  149. <ul class="simple nested-toc-section">enableTrueColors
    150. 

  150.   <li><a class="reference" href="#enableTrueColors" title="enableTrueColors()">enableTrueColors()</a></li>
    151. 

  151. 

  152. </ul>
    153. 

  153. <ul class="simple nested-toc-section">eraseLine
    154. 

  154.   <li><a class="reference" href="#eraseLine%2CFile" title="eraseLine(f: File)">eraseLine(f: File)</a></li>
    155. 

  155. 

  156. </ul>
    157. 

  157. <ul class="simple nested-toc-section">eraseScreen
    158. 

  158.   <li><a class="reference" href="#eraseScreen%2CFile" title="eraseScreen(f: File)">eraseScreen(f: File)</a></li>
    159. 

  159. 

  160. </ul>
    161. 

  161. <ul class="simple nested-toc-section">getch
    162. 

  162.   <li><a class="reference" href="#getch" title="getch(): char">getch(): char</a></li>
    163. 

  163. 

  164. </ul>
    165. 

  165. <ul class="simple nested-toc-section">getCursorPos
    166. 

  166.   <li><a class="reference" href="#getCursorPos" title="getCursorPos(): tuple[x, y: int]">getCursorPos(): tuple[x, y: int]</a></li>
    167. 

  167. 

  168. </ul>
    169. 

  169. <ul class="simple nested-toc-section">hideCursor
    170. 

  170.   <li><a class="reference" href="#hideCursor%2CFile" title="hideCursor(f: File)">hideCursor(f: File)</a></li>
    171. 

  171. 

  172. </ul>
    173. 

  173. <ul class="simple nested-toc-section">isatty
    174. 

  174.   <li><a class="reference" href="#isatty%2CFile" title="isatty(f: File): bool">isatty(f: File): bool</a></li>
    175. 

  175. 

  176. </ul>
    177. 

  177. <ul class="simple nested-toc-section">isTrueColorSupported
    178. 

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

  179. 

  180. </ul>
    181. 

  181. <ul class="simple nested-toc-section">readPasswordFromStdin
    182. 

  182.   <li><a class="reference" href="#readPasswordFromStdin%2Cstring" title="readPasswordFromStdin(prompt = &quot;password: &quot;): string">readPasswordFromStdin(prompt = &quot;password: &quot;): string</a></li>
    183. 

  183. <li><a class="reference" href="#readPasswordFromStdin%2Cstring%2Cstring" title="readPasswordFromStdin(prompt: string; password: var string): bool">readPasswordFromStdin(prompt: string; password: var string): bool</a></li>
    184. 

  184. 

  185. </ul>
    186. 

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

  187.   <li><a class="reference" href="#resetAttributes" title="resetAttributes()">resetAttributes()</a></li>
    188. 

  188. <li><a class="reference" href="#resetAttributes%2CFile" title="resetAttributes(f: File)">resetAttributes(f: File)</a></li>
    189. 

  189. 

  190. </ul>
    191. 

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

  192.   <li><a class="reference" href="#setBackgroundColor%2CFile%2CBackgroundColor" title="setBackgroundColor(f: File; bg: BackgroundColor; bright = false)">setBackgroundColor(f: File; bg: BackgroundColor; bright = false)</a></li>
    193. 

  193. <li><a class="reference" href="#setBackgroundColor%2CFile%2CColor" title="setBackgroundColor(f: File; color: Color)">setBackgroundColor(f: File; color: Color)</a></li>
    194. 

  194. 

  195. </ul>
    196. 

  196. <ul class="simple nested-toc-section">setCursorPos
    197. 

  197.   <li><a class="reference" href="#setCursorPos%2CFile%2Cint%2Cint" title="setCursorPos(f: File; x, y: int)">setCursorPos(f: File; x, y: int)</a></li>
    198. 

  198. 

  199. </ul>
    200. 

  200. <ul class="simple nested-toc-section">setCursorXPos
    201. 

  201.   <li><a class="reference" href="#setCursorXPos%2CFile%2Cint" title="setCursorXPos(f: File; x: int)">setCursorXPos(f: File; x: int)</a></li>
    202. 

  202. 

  203. </ul>
    204. 

  204. <ul class="simple nested-toc-section">setForegroundColor
    205. 

  205.   <li><a class="reference" href="#setForegroundColor%2CFile%2CColor" title="setForegroundColor(f: File; color: Color)">setForegroundColor(f: File; color: Color)</a></li>
    206. 

  206. <li><a class="reference" href="#setForegroundColor%2CFile%2CForegroundColor" title="setForegroundColor(f: File; fg: ForegroundColor; bright = false)">setForegroundColor(f: File; fg: ForegroundColor; bright = false)</a></li>
    207. 

  207. 

  208. </ul>
    209. 

  209. <ul class="simple nested-toc-section">setStyle
    210. 

  210.   <li><a class="reference" href="#setStyle%2CFile%2Cset%5BStyle%5D" title="setStyle(f: File; style: set[Style])">setStyle(f: File; style: set[Style])</a></li>
    211. 

  211. 

  212. </ul>
    213. 

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

  214.   <li><a class="reference" href="#showCursor%2CFile" title="showCursor(f: File)">showCursor(f: File)</a></li>
    215. 

  215. 

  216. </ul>
    217. 

  217. <ul class="simple nested-toc-section">terminalHeight
    218. 

  218.   <li><a class="reference" href="#terminalHeight" title="terminalHeight(): int">terminalHeight(): int</a></li>
    219. 

  219. 

  220. </ul>
    221. 

  221. <ul class="simple nested-toc-section">terminalHeightIoctl
    222. 

  222.   <li><a class="reference" href="#terminalHeightIoctl%2CopenArray%5Bint%5D" title="terminalHeightIoctl(fds: openArray[int]): int">terminalHeightIoctl(fds: openArray[int]): int</a></li>
    223. 

  223. 

  224. </ul>
    225. 

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

  226.   <li><a class="reference" href="#terminalSize" title="terminalSize(): tuple[w, h: int]">terminalSize(): tuple[w, h: int]</a></li>
    227. 

  227. 

  228. </ul>
    229. 

  229. <ul class="simple nested-toc-section">terminalWidth
    230. 

  230.   <li><a class="reference" href="#terminalWidth" title="terminalWidth(): int">terminalWidth(): int</a></li>
    231. 

  231. 

  232. </ul>
    233. 

  233. <ul class="simple nested-toc-section">terminalWidthIoctl
    234. 

  234.   <li><a class="reference" href="#terminalWidthIoctl%2CopenArray%5Bint%5D" title="terminalWidthIoctl(fds: openArray[int]): int">terminalWidthIoctl(fds: openArray[int]): int</a></li>
    235. 

  235. 

  236. </ul>
    237. 

  237. <ul class="simple nested-toc-section">writeStyled
    238. 

  238.   <li><a class="reference" href="#writeStyled%2Cstring%2Cset%5BStyle%5D" title="writeStyled(txt: string; style: set[Style] = {styleBright})">writeStyled(txt: string; style: set[Style] = {styleBright})</a></li>
    239. 

  239. 

  240. </ul>
    241. 

  241. 

  242.     </ul>
    243. 

  243.   </details>
    244. 

  244. </li>
    245. 

  245. <li>
    246. 

  246.   <details open>
    247. 

  247.     <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
    248. 

  248.     <ul class="simple simple-toc-section">
    249. 

  249.       <ul class="simple nested-toc-section">styledWrite
    250. 

  250.   <li><a class="reference" href="#styledWrite.m%2CFile%2Cvarargs%5Btyped%5D" title="styledWrite(f: File; m: varargs[typed]): untyped">styledWrite(f: File; m: varargs[typed]): untyped</a></li>
    251. 

  251. 

  252. </ul>
    253. 

  253. 

  254.     </ul>
    255. 

  255.   </details>
    256. 

  256. </li>
    257. 

  257. <li>
    258. 

  258.   <details open>
    259. 

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

  260.     <ul class="simple simple-toc-section">
    261. 

  261.       <ul class="simple nested-toc-section">ansiBackgroundColorCode
    262. 

  262.   <li><a class="reference" href="#ansiBackgroundColorCode.t%2Cstatic%5BColor%5D" title="ansiBackgroundColorCode(color: static[Color]): string">ansiBackgroundColorCode(color: static[Color]): string</a></li>
    263. 

  263. 

  264. </ul>
    265. 

  265. <ul class="simple nested-toc-section">ansiForegroundColorCode
    266. 

  266.   <li><a class="reference" href="#ansiForegroundColorCode.t%2Cstatic%5BColor%5D" title="ansiForegroundColorCode(color: static[Color]): string">ansiForegroundColorCode(color: static[Color]): string</a></li>
    267. 

  267. <li><a class="reference" href="#ansiForegroundColorCode.t%2Cstatic%5BForegroundColor%5D%2Cstatic%5Bbool%5D" title="ansiForegroundColorCode(fg: static[ForegroundColor];
    268. 

  268.                         bright: static[bool] = false): string">ansiForegroundColorCode(fg: static[ForegroundColor];
    269. 

  269.                         bright: static[bool] = false): string</a></li>
    270. 

  270. 

  271. </ul>
    272. 

  272. <ul class="simple nested-toc-section">ansiStyleCode
    273. 

  273.   <li><a class="reference" href="#ansiStyleCode.t%2Cstatic%5BStyle%5D" title="ansiStyleCode(style: static[Style]): string">ansiStyleCode(style: static[Style]): string</a></li>
    274. 

  274. <li><a class="reference" href="#ansiStyleCode.t%2CStyle" title="ansiStyleCode(style: Style): string">ansiStyleCode(style: Style): string</a></li>
    275. 

  275. 

  276. </ul>
    277. 

  277. <ul class="simple nested-toc-section">cursorBackward
    278. 

  278.   <li><a class="reference" href="#cursorBackward.t%2Cint" title="cursorBackward(count = 1)">cursorBackward(count = 1)</a></li>
    279. 

  279. 

  280. </ul>
    281. 

  281. <ul class="simple nested-toc-section">cursorDown
    282. 

  282.   <li><a class="reference" href="#cursorDown.t%2Cint" title="cursorDown(count = 1)">cursorDown(count = 1)</a></li>
    283. 

  283. 

  284. </ul>
    285. 

  285. <ul class="simple nested-toc-section">cursorForward
    286. 

  286.   <li><a class="reference" href="#cursorForward.t%2Cint" title="cursorForward(count = 1)">cursorForward(count = 1)</a></li>
    287. 

  287. 

  288. </ul>
    289. 

  289. <ul class="simple nested-toc-section">cursorUp
    290. 

  290.   <li><a class="reference" href="#cursorUp.t%2Cint" title="cursorUp(count = 1)">cursorUp(count = 1)</a></li>
    291. 

  291. 

  292. </ul>
    293. 

  293. <ul class="simple nested-toc-section">eraseLine
    294. 

  294.   <li><a class="reference" href="#eraseLine.t" title="eraseLine()">eraseLine()</a></li>
    295. 

  295. 

  296. </ul>
    297. 

  297. <ul class="simple nested-toc-section">eraseScreen
    298. 

  298.   <li><a class="reference" href="#eraseScreen.t" title="eraseScreen()">eraseScreen()</a></li>
    299. 

  299. 

  300. </ul>
    301. 

  301. <ul class="simple nested-toc-section">hideCursor
    302. 

  302.   <li><a class="reference" href="#hideCursor.t" title="hideCursor()">hideCursor()</a></li>
    303. 

  303. 

  304. </ul>
    305. 

  305. <ul class="simple nested-toc-section">setBackgroundColor
    306. 

  306.   <li><a class="reference" href="#setBackgroundColor.t%2CBackgroundColor" title="setBackgroundColor(bg: BackgroundColor; bright = false)">setBackgroundColor(bg: BackgroundColor; bright = false)</a></li>
    307. 

  307. <li><a class="reference" href="#setBackgroundColor.t%2CColor" title="setBackgroundColor(color: Color)">setBackgroundColor(color: Color)</a></li>
    308. 

  308. 

  309. </ul>
    310. 

  310. <ul class="simple nested-toc-section">setCursorPos
    311. 

  311.   <li><a class="reference" href="#setCursorPos.t%2Cint%2Cint" title="setCursorPos(x, y: int)">setCursorPos(x, y: int)</a></li>
    312. 

  312. 

  313. </ul>
    314. 

  314. <ul class="simple nested-toc-section">setCursorXPos
    315. 

  315.   <li><a class="reference" href="#setCursorXPos.t%2Cint" title="setCursorXPos(x: int)">setCursorXPos(x: int)</a></li>
    316. 

  316. 

  317. </ul>
    318. 

  318. <ul class="simple nested-toc-section">setForegroundColor
    319. 

  319.   <li><a class="reference" href="#setForegroundColor.t%2CColor" title="setForegroundColor(color: Color)">setForegroundColor(color: Color)</a></li>
    320. 

  320. <li><a class="reference" href="#setForegroundColor.t%2CForegroundColor" title="setForegroundColor(fg: ForegroundColor; bright = false)">setForegroundColor(fg: ForegroundColor; bright = false)</a></li>
    321. 

  321. 

  322. </ul>
    323. 

  323. <ul class="simple nested-toc-section">setStyle
    324. 

  324.   <li><a class="reference" href="#setStyle.t%2Cset%5BStyle%5D" title="setStyle(style: set[Style])">setStyle(style: set[Style])</a></li>
    325. 

  325. 

  326. </ul>
    327. 

  327. <ul class="simple nested-toc-section">showCursor
    328. 

  328.   <li><a class="reference" href="#showCursor.t" title="showCursor()">showCursor()</a></li>
    329. 

  329. 

  330. </ul>
    331. 

  331. <ul class="simple nested-toc-section">styledEcho
    332. 

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

  333. 

  334. </ul>
    335. 

  335. <ul class="simple nested-toc-section">styledWriteLine
    336. 

  336.   <li><a class="reference" href="#styledWriteLine.t%2CFile%2Cvarargs%5Buntyped%5D" title="styledWriteLine(f: File; args: varargs[untyped])">styledWriteLine(f: File; args: varargs[untyped])</a></li>
    337. 

  337. 

  338. </ul>
    339. 

  339. 

  340.     </ul>
    341. 

  341.   </details>
    342. 

  342. </li>
    343. 

  343. 

  344. </ul>
    345. 

  345. 

  346.   </div>
    347. 

  347.   <div class="nine columns" id="content">
    348. 

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

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

  350. 

  351.     <div id="tocRoot"></div>
    352. 

  352.     
    353. 

  353.     <p class="module-desc">This module contains a few procedures to control the <em>terminal</em> (also called <em>console</em>). On UNIX, the implementation simply uses ANSI escape sequences and does not depend on any other module, on Windows it uses the Windows API. Changing the style is permanent even after program termination! Use the code <tt class="docutils literal"><span class="pre"><span class="Identifier">exitprocs</span><span class="Operator">.</span><span class="Identifier">addExitProc</span><span class="Punctuation">(</span><span class="Identifier">resetAttributes</span><span class="Punctuation">)</span></span></tt> to restore the defaults. Similarly, if you hide the cursor, make sure to unhide it with <tt class="docutils literal"><span class="pre"><span class="Identifier">showCursor</span></span></tt> before quitting.
    354. 

  354. <h1><a class="toc-backref" id="progress-bar" href="#progress-bar">Progress bar</a></h1><p>Basic progress bar example:</p>
    355. 

  355. 

  356. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    357. 

  357. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">terminal</span>
    358. 

  358. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">os</span><span class="Punctuation">,</span> <span class="Identifier">strutils</span><span class="Punctuation">]</span>
    359. 

  359. 

  360. <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">100</span><span class="Punctuation">:</span>
    361. 

  361.   <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Identifier">fgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;0% &quot;</span><span class="Punctuation">,</span> <span class="Identifier">fgWhite</span><span class="Punctuation">,</span> <span class="CharLit">'#'</span><span class="Operator">.</span><span class="Identifier">repeat</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="Keyword">if</span> <span class="Identifier">i</span> <span class="Operator">&gt;</span> <span class="DecNumber">50</span><span class="Punctuation">:</span> <span class="Identifier">fgGreen</span> <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">fgYellow</span><span class="Punctuation">,</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="StringLit">&quot;</span><span class="Punctuation">,</span> <span class="Operator">$</span><span class="Identifier">i</span> <span class="Punctuation">,</span> <span class="StringLit">&quot;%&quot;</span><span class="Punctuation">)</span>
    362. 

  362.   <span class="Identifier">sleep</span> <span class="DecNumber">42</span>
    363. 

  363.   <span class="Identifier">cursorUp</span> <span class="DecNumber">1</span>
    364. 

  364.   <span class="Identifier">eraseLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    365. 

  365. 

  366. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">resetAttributes</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    367. 

  367. <h2><a class="toc-backref" id="progress-bar-playing-with-colorful-and-styled-text" href="#progress-bar-playing-with-colorful-and-styled-text">Playing with colorful and styled text</a></h2>Procs like <tt class="docutils literal"><span class="pre"><span class="Identifier">styledWriteLine</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">styledEcho</span></span></tt> etc. have a temporary effect on text parameters. Style parameters only affect the text parameter right after them. After being called, these procs will reset the default style of the terminal. While <tt class="docutils literal"><span class="pre"><span class="Identifier">setBackGroundColor</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">setForeGroundColor</span></span></tt> etc. have a lasting influence on the terminal, you can use <tt class="docutils literal"><span class="pre"><span class="Identifier">resetAttributes</span></span></tt> to reset the default style of the terminal.
    368. 

  368. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    369. 

  369. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">terminal</span>
    370. 

  370. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="Identifier">styleBright</span><span class="Punctuation">,</span> <span class="Identifier">styleBlink</span><span class="Punctuation">,</span> <span class="Identifier">styleUnderscore</span><span class="Punctuation">}</span><span class="Punctuation">,</span> <span class="StringLit">&quot;styled text &quot;</span><span class="Punctuation">)</span>
    371. 

  371. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Identifier">fgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;red text &quot;</span><span class="Punctuation">)</span>
    372. 

  372. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Identifier">fgWhite</span><span class="Punctuation">,</span> <span class="Identifier">bgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;white text in red background&quot;</span><span class="Punctuation">)</span>
    373. 

  373. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="StringLit">&quot; ordinary text without style &quot;</span><span class="Punctuation">)</span>
    374. 

  374. 

  375. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">setBackGroundColor</span><span class="Punctuation">(</span><span class="Identifier">bgCyan</span><span class="Punctuation">,</span> <span class="Identifier">true</span><span class="Punctuation">)</span>
    376. 

  376. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">setForeGroundColor</span><span class="Punctuation">(</span><span class="Identifier">fgBlue</span><span class="Punctuation">)</span>
    377. 

  377. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="StringLit">&quot;blue text in cyan background&quot;</span><span class="Punctuation">)</span>
    378. 

  378. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">resetAttributes</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    379. 

  379. 

  380. <span class="Comment"># You can specify multiple text parameters. Style parameters</span>
    381. 

  381. <span class="Comment"># only affect the text parameter right after them.</span>
    382. 

  382. <span class="Identifier">styledEcho</span> <span class="Identifier">styleBright</span><span class="Punctuation">,</span> <span class="Identifier">fgGreen</span><span class="Punctuation">,</span> <span class="StringLit">&quot;[PASS]&quot;</span><span class="Punctuation">,</span> <span class="Identifier">resetStyle</span><span class="Punctuation">,</span> <span class="Identifier">fgGreen</span><span class="Punctuation">,</span> <span class="StringLit">&quot; Yay!&quot;</span>
    383. 

  383. 

  384. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Identifier">fgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;red text &quot;</span><span class="Punctuation">,</span> <span class="Identifier">styleBright</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bold red&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fgDefault</span><span class="Punctuation">,</span> <span class="StringLit">&quot; bold text&quot;</span><span class="Punctuation">)</span></pre></p>
    385. 

  385.     <div class="section" id="6">
    386. 

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

  387.   <dl class="item">
    388. 

  388.     <a class="reference external" href="macros.html">macros</a>, <a class="reference external" href="strformat.html">strformat</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="colors.html">colors</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="termios.html">termios</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="parseutils.html">parseutils</a>, <a class="reference external" href="termios.html">termios</a>
    389. 

  389.   </dl>
    390. 

  390. </div>
    391. 

  391. <div class="section" id="7">
    392. 

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

  393.   <dl class="item">
    394. 

  394.     <div id="BackgroundColor">
    395. 

  395.   <dt><pre><a href="terminal.html#BackgroundColor"><span class="Identifier">BackgroundColor</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    396. 

  396.   <span class="Identifier">bgBlack</span> <span class="Other">=</span> <span class="DecNumber">40</span><span class="Other">,</span>             <span class="Comment">## black</span>
    397. 

  397.   <span class="Identifier">bgRed</span><span class="Other">,</span>                    <span class="Comment">## red</span>
    398. 

  398.   <span class="Identifier">bgGreen</span><span class="Other">,</span>                  <span class="Comment">## green</span>
    399. 

  399.   <span class="Identifier">bgYellow</span><span class="Other">,</span>                 <span class="Comment">## yellow</span>
    400. 

  400.   <span class="Identifier">bgBlue</span><span class="Other">,</span>                   <span class="Comment">## blue</span>
    401. 

  401.   <span class="Identifier">bgMagenta</span><span class="Other">,</span>                <span class="Comment">## magenta</span>
    402. 

  402.   <span class="Identifier">bgCyan</span><span class="Other">,</span>                   <span class="Comment">## cyan</span>
    403. 

  403.   <span class="Identifier">bgWhite</span><span class="Other">,</span>                  <span class="Comment">## white</span>
    404. 

  404.   <span class="Identifier">bg8Bit</span><span class="Other">,</span>                   <span class="Comment">## 256-color (not supported, see `enableTrueColors` instead.)</span>
    405. 

  405.   <span class="Identifier">bgDefault</span>                  <span class="Comment">## default terminal background color</span></pre></dt>
    406. 

  406.   <dd>
    407. 

  407.     
    408. 

  408.     Terminal's background colors.
    409. 

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

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

  411. 

  412.   </dd>
    413. 

  413. </div>
    414. 

  414. <div id="ForegroundColor">
    415. 

  415.   <dt><pre><a href="terminal.html#ForegroundColor"><span class="Identifier">ForegroundColor</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    416. 

  416.   <span class="Identifier">fgBlack</span> <span class="Other">=</span> <span class="DecNumber">30</span><span class="Other">,</span>             <span class="Comment">## black</span>
    417. 

  417.   <span class="Identifier">fgRed</span><span class="Other">,</span>                    <span class="Comment">## red</span>
    418. 

  418.   <span class="Identifier">fgGreen</span><span class="Other">,</span>                  <span class="Comment">## green</span>
    419. 

  419.   <span class="Identifier">fgYellow</span><span class="Other">,</span>                 <span class="Comment">## yellow</span>
    420. 

  420.   <span class="Identifier">fgBlue</span><span class="Other">,</span>                   <span class="Comment">## blue</span>
    421. 

  421.   <span class="Identifier">fgMagenta</span><span class="Other">,</span>                <span class="Comment">## magenta</span>
    422. 

  422.   <span class="Identifier">fgCyan</span><span class="Other">,</span>                   <span class="Comment">## cyan</span>
    423. 

  423.   <span class="Identifier">fgWhite</span><span class="Other">,</span>                  <span class="Comment">## white</span>
    424. 

  424.   <span class="Identifier">fg8Bit</span><span class="Other">,</span>                   <span class="Comment">## 256-color (not supported, see `enableTrueColors` instead.)</span>
    425. 

  425.   <span class="Identifier">fgDefault</span>                  <span class="Comment">## default terminal foreground color</span></pre></dt>
    426. 

  426.   <dd>
    427. 

  427.     
    428. 

  428.     Terminal's foreground colors.
    429. 

  429.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L674" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    430. 

  430. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L674" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    431. 

  431. 

  432.   </dd>
    433. 

  433. </div>
    434. 

  434. <div id="Style">
    435. 

  435.   <dt><pre><a href="terminal.html#Style"><span class="Identifier">Style</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    436. 

  436.   <span class="Identifier">styleBright</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span>          <span class="Comment">## bright text</span>
    437. 

  437.   <span class="Identifier">styleDim</span><span class="Other">,</span>                 <span class="Comment">## dim text</span>
    438. 

  438.   <span class="Identifier">styleItalic</span><span class="Other">,</span>              <span class="Comment">## italic (or reverse on terminals not supporting)</span>
    439. 

  439.   <span class="Identifier">styleUnderscore</span><span class="Other">,</span>          <span class="Comment">## underscored text</span>
    440. 

  440.   <span class="Identifier">styleBlink</span><span class="Other">,</span>               <span class="Comment">## blinking/bold text</span>
    441. 

  441.   <span class="Identifier">styleBlinkRapid</span><span class="Other">,</span>          <span class="Comment">## rapid blinking/bold text (not widely supported)</span>
    442. 

  442.   <span class="Identifier">styleReverse</span><span class="Other">,</span>             <span class="Comment">## reverse</span>
    443. 

  443.   <span class="Identifier">styleHidden</span><span class="Other">,</span>              <span class="Comment">## hidden text</span>
    444. 

  444.   <span class="Identifier">styleStrikethrough</span>         <span class="Comment">## strikethrough</span></pre></dt>
    445. 

  445.   <dd>
    446. 

  446.     
    447. 

  447.     Different styles for text output.
    448. 

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

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

  450. 

  451.   </dd>
    452. 

  452. </div>
    453. 

  453. <div id="TerminalCmd">
    454. 

  454.   <dt><pre><a href="terminal.html#TerminalCmd"><span class="Identifier">TerminalCmd</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    455. 

  455.   <span class="Identifier">resetStyle</span><span class="Other">,</span>               <span class="Comment">## reset attributes</span>
    456. 

  456.   <span class="Identifier">fgColor</span><span class="Other">,</span>                  <span class="Comment">## set foreground's true color</span>
    457. 

  457.   <span class="Identifier">bgColor</span>                    <span class="Comment">## set background's true color</span></pre></dt>
    458. 

  458.   <dd>
    459. 

  459.     
    460. 

  460.     commands that can be expressed as arguments
    461. 

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

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

  463. 

  464.   </dd>
    465. 

  465. </div>
    466. 

  466. 

  467.   </dl>
    468. 

  468. </div>
    469. 

  469. <div class="section" id="10">
    470. 

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

  471.   <dl class="item">
    472. 

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

  473.   <dt><pre><a href="terminal.html#ansiResetCode"><span class="Identifier">ansiResetCode</span></a> <span class="Other">=</span> <span class="StringLit">&quot;\e[0m&quot;</span></pre></dt>
    474. 

  474.   <dd>
    475. 

  475.     
    476. 

  476.     
    477. 

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

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

  479. 

  480.   </dd>
    481. 

  481. </div>
    482. 

  482. 

  483.   </dl>
    484. 

  484. </div>
    485. 

  485. <div class="section" id="12">
    486. 

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

  487.   <dl class="item">
    488. 

  488.     <div id="ansiBackgroundColorCode-procs-all">
    489. 

  489.   <div id="ansiBackgroundColorCode,Color">
    490. 

  490.   <dt><pre><span class="Keyword">proc</span> <a href="#ansiBackgroundColorCode%2CColor"><span class="Identifier">ansiBackgroundColorCode</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    491. 

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

  492.   <dd>
    493. 

  493.     
    494. 

  494.     
    495. 

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

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

  497. 

  498.   </dd>
    499. 

  499. </div>
    500. 

  500. 

  501. </div>
    502. 

  502. <div id="ansiForegroundColorCode-procs-all">
    503. 

  503.   <div id="ansiForegroundColorCode,Color">
    504. 

  504.   <dt><pre><span class="Keyword">proc</span> <a href="#ansiForegroundColorCode%2CColor"><span class="Identifier">ansiForegroundColorCode</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    505. 

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

  506.   <dd>
    507. 

  507.     
    508. 

  508.     
    509. 

  509.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L768" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    510. 

  510. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L768" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    511. 

  511. 

  512.   </dd>
    513. 

  513. </div>
    514. 

  514. <div id="ansiForegroundColorCode,ForegroundColor">
    515. 

  515.   <dt><pre><span class="Keyword">proc</span> <a href="#ansiForegroundColorCode%2CForegroundColor"><span class="Identifier">ansiForegroundColorCode</span></a><span class="Other">(</span><span class="Identifier">fg</span><span class="Other">:</span> <a href="terminal.html#ForegroundColor"><span class="Identifier">ForegroundColor</span></a><span class="Other">;</span> <span class="Identifier">bright</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> {.
    516. 

  516.     <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>
    517. 

  517.   <dd>
    518. 

  518.     
    519. 

  519.     
    520. 

  520.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L759" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    521. 

  521. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L759" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    522. 

  522. 

  523.   </dd>
    524. 

  524. </div>
    525. 

  525. 

  526. </div>
    527. 

  527. <div id="ansiStyleCode-procs-all">
    528. 

  528.   <div id="ansiStyleCode,int">
    529. 

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

  530.   <dd>
    531. 

  531.     
    532. 

  532.     
    533. 

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

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

  535. 

  536.   </dd>
    537. 

  537. </div>
    538. 

  538. 

  539. </div>
    540. 

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

  541.   <div id="cursorBackward,File,int">
    542. 

  542.   <dt><pre><span class="Keyword">proc</span> <a href="#cursorBackward%2CFile%2Cint"><span class="Identifier">cursorBackward</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    543. 

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

  544.   <dd>
    545. 

  545.     
    546. 

  546.     Moves the cursor backward by <tt class="docutils literal"><span class="pre"><span class="Identifier">count</span></span></tt> columns.
    547. 

  547. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    548. 

  548. <pre class="listing"><span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">cursorBackward</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    549. 

  549. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hello World!&quot;</span><span class="Punctuation">)</span> <span class="Comment"># anything written at that location will be erased/replaced with this</span></pre>
    550. 

  550.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L509" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    551. 

  551. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L509" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    552. 

  552. 

  553.   </dd>
    554. 

  554. </div>
    555. 

  555. 

  556. </div>
    557. 

  557. <div id="cursorDown-procs-all">
    558. 

  558.   <div id="cursorDown,File,int">
    559. 

  559.   <dt><pre><span class="Keyword">proc</span> <a href="#cursorDown%2CFile%2Cint"><span class="Identifier">cursorDown</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    560. 

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

  561.   <dd>
    562. 

  562.     
    563. 

  563.     Moves the cursor down by <tt class="docutils literal"><span class="pre"><span class="Identifier">count</span></span></tt> rows.
    564. 

  564. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    565. 

  565. <pre class="listing"><span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">cursorDown</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    566. 

  566. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hello World!&quot;</span><span class="Punctuation">)</span> <span class="Comment"># anything written at that location will be erased/replaced with this</span></pre>
    567. 

  567.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L483" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    568. 

  568. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L483" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    569. 

  569. 

  570.   </dd>
    571. 

  571. </div>
    572. 

  572. 

  573. </div>
    574. 

  574. <div id="cursorForward-procs-all">
    575. 

  575.   <div id="cursorForward,File,int">
    576. 

  576.   <dt><pre><span class="Keyword">proc</span> <a href="#cursorForward%2CFile%2Cint"><span class="Identifier">cursorForward</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    577. 

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

  578.   <dd>
    579. 

  579.     
    580. 

  580.     Moves the cursor forward by <tt class="docutils literal"><span class="pre"><span class="Identifier">count</span></span></tt> columns.
    581. 

  581. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    582. 

  582. <pre class="listing"><span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">cursorForward</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    583. 

  583. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hello World!&quot;</span><span class="Punctuation">)</span> <span class="Comment"># anything written at that location will be erased/replaced with this</span></pre>
    584. 

  584.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L496" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    585. 

  585. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L496" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    586. 

  586. 

  587.   </dd>
    588. 

  588. </div>
    589. 

  589. 

  590. </div>
    591. 

  591. <div id="cursorUp-procs-all">
    592. 

  592.   <div id="cursorUp,File,int">
    593. 

  593.   <dt><pre><span class="Keyword">proc</span> <a href="#cursorUp%2CFile%2Cint"><span class="Identifier">cursorUp</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    594. 

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

  595.   <dd>
    596. 

  596.     
    597. 

  597.     Moves the cursor up by <tt class="docutils literal"><span class="pre"><span class="Identifier">count</span></span></tt> rows.
    598. 

  598. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    599. 

  599. <pre class="listing"><span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">cursorUp</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    600. 

  600. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hello World!&quot;</span><span class="Punctuation">)</span> <span class="Comment"># anything written at that location will be erased/replaced with this</span></pre>
    601. 

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

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

  603. 

  604.   </dd>
    605. 

  605. </div>
    606. 

  606. 

  607. </div>
    608. 

  608. <div id="disableTrueColors-procs-all">
    609. 

  609.   <div id="disableTrueColors">
    610. 

  610.   <dt><pre><span class="Keyword">proc</span> <a href="#disableTrueColors"><span class="Identifier">disableTrueColors</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</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.     Disables true color.
    614. 

  614.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L1016" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    615. 

  615. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L1016" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    616. 

  616. 

  617.   </dd>
    618. 

  618. </div>
    619. 

  619. 

  620. </div>
    621. 

  621. <div id="enableTrueColors-procs-all">
    622. 

  622.   <div id="enableTrueColors">
    623. 

  623.   <dt><pre><span class="Keyword">proc</span> <a href="#enableTrueColors"><span class="Identifier">enableTrueColors</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    624. 

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

  625.   <dd>
    626. 

  626.     
    627. 

  627.     Enables true color.
    628. 

  628.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L983" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    629. 

  629. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L983" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    630. 

  630. 

  631.   </dd>
    632. 

  632. </div>
    633. 

  633. 

  634. </div>
    635. 

  635. <div id="eraseLine-procs-all">
    636. 

  636.   <div id="eraseLine,File">
    637. 

  637.   <dt><pre><span class="Keyword">proc</span> <a href="#eraseLine%2CFile"><span class="Identifier">eraseLine</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    638. 

  638.   <dd>
    639. 

  639.     
    640. 

  640.     Erases the entire current line.
    641. 

  641. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    642. 

  642. <pre class="listing"><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;never mind&quot;</span><span class="Punctuation">)</span>
    643. 

  643. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">eraseLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># nothing will be printed on the screen</span></pre>
    644. 

  644.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L553" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    645. 

  645. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L553" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    646. 

  646. 

  647.   </dd>
    648. 

  648. </div>
    649. 

  649. 

  650. </div>
    651. 

  651. <div id="eraseScreen-procs-all">
    652. 

  652.   <div id="eraseScreen,File">
    653. 

  653.   <dt><pre><span class="Keyword">proc</span> <a href="#eraseScreen%2CFile"><span class="Identifier">eraseScreen</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    654. 

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

  655.   <dd>
    656. 

  656.     
    657. 

  657.     Erases the screen with the background colour and moves the cursor to home.
    658. 

  658.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L579" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    659. 

  659. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L579" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    660. 

  660. 

  661.   </dd>
    662. 

  662. </div>
    663. 

  663. 

  664. </div>
    665. 

  665. <div id="getch-procs-all">
    666. 

  666.   <div id="getch">
    667. 

  667.   <dt><pre><span class="Keyword">proc</span> <a href="#getch"><span class="Identifier">getch</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">EOFError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    668. 

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

  669.   <dd>
    670. 

  670.     
    671. 

  671.     Reads a single character from the terminal, blocking until it is entered. The character is not printed to the terminal.
    672. 

  672.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L878" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    673. 

  673. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L878" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    674. 

  674. 

  675.   </dd>
    676. 

  676. </div>
    677. 

  677. 

  678. </div>
    679. 

  679. <div id="getCursorPos-procs-all">
    680. 

  680.   <div id="getCursorPos">
    681. 

  681.   <dt><pre><span class="Keyword">proc</span> <a href="#getCursorPos"><span class="Identifier">getCursorPos</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</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#ValueError"><span class="Identifier">ValueError</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>
    682. 

  682.                                         <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    683. 

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

  684.   <dd>
    685. 

  685.     
    686. 

  686.     Returns cursor position (x, y) writes to stdout and expects the terminal to respond via stdin
    687. 

  687.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    688. 

  688. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    689. 

  689. 

  690.   </dd>
    691. 

  691. </div>
    692. 

  692. 

  693. </div>
    694. 

  694. <div id="hideCursor-procs-all">
    695. 

  695.   <div id="hideCursor,File">
    696. 

  696.   <dt><pre><span class="Keyword">proc</span> <a href="#hideCursor%2CFile"><span class="Identifier">hideCursor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    697. 

  697.   <dd>
    698. 

  698.     
    699. 

  699.     Hides the cursor.
    700. 

  700.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L415" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    701. 

  701. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L415" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    702. 

  702. 

  703.   </dd>
    704. 

  704. </div>
    705. 

  705. 

  706. </div>
    707. 

  707. <div id="isatty-procs-all">
    708. 

  708.   <div id="isatty,File">
    709. 

  709.   <dt><pre><span class="Keyword">proc</span> <a href="#isatty%2CFile"><span class="Identifier">isatty</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span><span class="Other">:</span> <a href="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>
    710. 

  710.   <dd>
    711. 

  711.     
    712. 

  712.     Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> is associated with a terminal device.
    713. 

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

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

  715. 

  716.   </dd>
    717. 

  717. </div>
    718. 

  718. 

  719. </div>
    720. 

  720. <div id="isTrueColorSupported-procs-all">
    721. 

  721.   <div id="isTrueColorSupported">
    722. 

  722.   <dt><pre><span class="Keyword">proc</span> <a href="#isTrueColorSupported"><span class="Identifier">isTrueColorSupported</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</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>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     Returns true if a terminal supports true color.
    726. 

  726.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L976" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    727. 

  727. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L976" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    728. 

  728. 

  729.   </dd>
    730. 

  730. </div>
    731. 

  731. 

  732. </div>
    733. 

  733. <div id="readPasswordFromStdin-procs-all">
    734. 

  734.   <div id="readPasswordFromStdin,string">
    735. 

  735.   <dt><pre><span class="Keyword">proc</span> <a href="#readPasswordFromStdin%2Cstring"><span class="Identifier">readPasswordFromStdin</span></a><span class="Other">(</span><span class="Identifier">prompt</span> <span class="Other">=</span> <span class="StringLit">&quot;password: &quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    736. 

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

  737.   <dd>
    738. 

  738.     
    739. 

  739.     Reads a password from stdin without printing it.
    740. 

  740.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L941" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    741. 

  741. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L941" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    742. 

  742. 

  743.   </dd>
    744. 

  744. </div>
    745. 

  745. <div id="readPasswordFromStdin,string,string">
    746. 

  746.   <dt><pre><span class="Keyword">proc</span> <a href="#readPasswordFromStdin%2Cstring%2Cstring"><span class="Identifier">readPasswordFromStdin</span></a><span class="Other">(</span><span class="Identifier">prompt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">password</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    747. 

  747.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</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>
    748. 

  748.   <dd>
    749. 

  749.     
    750. 

  750.     
    751. 

  751.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L927" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    752. 

  752. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L927" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    753. 

  753. 

  754.   </dd>
    755. 

  755. </div>
    756. 

  756. 

  757. </div>
    758. 

  758. <div id="resetAttributes-procs-all">
    759. 

  759.   <div id="resetAttributes">
    760. 

  760.   <dt><pre><span class="Keyword">proc</span> <a href="#resetAttributes"><span class="Identifier">resetAttributes</span></a><span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    761. 

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

  762.   <dd>
    763. 

  763.     
    764. 

  764.     Resets all attributes on stdout. It is advisable to register this as a quit proc with <tt class="docutils literal"><span class="pre"><span class="Identifier">exitprocs</span><span class="Operator">.</span><span class="Identifier">addExitProc</span><span class="Punctuation">(</span><span class="Identifier">resetAttributes</span><span class="Punctuation">)</span></span></tt>.
    765. 

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

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

  767. 

  768.   </dd>
    769. 

  769. </div>
    770. 

  770. <div id="resetAttributes,File">
    771. 

  771.   <dt><pre><span class="Keyword">proc</span> <a href="#resetAttributes%2CFile"><span class="Identifier">resetAttributes</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    772. 

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

  773.   <dd>
    774. 

  774.     
    775. 

  775.     Resets all attributes.
    776. 

  776.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L606" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    777. 

  777. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L606" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    778. 

  778. 

  779.   </dd>
    780. 

  780. </div>
    781. 

  781. 

  782. </div>
    783. 

  783. <div id="setBackgroundColor-procs-all">
    784. 

  784.   <div id="setBackgroundColor,File,BackgroundColor">
    785. 

  785.   <dt><pre><span class="Keyword">proc</span> <a href="#setBackgroundColor%2CFile%2CBackgroundColor"><span class="Identifier">setBackgroundColor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">bg</span><span class="Other">:</span> <a href="terminal.html#BackgroundColor"><span class="Identifier">BackgroundColor</span></a><span class="Other">;</span> <span class="Identifier">bright</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.
    786. 

  786.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    787. 

  787.   <dd>
    788. 

  788.     
    789. 

  789.     Sets the terminal's background color.
    790. 

  790.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L730" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    791. 

  791. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L730" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    792. 

  792. 

  793.   </dd>
    794. 

  794. </div>
    795. 

  795. <div id="setBackgroundColor,File,Color">
    796. 

  796.   <dt><pre><span class="Keyword">proc</span> <a href="#setBackgroundColor%2CFile%2CColor"><span class="Identifier">setBackgroundColor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    797. 

  797.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    798. 

  798.   <dd>
    799. 

  799.     
    800. 

  800.     Sets the terminal's background true color.
    801. 

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

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

  803. 

  804.   </dd>
    805. 

  805. </div>
    806. 

  806. 

  807. </div>
    808. 

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

  809.   <div id="setCursorPos,File,int,int">
    810. 

  810.   <dt><pre><span class="Keyword">proc</span> <a href="#setCursorPos%2CFile%2Cint%2Cint"><span class="Identifier">setCursorPos</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</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><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    811. 

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

  812.   <dd>
    813. 

  813.     
    814. 

  814.     Sets the terminal's cursor to the (x,y) position. (0,0) is the upper left of the screen.
    815. 

  815.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L429" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    816. 

  816. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L429" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    817. 

  817. 

  818.   </dd>
    819. 

  819. </div>
    820. 

  820. 

  821. </div>
    822. 

  822. <div id="setCursorXPos-procs-all">
    823. 

  823.   <div id="setCursorXPos,File,int">
    824. 

  824.   <dt><pre><span class="Keyword">proc</span> <a href="#setCursorXPos%2CFile%2Cint"><span class="Identifier">setCursorXPos</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">x</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><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    825. 

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

  826.   <dd>
    827. 

  827.     
    828. 

  828.     Sets the terminal's cursor to the x position. The y position is not changed.
    829. 

  829.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L438" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    830. 

  830. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L438" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    831. 

  831. 

  832.   </dd>
    833. 

  833. </div>
    834. 

  834. 

  835. </div>
    836. 

  836. <div id="setForegroundColor-procs-all">
    837. 

  837.   <div id="setForegroundColor,File,Color">
    838. 

  838.   <dt><pre><span class="Keyword">proc</span> <a href="#setForegroundColor%2CFile%2CColor"><span class="Identifier">setForegroundColor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    839. 

  839.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    840. 

  840.   <dd>
    841. 

  841.     
    842. 

  842.     Sets the terminal's foreground true color.
    843. 

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

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

  845. 

  846.   </dd>
    847. 

  847. </div>
    848. 

  848. <div id="setForegroundColor,File,ForegroundColor">
    849. 

  849.   <dt><pre><span class="Keyword">proc</span> <a href="#setForegroundColor%2CFile%2CForegroundColor"><span class="Identifier">setForegroundColor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="terminal.html#ForegroundColor"><span class="Identifier">ForegroundColor</span></a><span class="Other">;</span> <span class="Identifier">bright</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.
    850. 

  850.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    851. 

  851.   <dd>
    852. 

  852.     
    853. 

  853.     Sets the terminal's foreground color.
    854. 

  854.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L701" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    855. 

  855. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L701" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    856. 

  856. 

  857.   </dd>
    858. 

  858. </div>
    859. 

  859. 

  860. </div>
    861. 

  861. <div id="setStyle-procs-all">
    862. 

  862.   <div id="setStyle,File,set[Style]">
    863. 

  863.   <dt><pre><span class="Keyword">proc</span> <a href="#setStyle%2CFile%2Cset%5BStyle%5D"><span class="Identifier">setStyle</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">style</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="terminal.html#Style"><span class="Identifier">Style</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    864. 

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

  865.   <dd>
    866. 

  866.     
    867. 

  867.     Sets the terminal style.
    868. 

  868.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L641" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    869. 

  869. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L641" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    870. 

  870. 

  871.   </dd>
    872. 

  872. </div>
    873. 

  873. 

  874. </div>
    875. 

  875. <div id="showCursor-procs-all">
    876. 

  876.   <div id="showCursor,File">
    877. 

  877.   <dt><pre><span class="Keyword">proc</span> <a href="#showCursor%2CFile"><span class="Identifier">showCursor</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    878. 

  878.   <dd>
    879. 

  879.     
    880. 

  880.     Shows the cursor.
    881. 

  881.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L422" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    882. 

  882. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L422" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    883. 

  883. 

  884.   </dd>
    885. 

  885. </div>
    886. 

  886. 

  887. </div>
    888. 

  888. <div id="terminalHeight-procs-all">
    889. 

  889.   <div id="terminalHeight">
    890. 

  890.   <dt><pre><span class="Keyword">proc</span> <a href="#terminalHeight"><span class="Identifier">terminalHeight</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</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>
    891. 

  891.   <dd>
    892. 

  892.     
    893. 

  893.     Returns some reasonable terminal height from either standard file descriptors, controlling terminal, environment variables or tradition. Zero is returned if the height could not be determined.
    894. 

  894.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L366" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    895. 

  895. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L366" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    896. 

  896. 

  897.   </dd>
    898. 

  898. </div>
    899. 

  899. 

  900. </div>
    901. 

  901. <div id="terminalHeightIoctl-procs-all">
    902. 

  902.   <div id="terminalHeightIoctl,openArray[int]">
    903. 

  903.   <dt><pre><span class="Keyword">proc</span> <a href="#terminalHeightIoctl%2CopenArray%5Bint%5D"><span class="Identifier">terminalHeightIoctl</span></a><span class="Other">(</span><span class="Identifier">fds</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><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="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    904. 

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

  905.   <dd>
    906. 

  906.     
    907. 

  907.     Returns terminal height from first fd that supports the ioctl.
    908. 

  908.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L325" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    909. 

  909. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L325" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    910. 

  910. 

  911.   </dd>
    912. 

  912. </div>
    913. 

  913. 

  914. </div>
    915. 

  915. <div id="terminalSize-procs-all">
    916. 

  916.   <div id="terminalSize">
    917. 

  917.   <dt><pre><span class="Keyword">proc</span> <a href="#terminalSize"><span class="Identifier">terminalSize</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">w</span><span class="Other">,</span> <span class="Identifier">h</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><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    918. 

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

  919.   <dd>
    920. 

  920.     
    921. 

  921.     Returns the terminal width and height as a tuple. Internally calls <tt class="docutils literal"><span class="pre"><span class="Identifier">terminalWidth</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">terminalHeight</span></span></tt>, so the same assumptions apply.
    922. 

  922.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L400" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    923. 

  923. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L400" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    924. 

  924. 

  925.   </dd>
    926. 

  926. </div>
    927. 

  927. 

  928. </div>
    929. 

  929. <div id="terminalWidth-procs-all">
    930. 

  930.   <div id="terminalWidth">
    931. 

  931.   <dt><pre><span class="Keyword">proc</span> <a href="#terminalWidth"><span class="Identifier">terminalWidth</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</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>
    932. 

  932.   <dd>
    933. 

  933.     
    934. 

  934.     Returns some reasonable terminal width from either standard file descriptors, controlling terminal, environment variables or tradition.
    935. 

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

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

  937. 

  938.   </dd>
    939. 

  939. </div>
    940. 

  940. 

  941. </div>
    942. 

  942. <div id="terminalWidthIoctl-procs-all">
    943. 

  943.   <div id="terminalWidthIoctl,openArray[int]">
    944. 

  944.   <dt><pre><span class="Keyword">proc</span> <a href="#terminalWidthIoctl%2CopenArray%5Bint%5D"><span class="Identifier">terminalWidthIoctl</span></a><span class="Other">(</span><span class="Identifier">fds</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><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="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    945. 

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

  946.   <dd>
    947. 

  947.     
    948. 

  948.     Returns terminal width from first fd that supports the ioctl.
    949. 

  949.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L316" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    950. 

  950. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L316" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    951. 

  951. 

  952.   </dd>
    953. 

  953. </div>
    954. 

  954. 

  955. </div>
    956. 

  956. <div id="writeStyled-procs-all">
    957. 

  957.   <div id="writeStyled,string,set[Style]">
    958. 

  958.   <dt><pre><span class="Keyword">proc</span> <a href="#writeStyled%2Cstring%2Cset%5BStyle%5D"><span class="Identifier">writeStyled</span></a><span class="Other">(</span><span class="Identifier">txt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">style</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="terminal.html#Style"><span class="Identifier">Style</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">styleBright</span><span class="Other">}</span><span class="Other">)</span> {.
    959. 

  959.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    960. 

  960.   <dd>
    961. 

  961.     
    962. 

  962.     Writes the text <tt class="docutils literal"><span class="pre"><span class="Identifier">txt</span></span></tt> in a given <tt class="docutils literal"><span class="pre"><span class="Identifier">style</span></span></tt> to stdout.
    963. 

  963.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L656" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    964. 

  964. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L656" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    965. 

  965. 

  966.   </dd>
    967. 

  967. </div>
    968. 

  968. 

  969. </div>
    970. 

  970. 

  971.   </dl>
    972. 

  972. </div>
    973. 

  973. <div class="section" id="17">
    974. 

  974.   <h1><a class="toc-backref" href="#17">Macros</a></h1>
    975. 

  975.   <dl class="item">
    976. 

  976.     <div id="styledWrite-macros-all">
    977. 

  977.   <div id="styledWrite.m,File,varargs[typed]">
    978. 

  978.   <dt><pre><span class="Keyword">macro</span> <a href="#styledWrite.m%2CFile%2Cvarargs%5Btyped%5D"><span class="Identifier">styledWrite</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">m</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    979. 

  979.   <dd>
    980. 

  980.     
    981. 

  981.     Similar to <tt class="docutils literal"><span class="pre"><span class="Identifier">write</span></span></tt>, but treating terminal style arguments specially. When some argument is <tt class="docutils literal"><span class="pre"><span class="Identifier">Style</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">set</span><span class="Punctuation">[</span><span class="Identifier">Style</span><span class="Punctuation">]</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">ForegroundColor</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">BackgroundColor</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">TerminalCmd</span></span></tt> then it is not sent directly to <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>, but instead corresponding terminal style proc is called.
    982. 

  982. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    983. 

  983. <pre class="listing"><span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWrite</span><span class="Punctuation">(</span><span class="Identifier">fgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;red text &quot;</span><span class="Punctuation">)</span>
    984. 

  984. <span class="Identifier">stdout</span><span class="Operator">.</span><span class="Identifier">styledWrite</span><span class="Punctuation">(</span><span class="Identifier">fgGreen</span><span class="Punctuation">,</span> <span class="StringLit">&quot;green text&quot;</span><span class="Punctuation">)</span></pre>
    985. 

  985.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L836" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    986. 

  986. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L836" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    987. 

  987. 

  988.   </dd>
    989. 

  989. </div>
    990. 

  990. 

  991. </div>
    992. 

  992. 

  993.   </dl>
    994. 

  994. </div>
    995. 

  995. <div class="section" id="18">
    996. 

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

  997.   <dl class="item">
    998. 

  998.     <div id="ansiBackgroundColorCode-templates-all">
    999. 

  999.   <div id="ansiBackgroundColorCode.t,static[Color]">
    1000. 

  1000.   <dt><pre><span class="Keyword">template</span> <a href="#ansiBackgroundColorCode.t%2Cstatic%5BColor%5D"><span class="Identifier">ansiBackgroundColorCode</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1001. 

  1001.   <dd>
    1002. 

  1002.     
    1003. 

  1003.     
    1004. 

  1004.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L781" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1005. 

  1005. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L781" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1006. 

  1006. 

  1007.   </dd>
    1008. 

  1008. </div>
    1009. 

  1009. 

  1010. </div>
    1011. 

  1011. <div id="ansiForegroundColorCode-templates-all">
    1012. 

  1012.   <div id="ansiForegroundColorCode.t,static[Color]">
    1013. 

  1013.   <dt><pre><span class="Keyword">template</span> <a href="#ansiForegroundColorCode.t%2Cstatic%5BColor%5D"><span class="Identifier">ansiForegroundColorCode</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1014. 

  1014.   <dd>
    1015. 

  1015.     
    1016. 

  1016.     
    1017. 

  1017.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L772" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1018. 

  1018. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L772" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1019. 

  1019. 

  1020.   </dd>
    1021. 

  1021. </div>
    1022. 

  1022. <div id="ansiForegroundColorCode.t,static[ForegroundColor],static[bool]">
    1023. 

  1023.   <dt><pre><span class="Keyword">template</span> <a href="#ansiForegroundColorCode.t%2Cstatic%5BForegroundColor%5D%2Cstatic%5Bbool%5D"><span class="Identifier">ansiForegroundColorCode</span></a><span class="Other">(</span><span class="Identifier">fg</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><a href="terminal.html#ForegroundColor"><span class="Identifier">ForegroundColor</span></a><span class="Other">]</span><span class="Other">;</span>
    1024. 

  1024.                                  <span class="Identifier">bright</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">]</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></pre></dt>
    1025. 

  1025.   <dd>
    1026. 

  1026.     
    1027. 

  1027.     
    1028. 

  1028.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L764" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1029. 

  1029. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L764" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1030. 

  1030. 

  1031.   </dd>
    1032. 

  1032. </div>
    1033. 

  1033. 

  1034. </div>
    1035. 

  1035. <div id="ansiStyleCode-templates-all">
    1036. 

  1036.   <div id="ansiStyleCode.t,static[Style]">
    1037. 

  1037.   <dt><pre><span class="Keyword">template</span> <a href="#ansiStyleCode.t%2Cstatic%5BStyle%5D"><span class="Identifier">ansiStyleCode</span></a><span class="Other">(</span><span class="Identifier">style</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><a href="terminal.html#Style"><span class="Identifier">Style</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1038. 

  1038.   <dd>
    1039. 

  1039.     
    1040. 

  1040.     
    1041. 

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

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

  1043. 

  1044.   </dd>
    1045. 

  1045. </div>
    1046. 

  1046. <div id="ansiStyleCode.t,Style">
    1047. 

  1047.   <dt><pre><span class="Keyword">template</span> <a href="#ansiStyleCode.t%2CStyle"><span class="Identifier">ansiStyleCode</span></a><span class="Other">(</span><span class="Identifier">style</span><span class="Other">:</span> <a href="terminal.html#Style"><span class="Identifier">Style</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1048. 

  1048.   <dd>
    1049. 

  1049.     
    1050. 

  1050.     
    1051. 

  1051.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L634" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1052. 

  1052. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L634" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1053. 

  1053. 

  1054.   </dd>
    1055. 

  1055. </div>
    1056. 

  1056. 

  1057. </div>
    1058. 

  1058. <div id="cursorBackward-templates-all">
    1059. 

  1059.   <div id="cursorBackward.t,int">
    1060. 

  1060.   <dt><pre><span class="Keyword">template</span> <a href="#cursorBackward.t%2Cint"><span class="Identifier">cursorBackward</span></a><span class="Other">(</span><span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span></pre></dt>
    1061. 

  1061.   <dd>
    1062. 

  1062.     
    1063. 

  1063.     
    1064. 

  1064.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L957" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1065. 

  1065. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L957" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1066. 

  1066. 

  1067.   </dd>
    1068. 

  1068. </div>
    1069. 

  1069. 

  1070. </div>
    1071. 

  1071. <div id="cursorDown-templates-all">
    1072. 

  1072.   <div id="cursorDown.t,int">
    1073. 

  1073.   <dt><pre><span class="Keyword">template</span> <a href="#cursorDown.t%2Cint"><span class="Identifier">cursorDown</span></a><span class="Other">(</span><span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span></pre></dt>
    1074. 

  1074.   <dd>
    1075. 

  1075.     
    1076. 

  1076.     
    1077. 

  1077.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L955" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1078. 

  1078. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L955" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1079. 

  1079. 

  1080.   </dd>
    1081. 

  1081. </div>
    1082. 

  1082. 

  1083. </div>
    1084. 

  1084. <div id="cursorForward-templates-all">
    1085. 

  1085.   <div id="cursorForward.t,int">
    1086. 

  1086.   <dt><pre><span class="Keyword">template</span> <a href="#cursorForward.t%2Cint"><span class="Identifier">cursorForward</span></a><span class="Other">(</span><span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span></pre></dt>
    1087. 

  1087.   <dd>
    1088. 

  1088.     
    1089. 

  1089.     
    1090. 

  1090.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L956" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1091. 

  1091. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L956" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1092. 

  1092. 

  1093.   </dd>
    1094. 

  1094. </div>
    1095. 

  1095. 

  1096. </div>
    1097. 

  1097. <div id="cursorUp-templates-all">
    1098. 

  1098.   <div id="cursorUp.t,int">
    1099. 

  1099.   <dt><pre><span class="Keyword">template</span> <a href="#cursorUp.t%2Cint"><span class="Identifier">cursorUp</span></a><span class="Other">(</span><span class="Identifier">count</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span></pre></dt>
    1100. 

  1100.   <dd>
    1101. 

  1101.     
    1102. 

  1102.     
    1103. 

  1103.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L954" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1104. 

  1104. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L954" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1105. 

  1105. 

  1106.   </dd>
    1107. 

  1107. </div>
    1108. 

  1108. 

  1109. </div>
    1110. 

  1110. <div id="eraseLine-templates-all">
    1111. 

  1111.   <div id="eraseLine.t">
    1112. 

  1112.   <dt><pre><span class="Keyword">template</span> <a href="#eraseLine.t"><span class="Identifier">eraseLine</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    1113. 

  1113.   <dd>
    1114. 

  1114.     
    1115. 

  1115.     
    1116. 

  1116.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L958" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1117. 

  1117. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L958" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1118. 

  1118. 

  1119.   </dd>
    1120. 

  1120. </div>
    1121. 

  1121. 

  1122. </div>
    1123. 

  1123. <div id="eraseScreen-templates-all">
    1124. 

  1124.   <div id="eraseScreen.t">
    1125. 

  1125.   <dt><pre><span class="Keyword">template</span> <a href="#eraseScreen.t"><span class="Identifier">eraseScreen</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    1126. 

  1126.   <dd>
    1127. 

  1127.     
    1128. 

  1128.     
    1129. 

  1129.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L959" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1130. 

  1130. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L959" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1131. 

  1131. 

  1132.   </dd>
    1133. 

  1133. </div>
    1134. 

  1134. 

  1135. </div>
    1136. 

  1136. <div id="hideCursor-templates-all">
    1137. 

  1137.   <div id="hideCursor.t">
    1138. 

  1138.   <dt><pre><span class="Keyword">template</span> <a href="#hideCursor.t"><span class="Identifier">hideCursor</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    1139. 

  1139.   <dd>
    1140. 

  1140.     
    1141. 

  1141.     
    1142. 

  1142.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L948" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1143. 

  1143. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L948" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1144. 

  1144. 

  1145.   </dd>
    1146. 

  1146. </div>
    1147. 

  1147. 

  1148. </div>
    1149. 

  1149. <div id="setBackgroundColor-templates-all">
    1150. 

  1150.   <div id="setBackgroundColor.t,BackgroundColor">
    1151. 

  1151.   <dt><pre><span class="Keyword">template</span> <a href="#setBackgroundColor.t%2CBackgroundColor"><span class="Identifier">setBackgroundColor</span></a><span class="Other">(</span><span class="Identifier">bg</span><span class="Other">:</span> <a href="terminal.html#BackgroundColor"><span class="Identifier">BackgroundColor</span></a><span class="Other">;</span> <span class="Identifier">bright</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span></pre></dt>
    1152. 

  1152.   <dd>
    1153. 

  1153.     
    1154. 

  1154.     
    1155. 

  1155.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L964" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1156. 

  1156. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L964" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1157. 

  1157. 

  1158.   </dd>
    1159. 

  1159. </div>
    1160. 

  1160. <div id="setBackgroundColor.t,Color">
    1161. 

  1161.   <dt><pre><span class="Keyword">template</span> <a href="#setBackgroundColor.t%2CColor"><span class="Identifier">setBackgroundColor</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span></pre></dt>
    1162. 

  1162.   <dd>
    1163. 

  1163.     
    1164. 

  1164.     
    1165. 

  1165.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L968" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1166. 

  1166. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L968" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1167. 

  1167. 

  1168.   </dd>
    1169. 

  1169. </div>
    1170. 

  1170. 

  1171. </div>
    1172. 

  1172. <div id="setCursorPos-templates-all">
    1173. 

  1173.   <div id="setCursorPos.t,int,int">
    1174. 

  1174.   <dt><pre><span class="Keyword">template</span> <a href="#setCursorPos.t%2Cint%2Cint"><span class="Identifier">setCursorPos</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span></pre></dt>
    1175. 

  1175.   <dd>
    1176. 

  1176.     
    1177. 

  1177.     
    1178. 

  1178.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L950" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1179. 

  1179. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L950" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1180. 

  1180. 

  1181.   </dd>
    1182. 

  1182. </div>
    1183. 

  1183. 

  1184. </div>
    1185. 

  1185. <div id="setCursorXPos-templates-all">
    1186. 

  1186.   <div id="setCursorXPos.t,int">
    1187. 

  1187.   <dt><pre><span class="Keyword">template</span> <a href="#setCursorXPos.t%2Cint"><span class="Identifier">setCursorXPos</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span></pre></dt>
    1188. 

  1188.   <dd>
    1189. 

  1189.     
    1190. 

  1190.     
    1191. 

  1191.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L951" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1192. 

  1192. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L951" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1193. 

  1193. 

  1194.   </dd>
    1195. 

  1195. </div>
    1196. 

  1196. 

  1197. </div>
    1198. 

  1198. <div id="setForegroundColor-templates-all">
    1199. 

  1199.   <div id="setForegroundColor.t,Color">
    1200. 

  1200.   <dt><pre><span class="Keyword">template</span> <a href="#setForegroundColor.t%2CColor"><span class="Identifier">setForegroundColor</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="colors.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span></pre></dt>
    1201. 

  1201.   <dd>
    1202. 

  1202.     
    1203. 

  1203.     
    1204. 

  1204.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L966" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1205. 

  1205. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L966" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1206. 

  1206. 

  1207.   </dd>
    1208. 

  1208. </div>
    1209. 

  1209. <div id="setForegroundColor.t,ForegroundColor">
    1210. 

  1210.   <dt><pre><span class="Keyword">template</span> <a href="#setForegroundColor.t%2CForegroundColor"><span class="Identifier">setForegroundColor</span></a><span class="Other">(</span><span class="Identifier">fg</span><span class="Other">:</span> <a href="terminal.html#ForegroundColor"><span class="Identifier">ForegroundColor</span></a><span class="Other">;</span> <span class="Identifier">bright</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span></pre></dt>
    1211. 

  1211.   <dd>
    1212. 

  1212.     
    1213. 

  1213.     
    1214. 

  1214.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L962" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1215. 

  1215. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L962" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1216. 

  1216. 

  1217.   </dd>
    1218. 

  1218. </div>
    1219. 

  1219. 

  1220. </div>
    1221. 

  1221. <div id="setStyle-templates-all">
    1222. 

  1222.   <div id="setStyle.t,set[Style]">
    1223. 

  1223.   <dt><pre><span class="Keyword">template</span> <a href="#setStyle.t%2Cset%5BStyle%5D"><span class="Identifier">setStyle</span></a><span class="Other">(</span><span class="Identifier">style</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="terminal.html#Style"><span class="Identifier">Style</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
    1224. 

  1224.   <dd>
    1225. 

  1225.     
    1226. 

  1226.     
    1227. 

  1227.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L960" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1228. 

  1228. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L960" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1229. 

  1229. 

  1230.   </dd>
    1231. 

  1231. </div>
    1232. 

  1232. 

  1233. </div>
    1234. 

  1234. <div id="showCursor-templates-all">
    1235. 

  1235.   <div id="showCursor.t">
    1236. 

  1236.   <dt><pre><span class="Keyword">template</span> <a href="#showCursor.t"><span class="Identifier">showCursor</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    1237. 

  1237.   <dd>
    1238. 

  1238.     
    1239. 

  1239.     
    1240. 

  1240.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L949" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1241. 

  1241. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L949" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1242. 

  1242. 

  1243.   </dd>
    1244. 

  1244. </div>
    1245. 

  1245. 

  1246. </div>
    1247. 

  1247. <div id="styledEcho-templates-all">
    1248. 

  1248.   <div id="styledEcho.t,varargs[untyped]">
    1249. 

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

  1250.   <dd>
    1251. 

  1251.     
    1252. 

  1252.     Echoes styles arguments to stdout using <tt class="docutils literal"><span class="pre"><span class="Identifier">styledWriteLine</span></span></tt>.
    1253. 

  1253.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L874" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1254. 

  1254. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L874" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1255. 

  1255. 

  1256.   </dd>
    1257. 

  1257. </div>
    1258. 

  1258. 

  1259. </div>
    1260. 

  1260. <div id="styledWriteLine-templates-all">
    1261. 

  1261.   <div id="styledWriteLine.t,File,varargs[untyped]">
    1262. 

  1262.   <dt><pre><span class="Keyword">template</span> <a href="#styledWriteLine.t%2CFile%2Cvarargs%5Buntyped%5D"><span class="Identifier">styledWriteLine</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
    1263. 

  1263.   <dd>
    1264. 

  1264.     
    1265. 

  1265.     Calls <tt class="docutils literal"><span class="pre"><span class="Identifier">styledWrite</span></span></tt> and appends a newline at the end.
    1266. 

  1266. <p><strong class="examples_text">Example:</strong></p>
    1267. 

  1267. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">error</span><span class="Punctuation">(</span><span class="Identifier">msg</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    1268. 

  1268.   <span class="Identifier">styledWriteLine</span><span class="Punctuation">(</span><span class="Identifier">stderr</span><span class="Punctuation">,</span> <span class="Identifier">fgRed</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Error: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">resetStyle</span><span class="Punctuation">,</span> <span class="Identifier">msg</span><span class="Punctuation">)</span></pre>
    1269. 

  1269.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/terminal.nim#L865" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1270. 

  1270. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/terminal.nim#L865" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1271. 

  1271. 

  1272.   </dd>
    1273. 

  1273. </div>
    1274. 

  1274. 

  1275. </div>
    1276. 

  1276. 

  1277.   </dl>
    1278. 

  1278. </div>
    1279. 

  1279. 

  1280.   </div>
    1281. 

  1281. </div>
    1282. 

  1282. 

  1283.       <div class="twelve-columns footer">
    1284. 

  1284.         <span class="nim-sprite"></span>
    1285. 

  1285.         <br>
    1286. 

  1286.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:02 UTC</small>
    1287. 

  1287.       </div>
    1288. 

  1288.     </div>
    1289. 

  1289.   </div>
    1290. 

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

  1291.     
    1292. 

  1292. </body>
    1293. 

  1293. </html>
    1294. 

  1294.