diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.html | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/manual.html b/doc/manual.html index 4834d9f..e6e2240 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -3601,21 +3601,21 @@ idiomatic Teliva uses some slightly different primitives. <p> This function opens a file exclusively for reading, and returns a -<tt>channel</tt> (NOT a file as in Lua) or <b>nil</b> on error. -<tt>recv()</tt> from the channel to read a line at a time from the file. +<code>channel</code> (NOT a file as in Lua) or <b>nil</b> on error. +<code>recv()</code> from the channel to read a line at a time from the file. <p> -(The <tt>fs</tt> parameter is currently unused. It will be used to pass in +(The <code>fs</code> parameter is currently unused. It will be used to pass in fake file systems for tests.) <p> <hr><h3><a name="pdf-character_by_character"><code>character_by_character(chanin, chanout)</code></a></h3> <p> -This function converts a channel that can <tt>recv()</tt> a line at a time -from a file into a channel that can <tt>recv()</tt> a character at a time. +This function converts a channel that can <code>recv()</code> a line at a time +from a file into a channel that can <code>recv()</code> a character at a time. Don't try to mix by-line reads with by-character reads. Once a channel is -passed into <tt>character_by_character</tt>, calling code should stop trying +passed into <code>character_by_character</code>, calling code should stop trying to use it. @@ -3624,13 +3624,13 @@ to use it. <p> This function opens a file exclusively for writing, and returns a -<tt>channel</tt> (NOT a file as in Lua) or <b>nil</b> on error. -<tt>send()</tt> to the channel will write to the file. <tt>close()</tt> on the +<code>channel</code> (NOT a file as in Lua) or <b>nil</b> on error. +<code>send()</code> to the channel will write to the file. <code>close()</code> on the channel will persist the changes and make them externally visible. All writes -are hidden until <tt>close()</tt>. +are hidden until <code>close()</code>. <p> -(The <tt>fs</tt> parameter is currently unused. It will be used to pass in +(The <code>fs</code> parameter is currently unused. It will be used to pass in fake file systems for tests.) @@ -4391,8 +4391,8 @@ to start the traceback <h2>5.10 - <a name="5.10">Curses Window Facilities</a></h2> Teliva includes curses facilities identical to Lua's <a href='http://lcurses.github.io/lcurses/'>lcurses</a> -library. As there, the top-level module is called <tt>curses</tt>. All apps -start with the terminal window initialized using <tt>curses.initscr()</tt>. +library. As there, the top-level module is called <code>curses</code>. All apps +start with the terminal window initialized using <code>curses.initscr()</code>. Look at the sample apps for example usage. </div> @@ -4403,11 +4403,11 @@ Look at the sample apps for example usage. Teliva includes the following well-known Lua libraries for networking: <li><a href='https://w3.impa.br/~diego/software/luasocket/reference.html'>LuaSocket</a>, -consisting of modules <tt>socket</tt>, <tt>http</tt>, <tt>url</tt>, -<tt>headers</tt>, <tt>mime</tt> and <tt>ltn12</tt>. +consisting of modules <code>socket</code>, <code>http</code>, <code>url</code>, +<code>headers</code>, <code>mime</code> and <code>ltn12</code>. <li><a href='https://github.com/brunoos/luasec/wiki'>LuaSec</a>, -consisting of modules <tt>https</tt> and <tt>ssl</tt>. +consisting of modules <code>https</code> and <code>ssl</code>. </div> @@ -4416,7 +4416,7 @@ consisting of modules <tt>https</tt> and <tt>ssl</tt>. Teliva includes the well-known <a href='https://github.com/rxi/json.lua'>json.lua</a> library (module -<tt>json</tt>). It also includes a variant in module <tt>jsonf</tt> that can +<code>json</code>). It also includes a variant in module <code>jsonf</code> that can read or write JSON from channels opened by <a href='#pdf-start_reading'>start_reading</a> and @@ -4429,8 +4429,8 @@ and Teliva includes the well-known <a href='https://github.com/majek/lua-channels#readme'>lua-channels</a> -library in module <tt>task</tt>. It also transparently starts up -<tt>task.scheduler</tt> for all apps. +library in module <code>task</code>. It also transparently starts up +<code>task.scheduler</code> for all apps. </div> |