Diff of autodoc.git/autodoc.xml (5ca3e2761a00ed44a09b2736bc5e5c9c2710543a » 688eaea4834924f97a235516ef27337effe4967f)

autodoc.git/autodoc.xml:131159: <ref resolved='predef::Stdio.Fd.receive_fd'>Stdio.File()->receive_fd()</ref> </text></group></doc> <constant name='PROP_SEND_FD'><type><int/></type></constant> </docgroup> <docgroup homogen-name='PROP_SHUTDOWN' homogen-type='constant'><doc><text>The file supports shutting down transmission in either direction. </text><group><seealso/><text><ref resolved='predef::Stdio.File.close'>Stdio.File()->close()</ref>, <ref resolved='predef::Stdio.File.pipe'>Stdio.File()->pipe()</ref> </text></group></doc> <constant name='PROP_SHUTDOWN'><type><int/></type></constant> </docgroup> + <docgroup homogen-name='PROP_TTY' homogen-type='constant'><doc><text>The <ref resolved='predef::Stdio.File'>Stdio.File</ref> object supports tty operations. + </text><group><seealso/><text><ref resolved='predef::Stdio.File.pipe'>Stdio.File()->pipe()</ref> + </text></group></doc> + <constant name='PROP_TTY'><type><int/></type></constant> + </docgroup> <docgroup homogen-name='TCSADRAIN' homogen-type='constant'><doc><text>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()->tcsetattr()</ref>. Change after all output has been written. </text></doc> <constant name='TCSADRAIN'><type><string/></type></constant> </docgroup> <docgroup homogen-name='TCSAFLUSH' homogen-type='constant'><doc><text>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()->tcsetattr()</ref>. Change after all output has been written, and empty the input buffers. </text></doc> <constant name='TCSAFLUSH'><type><string/></type></constant>
autodoc.git/autodoc.xml:133928: and an object that is returned. </text><group><param name='required_properties'/><text>Binary or (<ref resolved='predef::`|'>predef::`|()</ref>) of required <expr>PROP_</expr> properties. <int><group><value>PROP_IPC</value><text>The resulting pipe may be used for inter process communication. </text></group><group><value>PROP_NONBLOCK</value><text>The resulting pipe supports nonblocking I/O. </text></group><group><value>PROP_SHUTDOWN</value><text>The resulting pipe supports shutting down transmission in either direction (see <ref resolved='predef::Stdio.File.close'>close()</ref>). </text></group><group><value>PROP_BUFFERED</value><text>The resulting pipe is buffered (usually 4KB). </text></group><group><value>PROP_BIDIRECTIONAL</value><text>The resulting pipe is bi-directional. </text></group><group><value>PROP_SEND_FD</value><text>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). + </text></group><group><value>PROP_TTY</value><text>The resulting pipe is a pseudo-tty. </text></group><group><value>PROP_REVERSE</value><text>The resulting pipe supports communication "backwards" (but not necessarily "forwards", see <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref>). </text></group></int>The default is <expr>PROP_NONBLOCK|PROP_BIDIRECTIONAL</expr>. 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). The two ends of a bi-directional pipe are indistinguishable. - + 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). If the File object this function is called in was open to begin with, it will be closed before the pipe is created. </text></group><group><note/><text>Calling this function with an argument of <tt>0</tt> is not the same as calling it with no arguments. </text></group><group><seealso/><text><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> + <ref resolved='predef::Stdio.PROP_BIDIRECTIONAL'>PROP_BIDIRECTIONAL</ref>, <ref resolved='predef::Stdio.PROP_TTY'>PROP_TTY</ref> </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>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). </text><group><returns/><text>Returns an array with two elements: <array><group><elem><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type><index>0</index></elem><text>The current input buffer.

autodoc.git / autodoc.xml