Diff of autodoc.git/traditional_manual/chapter_9.html (d28f8f6e1f1b47a74390208aa0cd6af639061120 » 828405b9b56cb4bf262e3ea2a01a74713c46dbc0)

autodoc.git/traditional_manual/chapter_9.html:398: called once. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function is only available on some platforms. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Inherit + Fd + </dt> + <dd><code><code class='modifier'>optional</code> inherit Fd : Fd</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Inherit Fd_ref </dt> <dd><code><code class='modifier'>optional</code> inherit Fd_ref : Fd_ref</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method is_open
autodoc.git/traditional_manual/chapter_9.html:610: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>close()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method open_socket </dt> - <dd><code><code class='datatype'>int</code> open_socket(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>port</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>address</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>family</code>)</code></dd> + <dd><code><code class='datatype'>int</code> open_socket(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>port</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>address</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>family_hint</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This makes this file into a socket ready for connections. The reason for this function is so that you can set the socket to nonblocking or blocking (default is blocking) before you call <code>connect()</code>. - If you give a <code>port</code> number to this function, the socket will be - bound to this <code>port</code> locally before connecting anywhere. This is - only useful for some silly protocols like FTP. You may also - specify an <code>address</code> to bind to if your machine has many IP numbers. - <code>port</code> can also be specified as a string, giving the name of the - service associated with the port. - Finally, a protocol <code>family</code> for the socket can be specified. - If no <code>family</code> is specified, one which is appropriate for the - <code>address</code> is automatically selected. Thus, there is normally - no need to specify it. + </dd> - + <dt class='head--doc'>Parameter <code class='parameter'>port</code></dt> + <dd></dd><dd class='body--doc'>If you give a port number to this function, the socket will be + bound to this port locally before connecting anywhere. This is + only useful for some silly protocols like FTP. The port can + also be specified as a string, giving the name of the service + associated with the port. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>address</code></dt> + <dd></dd><dd class='body--doc'>You may specify an address to bind to if your machine has many IP + numbers. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>family_hint</code></dt> + <dd></dd><dd class='body--doc'>A protocol family for the socket can be specified. If no family is + specified, one which is appropriate for the address is automatically + selected. Thus, there is normally no need to specify it. If you + do not want to specify a bind address, you can provide the address + as a hint here instead, to allow the automatic selection to work + anyway. + </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>This function returns 1 for success, 0 otherwise. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>connect()</code>, <code>set_nonblocking()</code>, <code>set_blocking()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method open_socket </dt> <dd><code><code class='datatype'>bool</code> open_socket(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>port</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>addr</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>family</code>)</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + openat + </dt> + <dd><code><code class='object unresolved'>File</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> + <code><code class='object unresolved'>File</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Open a file relative to an open directory. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>File.statat()</code>, <code>File.unlinkat()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method openpt </dt> <dd><code><code class='datatype'>int</code> openpt(<code class='datatype'>string</code> <code class='argument'>mode</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Open the master end of a pseudo-terminal pair. The parameter <code>mode</code> should contain one or more of the following letters: <table class='box'><tr><td><code><code class='key'>"r"</code></code></td><td>Open terminal for reading. </td></tr> <tr><td><code><code class='key'>"w"</code></code></td><td>Open terminal for writing.
autodoc.git/traditional_manual/chapter_9.html:1194: running at a time, so you don't need mutexes between them. Unless you've specified otherwise with the <code>set_backend</code> function, the default backend <code>Pike.DefaultBackend</code> will be used. It's normally activated by returning <code class='expr'>-1</code> from the <tt>main</tt> function and will then execute in the main thread. <ul> <li>When data arrives on the stream, <code>read_cb</code> will be called with some or all of that data as the second argument. </li><li>When the stream has buffer space over for writing, <code>write_cb</code> will be called so that you can write more data to it. + This callback is also called after the remote end of a socket + connection has closed the write direction. An attempt to write + data to it in that case will generate a <code>System.EPIPE</code> errno. + If the remote end has closed both directions simultaneously + (the usual case), Pike will first attempt to call <code>close_cb</code>, + then this callback (unless <code>close_cb</code> has closed the stream). </li><li>When out-of-band data arrives on the stream, <code>read_oob_cb</code> will be called with some or all of that data as the second argument. </li><li>When the stream allows out-of-band data to be sent, <code>write_oob_cb</code> will be called so that you can write more out-of-band data to it. - </li><li>When the stream has been shut down, either due to an error or - a close from the other end, <code>close_cb</code> will be called. - <code>errno</code> will return the error that has occurred or zero in - the case of a normal close. Note that <code>close_cb</code> will not be - called for a local close, neither by a call to <code>close</code> or by - destructing this object. - </li></ul>All callbacks will receive the <tt>id</tt> set by <code>set_id</code> as + If the OS doesn't separate the write events for normal and + out-of-band data, Pike will try to call <code>write_oob_cb</code> first. + If it doesn't write anything, then <code>write_cb</code> will be tried. + This also means that <code>write_oob_cb</code> might get called when the + remote end of a connection has closed the write direction. + </li><li>When an error or an end-of-stream in the read direction + occurs, <code>close_cb</code> will be called. <code>errno</code> will return the + error, or zero in the case of an end-of-stream. + The name of this callback is rather unfortunate since it + really has nothing to do with a close: The stream is still + open when <code>close_cb</code> is called (you might not be able to read + and/or write to it, but you can still use things like + <code>query_address</code>, and the underlying file descriptor is still + allocated). Also, this callback will not be called for a local + close, neither by a call to <code>close</code> or by destructing this + object. + Also, <code>close_cb</code> will not be called if a remote close only + occurs in the write direction; that is handled by <code>write_cb</code> + (or possibly <code>write_oob_cb</code>). + Events to <code>read_cb</code> and <code>close_cb</code> will be automatically + deregistered if an end-of-stream occurs, and all events in the + case of an error. I.e. there won't be any more calls to the + callbacks unless they are reinstalled. This doesn't affect the + callback settings - <code>query_read_callback</code> et al will still + return the installed callbacks. + </li></ul>If the stream is a socket performing a nonblocking connect (see + <code>open_socket</code> and <code>connect</code>), a connection failure will call + <code>close_cb</code>, and a successful connect will call either + <code>read_cb</code> or <code>write_cb</code> as above. + All callbacks will receive the <tt>id</tt> set by <code>set_id</code> as first argument. If a callback returns <code class='expr'>-1</code>, no other callback or call out will be called by the backend in that round. I.e. the caller of the backend will get control back right away. For the default backend that means it will immediately start another round and check files and call outs anew. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>These functions do not set the file nonblocking. </dd>
autodoc.git/traditional_manual/chapter_9.html:1672: <dt class='head--doc'>Note</dt> <dd class='body--doc'>Returns an <code class='expr'>int</code> and not a <code class='expr'>string</code> of length 1. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method gets </dt> - <dd><code><code class='datatype'>string</code> gets()</code></dd> + <dd><code><code class='datatype'>string</code> gets(<code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>not_all</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Read one line of input with support for input conversion. </dd> - + <dt class='head--doc'>Parameter <code class='parameter'>not_all</code></dt> + <dd></dd><dd class='body--doc'>Set this parameter to ignore partial lines at EOF. This + is useful for eg monitoring a growing logfile. + </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>This function returns the line read if successful, and <code class='expr'>0</code> if no more lines are available. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>ngets()</code>, <code>read()</code>, <code>line_iterator()</code>, <code>set_charset()</code> </dd></dl> <hr />
autodoc.git/traditional_manual/chapter_9.html:1707: <dt class='head--type'>Method line_iterator </dt> <dd><code><code class='datatype'>object</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. If <code>trim</code> is true, all <tt>'\r'</tt> characters will be removed from the input. </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>It's not supported to call this method more than once + unless a call to <code>seek</code> is done in advance. Also note that it's + not possible to intermingle calls to <code>read</code>, <code>gets</code> or other + functions that read data with the line iterator, it will produce + unexpected results since the internal buffer in the iterator will not + contain sequential file-data in those cases. + </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>_get_iterator()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method ngets </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) ngets(<code class='datatype'>void</code>|<code class='datatype'>int(1..)</code> <code class='argument'>n</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) ngets(<code class='datatype'>void</code>|<code class='datatype'>int(1..)</code> <code class='argument'>n</code>, <code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>not_all</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get <code>n</code> lines. </dd> <dt class='head--doc'>Parameter <code class='parameter'>n</code></dt> <dd></dd><dd class='body--doc'>Number of lines to get, or all remaining if zero. - + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>not_all</code></dt> + <dd></dd><dd class='body--doc'>Set this parameter to ignore partial lines at EOF. This + is useful for eg monitoring a growing logfile. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + openat + </dt> + <dd><code><code class='object unresolved'>FILE</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> + <code><code class='object unresolved'>FILE</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Same as <code>Stdio.File()->openat()</code>, but returns a <code>Stdio.FILE</code> + object. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->openat()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method pipe </dt> - <dd><code><code class='object unresolved'>File</code> pipe(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>flags</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> pipe(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>flags</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Same as <code>Stdio.File()->pipe()</code>. </dd> <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Returns an <code>Stdio.File</code> object, NOT a <code>Stdio.FILE</code> object. + <dd class='body--doc'>Returns an <code>Stdio.File</code> object, NOT an <code>Stdio.FILE</code> object. + In future releases of Pike this will most likely change + to returning an <code>Stdio.FILE</code> object. This is already + the case if <code class='expr'>STDIO_DIRECT_FD</code> has been defined. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method printf </dt> <dd><code><code class='datatype'>int</code> printf(<code class='datatype'>string</code> <code class='argument'>format</code>, <code class='datatype'>mixed</code> ... <code class='argument'>data</code>)</code></dd>
autodoc.git/traditional_manual/chapter_9.html:1770: <dt class='head--type'>Method read </dt> <dd><code><code class='datatype'>string</code> read(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>bytes</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>now</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Read <code>bytes</code> (wide-) characters with buffering and support for input conversion. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->read()</code>, <code>set_charset()</code> + <dd class='body--doc'><code>Stdio.File()->read()</code>, <code>set_charset()</code>, <code>unread()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method set_charset </dt> <dd><code><code class='datatype'>void</code> set_charset(<code class='datatype'>string</code> <code class='argument'>charset</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Sets the input and output charset of this file to the specified <code>charset</code>. The default charset is <tt>"ISO-8859-1"</tt>. - + </dd><dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Consider using one of + ISO-IR-196 (<tt>"\e%G"</tt> - switch to UTF-8 with return) + or ISO-IR-190 (<tt>"\e%/G"</tt> - switch to UTF-8 level 1 no return) + or ISO-IR-191 (<tt>"\e%/H"</tt> - switch to UTF-8 level 2 no return) + or ISO-IR-192 (<tt>"\e%/I"</tt> - switch to UTF-8 level 3 no return) + or ISO-IR-193 (<tt>"\e%/J"</tt> - switch to UTF-16 level 1 no return) + or ISO-IR-194 (<tt>"\e%/K"</tt> - switch to UTF-16 level 2 no return) + or ISO-IR-195 (<tt>"\e%/L"</tt> - switch to UTF-16 level 3 no return) + or ISO-IR-162 (<tt>"\e%/@"</tt> - switch to UCS-2 level 1) + or ISO-IR-163 (<tt>"\e%/A"</tt> - switch to UCS-4 level 1) + or ISO-IR-174 (<tt>"\e%/C"</tt> - switch to UCS-2 level 2) + or ISO-IR-175 (<tt>"\e%/D"</tt> - switch to UCS-4 level 2) + or ISO-IR-176 (<tt>"\e%/E"</tt> - switch to UCS-2 level 3) + or ISO-IR-177 (<tt>"\e%/F"</tt> - switch to UCS-4 level 3) + or ISO-IR-178 (<tt>"\e%B"</tt> - switch to UTF-1) + automatically to encode wide strings. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method ungets </dt> <dd><code><code class='datatype'>void</code> ungets(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function puts a string back in the input buffer. The string + <dd class='body--doc'>This function puts a line back in the input buffer. The line can then be read with eg <code>read()</code>, <code>gets()</code> or <code>getchar()</code>. </dd> <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The string must not contain line-feeds. + <dd class='body--doc'>The string is autoterminated by an extra line-feed. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code> + <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code>, <code>unread()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + unread + </dt> + <dd><code><code class='datatype'>void</code> unread(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function puts a string back in the input buffer. The string + can then be read with eg <code>read()</code>, <code>gets()</code> or <code>getchar()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code>, <code>ungets()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method write </dt> <dd><code><code class='datatype'>int</code> write(<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>what</code>, <code class='datatype'>mixed</code> ... <code class='argument'>fmt</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Write <code>what</code> with support for output_conversion. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Stdio.File()->write()</code> </dd></dl>
autodoc.git/traditional_manual/chapter_9.html:1952: <dt class='head--doc'>Description</dt> <dd class='body--doc'>If the last call done on this port failed, errno will return an integer describing what went wrong. Refer to your unix manual for further information. </dd></dl> <hr /> <dl class='group--doc'> + <dt class='head--type'>Method + fd_factory + </dt> + <dd><code><code class='modifier'>protected</code> <code class='object unresolved'>Fd</code> fd_factory()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Factory creating empty <code>Fd</code> objects. + This function is called by <code>accept()</code> when it needs to create + a new file. + </dd></dl> + + + <hr /> + <dl class='group--doc'> <dt class='head--type'>Inherit _port </dt> <dd><code>inherit _port : _port</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method
autodoc.git/traditional_manual/chapter_9.html:3847: </dt> <dd><code><code class='datatype'>constant</code> Stdio.<code class='constant'>PROP_SHUTDOWN</code></code></dd> <dt class='head--fixme'>FIXME</dt> <dd class='body--fixme'>Document this constant. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Constant + TCSADRAIN + </dt> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSADRAIN</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. + Change after all output has been written. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Constant + TCSAFLUSH + </dt> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSAFLUSH</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. + Change after all output has been written, + and empty the input buffers. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Constant + TCSANOW + </dt> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSANOW</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. + Change immediately. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Constant __HAVE_OOB__ </dt> <dd><code><code class='datatype'>constant</code> Stdio.<code class='constant'>__HAVE_OOB__</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Exists and has the value 1 if OOB operations are available. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>In Pike 7.5 and later OOB operations are always present. </dd></dl>
autodoc.git/traditional_manual/chapter_9.html:3907: <dd><code><code class='datatype'>int</code> append_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Append the string <code>str</code> onto the file <code>filename</code>. For a description of <code>access</code>, see <code>Stdio.File->open()</code>. </dd> <dt class='head--doc'>Throws</dt> <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of bytes written. + <dd class='body--doc'>Returns the number of bytes written, i.e. <code class='expr'>sizeof(str)</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>write_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method append_path 
autodoc.git/traditional_manual/chapter_9.html:3992: (<code>to</code>) may be truncated. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>cp()</code>, <code>sendfile()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + convert_modestring2int + </dt> + <dd><code><code class='datatype'>int</code> convert_modestring2int(<code class='datatype'>string</code> <code class='argument'>mode_string</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert the mode_string string as returned by Stdio.Stat object + to int suitable for chmod + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>mode_string</code></dt> + <dd></dd><dd class='body--doc'>The string as return from Stdio.Stat()->mode_string + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>An int matching the permission of the mode_string string suitable for + chmod + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method cp </dt> <dd><code><code class='datatype'>int</code> cp(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Copies the file <code>from</code> to the new position <code>to</code>. If there is no system function for cp, a new file will be created and the - old one copied manually in chunks of 65536 bytes. + old one copied manually in chunks of 65536 bytes. + This function can also copy directories recursively. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>0 on error, 1 on success + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function keeps file and directory mode bits, unlike in Pike + 7.6 and earlier. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method exist </dt> <dd><code><code class='datatype'>int</code> exist(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd>
autodoc.git/traditional_manual/chapter_9.html:4050: <hr /> <dl class='group--doc'> <dt class='head--type'>Method file_size </dt> <dd><code><code class='datatype'>int</code> file_size(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Give the size of a file. Size -1 indicates that the file either does not exist, or that it is not readable by you. Size -2 - indicates that it is a directory. + indicates that it is a directory, -3 that it is a symlink and -4 + that it is a device. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>file_stat()</code>, <code>write_file()</code>, <code>read_bytes()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method get_all_active_fd
autodoc.git/traditional_manual/chapter_9.html:4213: <hr /> <dl class='group--doc'> <dt class='head--type'>Method read_bytes </dt> <dd><code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code> <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>)</code> <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>len</code> number of bytes from the file <code>filename</code> starting at byte - <code>start</code>, and return it as a string. + <dd class='body--doc'>Read <code>len</code> number of bytes from a regular file <code>filename</code> + starting at byte <code>start</code>, and return it as a string. If <code>len</code> is omitted, the rest of the file will be returned. If <code>start</code> is also omitted, the entire file will be returned. </dd> <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error if <code>filename</code> isn't a regular file. + <dd class='body--doc'>Throws an error on any I/O error except when the file doesn't + exist. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) on failure to open <code>filename</code>. + <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) if the file doesn't exist or if + <code>start</code> is beyond the end of it. Returns a string with the requested data otherwise. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>read_file</code>, <code>write_file()</code>, <code>append_file()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method read_file </dt> <dd><code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> <code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>len</code> lines from a file <code>filename</code> after skipping <code>start</code> lines - and return those lines as a string. If both <code>start</code> and <code>len</code> are omitted - the whole file is read. + <dd class='body--doc'>Read <code>len</code> lines from a regular file <code>filename</code> after skipping + <code>start</code> lines and return those lines as a string. If both + <code>start</code> and <code>len</code> are omitted the whole file is read. </dd> - + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error on any I/O error except when the file doesn't + exist. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) if the file doesn't exist or if + <code>start</code> is beyond the end of it. + Returns a string with the requested data otherwise. + </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>read_bytes()</code>, <code>write_file()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + recursive_mv + </dt> + <dd><code><code class='datatype'>int</code> recursive_mv(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Copy a file or a directory tree by copying and then + removing. Mode bits are preserved in the copy. + It's not the fastest but works on every OS and + works well across different file systems. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns 0 on failure, nonzero otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>recursive_rm</code> <code>cp</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method recursive_rm </dt> <dd><code><code class='datatype'>int</code> recursive_rm(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a file or directory a directory tree. + <dd class='body--doc'>Remove a file or a directory tree. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns 0 on failure, nonzero otherwise. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>rm</code> </dd></dl> <hr />
autodoc.git/traditional_manual/chapter_9.html:4324: <dd class='body--doc'>Returns a canonic representation of <code>path</code> (without /./, /../, // and similar path segments). </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Variable stderr </dt> - <dd><code><code class='object unresolved'>File</code> Stdio.stderr</code></dd> + <dd><code><code class='object unresolved'>FILE</code> Stdio.stderr</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>An instance of <tt>FILE("stderr")</tt>, the standard error stream. Use this when you want to output error messages. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>predef::werror()</code> </dd></dl>
autodoc.git/traditional_manual/chapter_9.html:4365: write("%5d: %s\n", line++, s); } </pre></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Variable stdout </dt> - <dd><code><code class='object unresolved'>File</code> Stdio.stdout</code></dd> + <dd><code><code class='object unresolved'>FILE</code> Stdio.stdout</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>An instance of <tt>FILE("stdout")</tt>, the standatd output stream. Use this when you want to write anything to the standard output. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>predef::write()</code> </dd></dl>
autodoc.git/traditional_manual/chapter_9.html:4411: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Write the string <code>str</code> onto the file <code>filename</code>. Any existing data in the file is overwritten. For a description of <code>access</code>, see <code>Stdio.File()->open()</code>. </dd> <dt class='head--doc'>Throws</dt> <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of bytes written. + <dd class='body--doc'>Returns the number of bytes written, i.e. <code class='expr'>sizeof(str)</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>append_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> </dd></dl> <dl><dt><h2 class='header'>Class Stdio.BlockFile</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>The Stdio.BlockFile API. This class exists purely for typing reasons. Use in types in place of <code>Stdio.File</code> where only blocking

autodoc.git / traditional_manual / chapter_9.html