autodoc.git/ traditional_manual/ chapter_9.html

Branch: Tag:

2003-04-07

2003-04-07 17:28:56 by Martin Nilsson <mani@lysator.liu.se>

Use @expr where more approrpiate than @tt

Rev: lib/modules/ADT.pmod/Table.pmod:1.26
Rev: lib/modules/Crypto.pmod/aes.pike:1.2
Rev: lib/modules/Getopt.pmod:1.27
Rev: lib/modules/Parser.pmod/module.pmod:1.18
Rev: lib/modules/Protocols.pmod/DNS.pmod:1.72
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Query.pike:1.56
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Session.pike:1.11
Rev: lib/modules/Protocols.pmod/HTTP.pmod/module.pmod:1.37
Rev: lib/modules/Protocols.pmod/LDAP.pmod/client.pike:1.48
Rev: lib/modules/Protocols.pmod/Line.pmod:1.22
Rev: lib/modules/Protocols.pmod/SMTP.pmod:1.22
Rev: lib/modules/Sql.pmod/Sql.pike:1.64
Rev: lib/modules/Stdio.pmod/module.pmod:1.169
Rev: lib/modules/String.pmod/module.pmod:1.14
Rev: lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod:1.54
Rev: src/builtin.cmod:1.131
Rev: src/builtin_functions.c:1.483
Rev: src/cpp.c:1.117
Rev: src/dynamic_load.c:1.69
Rev: src/error.c:1.106
Rev: src/modules/DVB/dvb.c:1.19
Rev: src/modules/Gdbm/gdbmmod.c:1.24
Rev: src/modules/Gettext/gettext.c:1.15
Rev: src/modules/Gmp/mpf.cmod:1.25
Rev: src/modules/MIME/mime.c:1.37
Rev: src/modules/Mird/module.pmod.in:1.12
Rev: src/modules/Msql/msqlmod.c:1.25
Rev: src/modules/Mysql/mysql.c:1.71
Rev: src/modules/Mysql/result.c:1.29
Rev: src/modules/Yp/module.pmod.in:1.19
Rev: src/modules/_Charset/module.pmod.in:1.31
Rev: src/modules/_Crypto/arcfour.c:1.21
Rev: src/modules/_Crypto/cast.c:1.16
Rev: src/modules/_Crypto/des.c:1.28
Rev: src/modules/_Crypto/idea.c:1.22
Rev: src/modules/_Crypto/invert.c:1.17
Rev: src/modules/_Crypto/md2.c:1.17
Rev: src/modules/_Crypto/md4.c:1.6
Rev: src/modules/_Crypto/pipe.c:1.26
Rev: src/modules/_Crypto/rijndael.c:1.11
Rev: src/modules/_Crypto/sha.c:1.25
Rev: src/modules/_Ffmpeg/ffmpeg.c:1.17
Rev: src/modules/_math/math.c:1.60
Rev: src/modules/files/efuns.c:1.126
Rev: src/modules/files/file.c:1.267
Rev: src/modules/files/stat.c:1.27
Rev: src/modules/files/udp.c:1.43
Rev: src/modules/system/passwords.c:1.41
Rev: src/modules/system/system.c:1.142
Rev: src/operators.c:1.174
Rev: src/pike_search.c:1.15
Rev: src/post_modules/_ADT/circular_list.cmod:1.5
Rev: src/post_modules/_ADT/sequence.cmod:1.6
Rev: src/program.c:1.498
Rev: src/security.c:1.42
Rev: src/signal_handler.c:1.262

65:   </dd>   <dt class='head--doc'><span id='p-callback'></span>Parameter <code class='parameter'>callback</code></dt>   <dd></dd><dd class='body--doc'><p>Function to be called on completion. -  The first argument will be <tt>1</tt> if a connection was -  successfully estabished, and <tt>0</tt> (zero) on failure. +  The first argument will be <code class='expr'>1</code> if a connection was +  successfully estabished, and <code class='expr'>0</code> (zero) on failure.    The rest of the arguments to <code>callback</code> are passed    verbatim from <code>args</code>.</p>   </dd>
74:   <dd></dd><dd class='body--doc'><p>Extra arguments to pass to <code>callback</code>.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>0</tt> on failure, and <tt>1</tt> if <code>callback</code> + <dd class='body--doc'><p>Returns <code class='expr'>0</code> on failure, and <code class='expr'>1</code> if <code>callback</code>    will be used.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>The socket may be opened with <code>open_socket()</code> ahead of    the call to this function, but it is not required.</p>   <p> For <code>callback</code> to be called, the backend must be active (ie -  <code>main()</code> must have returned <tt>-1</tt>).</p> - <p> The socket will be in non-blocking state if <tt>1</tt> has been +  <code>main()</code> must have returned <code class='expr'>-1</code>).</p> + <p> The socket will be in non-blocking state if <code class='expr'>1</code> has been    returned, and any callbacks will be cleared.</p>   </dd>   <dt class='head--doc'>See also</dt>
143:    and failure with the close-callback or the read_oob-callback.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, and <tt>0</tt> on failure.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> on failure.</p>   </dd>   <dt class='head--doc'>Note</dt> - <dd class='body--doc'><p>In nonblocking mode <tt>0</tt> (zero) may be returned and <code>errno()</code> set to -  <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded + <dd class='body--doc'><p>In nonblocking mode <code class='expr'>0</code> (zero) may be returned and <code>errno()</code> set +  to <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded    as a connection failure.</p>   </dd></dl>   
170:   <dd class='body--doc'><p>This function returns 1 for success, 0 otherwise.</p>   </dd>   <dt class='head--doc'>Note</dt> - <dd class='body--doc'><p>In nonblocking mode <tt>0</tt> (zero) may be returned and <code>errno()</code> set to -  <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded -  as a connection failure. In nonblocking mode you need to wait for a write -  or close callback before you know if the connection failed or not.</p> + <dd class='body--doc'><p>In nonblocking mode <code class='expr'>0</code> (zero) may be returned and +  <code>errno()</code> set to <code class='expr'>EWOULDBLOCK</code> or +  <code class='expr'>WSAEWOULDBLOCK</code>. This should not be regarded as a +  connection failure. In nonblocking mode you need to wait for a +  write or close callback before you know if the connection failed +  or not.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>query_address()</code>, <code>async_connect()</code>, <code>connect_unix()</code></p>
193:    and failure with the close-callback or the read_oob-callback.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, and <tt>0</tt> on failure.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> on failure.</p>   </dd>   <dt class='head--doc'>Note</dt> - <dd class='body--doc'><p>In nonblocking mode <tt>0</tt> (zero) may be returned and <code>errno()</code> set to -  <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded + <dd class='body--doc'><p>In nonblocking mode <code class='expr'>0</code> (zero) may be returned and <code>errno()</code> set +  to <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded    as a connection failure.</p>   </dd></dl>   
213:   <dd class='body--doc'><p>Open a UNIX domain socket connection to the specified destination.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, and <tt>0</tt> on failure.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> on failure.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>Nonblocking mode is not supported while connecting</p>
241:   <p> The second way is calling it with a <code>filename</code> and open <code>mode</code>. This is    the same thing as cloning and then calling <code>open()</code>, except shorter and    faster.</p> - <p> The third way is to call it with <code>descriptorname</code> of <tt>"stdin"</tt>, -  <tt>"stdout"</tt> or <tt>"stderr"</tt>. This will open the specified + <p> The third way is to call it with <code>descriptorname</code> of <code class='expr'>"stdin"</code>, +  <code class='expr'>"stdout"</code> or <code class='expr'>"stderr"</code>. This will open the specified    standard stream.</p>   <p> For the advanced users, you can use the file descriptors of the    systems (note: emulated by pike on some systems - like NT). This is    only useful for streaming purposes on unix systems. This is <b>not    recommended at all</b> if you don't know what you're into. Default -  <code>mode</code> for this is <tt>"rw"</tt>.</p> +  <code>mode</code> for this is <code class='expr'>"rw"</code>.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>Open mode will be filtered through the system UMASK. You
453:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Open a file for read, write or append. The parameter <code>mode</code> should    contain one or more of the following letters:</p> - <table class='box'><tr><td><code><code class='key'>'r'</code></code></td><td><p>Open file for reading.</p> + <table class='box'><tr><td><code><code class='key'>"r"</code></code></td><td><p>Open file for reading.</p>   </td></tr> - <tr><td><code><code class='key'>'w'</code></code></td><td><p>Open file for writing.</p> + <tr><td><code><code class='key'>"w"</code></code></td><td><p>Open file for writing.</p>   </td></tr> - <tr><td><code><code class='key'>'a'</code></code></td><td><p>Open file for append (use with <tt>'w'</tt>).</p> + <tr><td><code><code class='key'>"a"</code></code></td><td><p>Open file for append (use with <code class='expr'>"w"</code>).</p>   </td></tr> - <tr><td><code><code class='key'>'t'</code></code></td><td><p>Truncate file at open (use with <tt>'w'</tt>).</p> + <tr><td><code><code class='key'>"t"</code></code></td><td><p>Truncate file at open (use with <code class='expr'>"w"</code>).</p>   </td></tr> - <tr><td><code><code class='key'>'c'</code></code></td><td><p>Create file if it doesn't exist (use with <tt>'w'</tt>).</p> + <tr><td><code><code class='key'>"c"</code></code></td><td><p>Create file if it doesn't exist (use with <code class='expr'>"w"</code>).</p>   </td></tr> - <tr><td><code><code class='key'>'x'</code></code></td><td><p>Fail if file already exists (use with <tt>'c'</tt>).</p> + <tr><td><code><code class='key'>"x"</code></code></td><td><p>Fail if file already exists (use with <code class='expr'>"c"</code>).</p>   </td></tr> - </table><p><code>mode</code> should always contain at least one of the letters <tt>'r'</tt> or -  <tt>'w'</tt>.</p> - <p> The parameter <code>mask</code> is protection bits to use if the file is created. -  Default is <tt>0666</tt> (read+write for all in octal notation).</p> + </table><p><code>mode</code> should always contain at least one of the letters +  <code class='expr'>"r"</code> or <code class='expr'>"w"</code>.</p> + <p> The parameter <code>mask</code> is protection bits to use if the file is +  created. Default is <code class='expr'>0666</code> (read+write for all in octal +  notation).</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>This function returns 1 for success, 0 otherwise.</p> + <dd class='body--doc'><p>This function returns <code class='expr'>1</code> for success, <code class='expr'>0</code> otherwise.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>close()</code>, <code>create()</code></p>
489:      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Open a file or fd.</p> - <p> If <code>access</code> is not specified, it will default to <tt>00666</tt>.</p> + <p> If <code>access</code> is not specified, it will default to <code class='expr'>00666</code>.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>close()</code></p>
540:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Check if there is data available to read,    or wait some time for available data to read.</p> - <p> Returns <tt>1</tt> if there is data available to read, -  <tt>0</tt> (zero) if there is no data available, and -  <tt>-1</tt> if something went wrong.</p> + <p> Returns <code class='expr'>1</code> if there is data available to read, +  <code class='expr'>0</code> (zero) if there is no data available, and +  <code class='expr'>-1</code> if something went wrong.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>errno()</code>, <code>read()</code></p>
578:    called in was open to begin with, it will be closed before the pipe    is created.</p>   </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'><p>Document the <tt>PROP_</tt> properties.</p> + <dd class='body--fixme'><p>Document the <code class='expr'>PROP_</code> properties.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>Process.create_process()</code></p>
613:   <dd class='body--doc'><p>Get address and port of a socket end-point.</p>   <p> This function returns the remote or local address of a socket on the    form "x.x.x.x port".</p> - <p> If the argument <code>local</code> is not specified, or is <tt>0</tt> (zero), + <p> If the argument <code>local</code> is not specified, or is <code class='expr'>0</code> (zero),    the remote address will be returned. Otherwise, if <code>local</code> is -  <tt>1</tt>, the local address will be returned.</p> +  <code class='expr'>1</code>, the local address will be returned.</p>   <p> If the file is not a socket, not connected, or some other error -  occurrs, <tt>0</tt> (zero) will be returned.</p> +  occurrs, <code class='expr'>0</code> (zero) will be returned.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>connect()</code></p>
810:    otherwise it will be an absolute offset from the start of the file.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns the new offset, or <tt>-1</tt> on failure.</p> + <dd class='body--doc'><p>Returns the new offset, or <code class='expr'>-1</code> on failure.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>The arguments <code>mult</code> and <code>add</code> are considered obsolete, and
881:   <dd class='body--doc'><p>Set internal socket buffer.</p>   <p> This function sets the internal buffer size of a socket or stream.</p>   <p> The second argument allows you to set the read or write buffer by -  specifying <tt>"r"</tt> or <tt>"w"</tt>.</p> +  specifying <code class='expr'>"r"</code> or <code class='expr'>"w"</code>.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>It is not guaranteed that this function actually does anything,
944:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>This function sets the <tt>id</tt> of this file. The <tt>id</tt> is mainly    used as an identifier that is sent as the first argument to all -  callbacks. The default <tt>id</tt> is <tt>0</tt> (zero). Another possible +  callbacks. The default <tt>id</tt> is <code class='expr'>0</code> (zero). Another possible    use of the <tt>id</tt> is to hold all data related to this file in a    mapping or array.</p>   </dd>
1093:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Get status for an open file.</p>   <p> This function returns the same information as the function <code>file_stat()</code>, -  but for the file it is called in. If file is not an open file, <tt>0</tt> +  but for the file it is called in. If file is not an open file, <code class='expr'>0</code>    (zero) will be returned. Zero is also returned if file is a pipe or    socket.</p>   </dd>
1119:   <dd class='body--doc'><p>Flush buffers to disk.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>0</tt> (zero) and sets errno on failure.</p> - <p> Returns <tt>1</tt> on success.</p> + <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) and sets errno on failure.</p> + <p> Returns <code class='expr'>1</code> on success.</p>   </dd></dl>      
1220:   <p> Truncates the file to the specified length <code>length</code>.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, and <tt>0</tt> (zero) on failure.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> (zero) on failure.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>open()</code></p>
1338:   <dd class='body--doc'><p>Returns the ASCII value of the character.</p>   </dd>   <dt class='head--doc'>Note</dt> - <dd class='body--doc'><p>Returns an <tt>int</tt> and not a <tt>string</tt> of length 1.</p> + <dd class='body--doc'><p>Returns an <code class='expr'>int</code> and not a <code class='expr'>string</code> of length 1.</p>   </dd></dl>      
1353:   <dd class='body--doc'><p>Read one line of input with support for input conversion.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>This function returns the line read if successful, and <tt>0</tt> if + <dd class='body--doc'><p>This function returns the line read if successful, and <code class='expr'>0</code> if    no more lines are available.</p>   </dd>   <dt class='head--doc'>See also</dt>
1519:   <code><span class='object'>Stdio.Port</span> <span class='class'>Stdio.Port</span><b>(</b><code class='argument'>"stdin"</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt> - <dd class='body--doc'><p>If the first argument is other than <tt>"stdin"</tt> the arguments will + <dd class='body--doc'><p>If the first argument is other than <code class='expr'>"stdin"</code> the arguments will    be passed to <code>bind()</code>.</p> - <p> When create is called with <tt>"stdin"</tt> as the first argument, a -  socket is created out of the file descriptor <tt>0</tt>. This is only + <p> When create is called with <code class='expr'>"stdin"</code> as the first argument, a +  socket is created out of the file descriptor <code class='expr'>0</code>. This is only    useful if that actually is a socket to begin with.</p>   </dd>   <dt class='head--doc'>See also</dt>
1679:    number for the remote machine.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, <tt>0</tt> (zero) otherwise.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, <code class='expr'>0</code> (zero) otherwise.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>If the socket is in nonblocking mode, you have to wait
1705:    broadcast address.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> on success, <tt>0</tt> (zero) otherwise.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> on success, <code class='expr'>0</code> (zero) otherwise.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>This is normally only avalable to root users.</p>
1884:   <dd class='body--doc'><p>Check for data and wait max. <code>timeout</code> seconds.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>1</tt> if data are ready, <tt>0</tt> (zero) otherwise.</p> + <dd class='body--doc'><p>Returns <code class='expr'>1</code> if data are ready, <code class='expr'>0</code> (zero) otherwise.</p>   </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>Stdio.Terminfo</b></h2>   </dt><dd>
2700:      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Append <code>relative</code> paths to an <code>absolute</code> path and remove any -  <tt>"//"</tt>, <tt>"../"</tt> or <tt>"/."</tt> to produce a straightforward -  absolute path as a result.</p> - <p> <tt>"../"</tt> is ignorded in the relative paths if it makes the +  <code class='expr'>"//"</code>, <code class='expr'>"../"</code> or <code class='expr'>"/."</code> to produce a +  straightforward absolute path as a result.</p> + <p> <code class='expr'>"../"</code> is ignorded in the relative paths if it makes the    created path begin with something else than the absolute path    (or so far created path).</p>   </dd>
2734:   </dd>   <dt class='head--doc'><span id='p-cb'></span>Parameter <code class='parameter'>cb</code></dt>   <dd></dd><dd class='body--doc'><p>Function to be called on completion. -  The first argument will be <tt>1</tt> on success, and <tt>0</tt> (zero) +  The first argument will be <code class='expr'>1</code> on success, and <code class='expr'>0</code> (zero)    otherwise. The rest of the arguments tp <code>callback</code> are passed    verbatim from <code>args</code>.</p>   </dd>
2743:   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>For <code>callback</code> to be called, the backend must be active (ie -  <code>main()</code> must have returned <tt>-1</tt>).</p> +  <code>main()</code> must have returned <code class='expr'>-1</code>).</p>   </dd>   <dt class='head--doc'>Bugs</dt>   <dd class='body--doc'><p>Currently the file sizes are not compared, so the destination file
2969:   <dd class='body--doc'><p>Throws an error if <code>filename</code> isn't a regular file.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>Returns <tt>0</tt> (zero) on failure to open <code>filename</code>.</p> + <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure to open <code>filename</code>.</p>   <p> Returns a string with the requested data otherwise.</p>   </dd>   <dt class='head--doc'>See also</dt>
3027:    When completed <code>callback</code> will be called with the total number of    bytes sent as the first argument, followed by <code>args</code>.</p>   <p> Any of <code>headers</code>, <code>from</code> and <code>trailers</code> may be left out -  by setting them to <tt>0</tt>.</p> - <p> Setting <code>offset</code> to <tt>-1</tt> means send from the current position in +  by setting them to <code class='expr'>0</code>.</p> + <p> Setting <code>offset</code> to <code class='expr'>-1</code> means send from the current position in    <code>from</code>.</p> - <p> Setting <code>len</code> to <tt>-1</tt> means send until <code>from</code>'s end of file is + <p> Setting <code>len</code> to <code class='expr'>-1</code> means send until <code>from</code>'s end of file is    reached.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>The sending is performed asynchronously, and may complete    before the function returns.</p>   <p> For <code>callback</code> to be called, the backend must be active (ie -  <code>main()</code> must have returned <tt>-1</tt>).</p> +  <code>main()</code> must have returned <code class='expr'>-1</code>).</p>   <p> In some cases, the backend must also be active for any sending to    be performed at all.</p>   </dd>
3493:   </dl><p>There are also some items that provide alternative representations    of the above:</p>   <dl class='group--doc'><dt>type</dt> - <dd><p>The type as a string, can be any of <tt>"reg"</tt>, -  <tt>"dir"</tt>, <tt>"lnk"</tt>, <tt>"fifo"</tt>, <tt>"sock"</tt>, -  <tt>"chr"</tt>, <tt>"blk"</tt>, and <tt>"unknown"</tt>.</p> + <dd><p>The type as a string, can be any of <code class='expr'>"reg"</code>, +  <code class='expr'>"dir"</code>, <code class='expr'>"lnk"</code>, <code class='expr'>"fifo"</code>, <code class='expr'>"sock"</code>, +  <code class='expr'>"chr"</code>, <code class='expr'>"blk"</code>, and <code class='expr'>"unknown"</code>.</p>   </dd>   <dt>mode_string</dt>   <dd><p>The file mode encoded as a string in <tt>ls -l</tt> style, e.g. -  <tt>"drwxr-xr-x"</tt>.</p> +  <code class='expr'>"drwxr-xr-x"</code>.</p>   </dd>   </dl><p>Note that some items might not exist or have meaningful values    on some platforms.</p>   <p> Additionally, the object may be initialized from or casted to an -  <tt>array</tt> on the form of a 'traditional' LPC stat-array, and +  <code class='expr'>array</code> on the form of a 'traditional' LPC stat-array, and    it's also possible to index the object directly with integers as    if it were such an array. The stat-array has this format:</p>   <table class='box'><tr><td colspan='2'>Array</td></tr>
3526:   </td></tr>   </table><p>It's possible to modify the stat struct by assigning values to    the items. They essentially work as variables, although some of -  them affect others, e.g. setting <tt>isdir</tt> clears <tt>isreg</tt> -  and setting <tt>mode_string</tt> changes many of the other items.</p> +  them affect others, e.g. setting <code class='expr'>isdir</code> clears <code class='expr'>isreg</code> +  and setting <code class='expr'>mode_string</code> changes many of the other items.</p>   </dd></dl>      <hr />
3542:   <ul>   <li><p><code>stat</code> is an object, typically another <code>Stdio.Stat</code>. The    stat info is copied from the object by getting the values of -  <tt>mode</tt>, <tt>size</tt>, <tt>atime</tt>, <tt>mtime</tt>, <tt>ctime</tt>, -  <tt>uid</tt>, <tt>gid</tt>, <tt>dev</tt>, <tt>ino</tt>, <tt>nlink</tt>, and -  <tt>rdev</tt>.</p> +  <code class='expr'>mode</code>, <code class='expr'>size</code>, <code class='expr'>atime</code>, <code class='expr'>mtime</code>, +  <code class='expr'>ctime</code>, <code class='expr'>uid</code>, <code class='expr'>gid</code>, <code class='expr'>dev</code>, <code class='expr'>ino</code>, +  <code class='expr'>nlink</code>, and <code class='expr'>rdev</code>.</p>   </li><li><p><code>stat</code> is a seven element array on the 'traditional' LPC    stat-array form (see the class doc).</p>   </li></ul></dd></dl>