autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:131159:    <ref resolved='predef::Stdio.Fd.receive_fd'>Stdio.File()-&gt;receive_fd()</ref></p>   </text></group></doc>   <constant name='PROP_SEND_FD'><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='PROP_SHUTDOWN' homogen-type='constant'><doc><text><p>The file supports shutting down transmission in either    direction.</p>   </text><group><seealso/><text><p><ref resolved='predef::Stdio.File.close'>Stdio.File()-&gt;close()</ref>, <ref resolved='predef::Stdio.File.pipe'>Stdio.File()-&gt;pipe()</ref></p>   </text></group></doc>   <constant name='PROP_SHUTDOWN'><type><int/></type></constant>   </docgroup> + <docgroup homogen-name='PROP_TTY' homogen-type='constant'><doc><text><p>The <ref resolved='predef::Stdio.File'>Stdio.File</ref> object supports tty operations.</p> + </text><group><seealso/><text><p><ref resolved='predef::Stdio.File.pipe'>Stdio.File()-&gt;pipe()</ref></p> + </text></group></doc> + <constant name='PROP_TTY'><type><int/></type></constant> + </docgroup>   <docgroup homogen-name='TCSADRAIN' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p>   <p> Change after all output has been written.</p>   </text></doc>   <constant name='TCSADRAIN'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='TCSAFLUSH' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p>   <p> Change after all output has been written,    and empty the input buffers.</p>   </text></doc>   <constant name='TCSAFLUSH'><type><string/></type></constant>
autodoc.git/autodoc.xml:133928:    and an object that is returned.</p>   </text><group><param name='required_properties'/><text><p>Binary or (<ref resolved='predef::`|'>predef::`|()</ref>) of required <expr>PROP_</expr> properties.</p>   <int><group><value>PROP_IPC</value><text><p>The resulting pipe may be used for inter process communication.</p>   </text></group><group><value>PROP_NONBLOCK</value><text><p>The resulting pipe supports nonblocking I/O.</p>   </text></group><group><value>PROP_SHUTDOWN</value><text><p>The resulting pipe supports shutting down transmission in either    direction (see <ref resolved='predef::Stdio.File.close'>close()</ref>).</p>   </text></group><group><value>PROP_BUFFERED</value><text><p>The resulting pipe is buffered (usually 4KB).</p>   </text></group><group><value>PROP_BIDIRECTIONAL</value><text><p>The resulting pipe is bi-directional.</p>   </text></group><group><value>PROP_SEND_FD</value><text><p>The resulting pipe might support sending of file descriptors    (see <ref resolved='predef::Stdio.File.send_fd'>send_fd()</ref> and <ref resolved='predef::Stdio.Fd.receive_fd'>receive_fd()</ref> for details).</p> + </text></group><group><value>PROP_TTY</value><text><p>The resulting pipe is a pseudo-tty.</p>   </text></group><group><value>PROP_REVERSE</value><text><p>The resulting pipe supports communication "backwards" (but    not necessarily "forwards", see <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref>).</p>   </text></group></int><p>The default is <expr>PROP_NONBLOCK|PROP_BIDIRECTIONAL</expr>.</p>   <p> If <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref> isn't specified, the read-end is this    object, and the write-end is the returned object (unless    <ref resolved='predef::Stdio.PROP_REVERSE'>PROP_REVERSE</ref> has been specified, in which case it is the other    way around).</p>   <p> The two ends of a bi-directional pipe are indistinguishable.</p> -  + <p> For <ref resolved='predef::Stdio.PROP_TTY'>PROP_TTY</ref> the returned object is the slave (unless +  <ref resolved='predef::Stdio.PROP_REVERSE'>PROP_REVERSE</ref> has been specified).</p>   <p> If the File object this function is called in was open to begin with,    it will be closed before the pipe is created.</p>   </text></group><group><note/><text><p>Calling this function with an argument of <tt>0</tt> is not the    same as calling it with no arguments.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Process.create_process'>Process.create_process()</ref>, <ref resolved='predef::Stdio.File.send_fd'>send_fd()</ref>, <ref resolved='predef::Stdio.Fd.receive_fd'>receive_fd()</ref>,    <ref resolved='predef::Stdio.PROP_IPC'>PROP_IPC</ref>, <ref resolved='predef::Stdio.PROP_NONBLOCK'>PROP_NONBLOCK</ref>, <ref resolved='predef::Stdio.PROP_SEND_FD'>PROP_SEND_FD</ref>,    <ref resolved='predef::Stdio.PROP_SHUTDOWN'>PROP_SHUTDOWN</ref>, <ref resolved='predef::Stdio.PROP_BUFFERED'>PROP_BUFFERED</ref>, <ref resolved='predef::Stdio.PROP_REVERSE'>PROP_REVERSE</ref>, -  <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref></p> +  <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref>, <ref resolved='predef::Stdio.PROP_TTY'>PROP_TTY</ref></p>   </text></group></doc>   <method name='pipe'>   <arguments><argument name='required_properties'><type><or><void/><int/></or></type></argument></arguments>   <returntype><object resolved='predef::Stdio.File'>File</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='query_buffer_mode' homogen-type='method'><doc><text><p>Get the active input and output buffers that have been    set with <ref resolved='predef::Stdio.File.set_buffer_mode'>set_buffer_mode()</ref> (if any).</p>   </text><group><returns/><text><p>Returns an array with two elements:</p>   <array><group><elem><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type><index>0</index></elem><text><p>The current input buffer.</p>