[svn-upgrade] Integrating new upstream version, ion3 (20070608)

[ion3.git] / doc / ionconf / node7.html

diff --git a/doc/ionconf/node7.html b/doc/ionconf/node7.html
index 11dd84ac7f6beabb8c1ac86c3a22afa950aa48a0..7b6bec893f3711dfdc0e8270b859d0d074a1c5b0 100644 (file)
--- a/doc/ionconf/node7.html
+++ b/doc/ionconf/node7.html
@@ -291,7 +291,7 @@ The string <TT>guard</TT>  maybe set to pose limits on <TT>_sub</TT>. Currently
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Define bindings for context <TT>context</TT>. Here <TT>binding</TT> is
  a table composed of entries created with <A HREF="#fn:ioncore.kpress"><TT>ioncore.kpress</TT></A>, 
- etc.; see section <A HREF="node4.html#sec:bindings">3.3</A> for details.
+ etc.; see Section <A HREF="node4.html#sec:bindings">3.3</A> for details.
   
 </DD>
 </DL>
@@ -1023,9 +1023,11 @@ Note that this function is asynchronous; the region will not
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Run <TT>cmd</TT> with a read pipe connected to its stdout.
- When data is received through the pipe, <TT>handler</TT> is called
- with that data.
+<DD>Run <TT>cmd</TT> with a read pipe connected to its stdout and stderr.
+ When data is received through one of these pipes, <TT>h</TT> or <TT>errh</TT> 
+ is called with that data. When the pipe is closed, the handler is called
+ with <TT>nil</TT> argument. The PID of the new process is returned, or
+ -1 on error.
   
 </DD>
 </DL>
@@ -1523,8 +1525,9 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Creates a binding description table for the action of pressing a key given 
- by <TT>keyspec</TT> (with possible modifiers) to the function <TT>func</TT>.
- For more information on bindings, see section <A HREF="node4.html#sec:bindings">3.3</A>.
+ by <TT>keyspec</TT> (with possible modifiers) to the function <TT>cmd</TT>.
+ The <TT>guard</TT> controls when the binding can be called.
+ For more informationp see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -1539,10 +1542,10 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>This is similar to <A HREF="#fn:kpress"><TT>kpress</TT></A> but after calling <TT>cmd</TT>, 
+<DD>This is similar to <A HREF="#fn:ioncore.kpress"><TT>ioncore.kpress</TT></A> but after calling <TT>cmd</TT>, 
  Ioncore waits for all modifiers to be released before processing
  any further actions.
- For more information on bindings, see section <A HREF="node4.html#sec:bindings">3.3</A>.
+ For more information on bindings, see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -1604,8 +1607,8 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Creates a binding description table for the action of clicking a mouse 
  button while possible modifier keys are pressed,
- both given by <TT>buttonspec</TT>, to the function <TT>func</TT>.
- For more information, see section <A HREF="node4.html#sec:bindings">3.3</A>.
+ both given by <TT>buttonspec</TT>, to the function <TT>cmd</TT>.
+ For more information, see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -1620,8 +1623,8 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Similar to <A HREF="#fn:mclick"><TT>mclick</TT></A> but for double-click.
- Also see section <A HREF="node4.html#sec:bindings">3.3</A>.
+<DD>Similar to <A HREF="#fn:ioncore.mclick"><TT>ioncore.mclick</TT></A> but for double-click.
+ Also see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -1677,8 +1680,8 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Similar to <A HREF="#fn:mclick"><TT>mclick</TT></A> but for just pressing the mouse button.
- Also see section <A HREF="node4.html#sec:bindings">3.3</A>.
+<DD>Similar to <A HREF="#fn:ioncore.mclick"><TT>ioncore.mclick</TT></A> but for just pressing the mouse button.
+ Also see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -1704,14 +1707,14 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 <DD><A NAME="fn:ioncore.submap"></A>  
 </DD>
 <DT><STRONG>Synopsis:</STRONG></DT>
-<DD><TT>ioncore.submap(kcb_, list)</TT>
+<DD><TT>ioncore.submap(keyspec, list)</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Returns a function that creates a submap binding description table.
  When the key press action <TT>keyspec</TT> occurs, Ioncore will wait for
  a further key presse and act according to the submap.
- For details, see section <A HREF="node4.html#sec:bindings">3.3</A>.
+ For details, see Section <A HREF="node4.html#sec:bindings">3.3</A>.
   
 </DD>
 </DL>
@@ -2112,6 +2115,10 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 <TR><TD ALIGN="LEFT"><TT>sizepolicy</TT></TD>
 <TD ALIGN="LEFT">(string) Size policy; see Section <A HREF="#sec:sizepolicies">6.10.1</A>.</TD>
 </TR>
+<TR><TD ALIGN="LEFT"><TT>bottom</TT></TD>
+<TD ALIGN="LEFT">(boolean) Mark the attached region as the
+                 ``bottom'' of <TT>ws</TT>.</TD>
+</TR>
 </TABLE>
 
 <P>
@@ -2565,8 +2572,8 @@ In addition parameters to the region to be created are passed in this
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Returns the <TT>n</TT>:th object managed by <TT>mplex</TT> on the
- <TT>l</TT>:th layer.
+<DD>Returns the <TT>n</TT>:th object on the mutually exclusive
+ list of <TT>mplex</TT>.
   
 </DD>
 </DL>
@@ -2640,13 +2647,16 @@ In addition parameters to the region to be created are passed in this
 <TD ALIGN="LEFT">Description</TD>
 </TR>
 <TR><TD ALIGN="LEFT"><TT>pos</TT></TD>
-<TD ALIGN="LEFT">The corner of the screen to place the status display
-               in: one of `<TT>tl</TT>', `<TT>tr</TT>', `<TT>bl</TT>' 
+<TD ALIGN="LEFT">(string) The corner of the screen to place the status 
+               display in: one of `<TT>tl</TT>', `<TT>tr</TT>', `<TT>bl</TT>' 
                or `<TT>br</TT>'.</TD>
 </TR>
+<TR><TD ALIGN="LEFT"><TT>fullsize</TT></TD>
+<TD ALIGN="LEFT">(boolean) Waste all available space.</TD>
+</TR>
 <TR><TD ALIGN="LEFT"><TT>action</TT></TD>
-<TD ALIGN="LEFT">If this field is set to `<TT>keep</TT>', <TT>corner</TT>
-                  and <TT>orientation</TT> are changed for the existing
+<TD ALIGN="LEFT">(string) If this field is set to `<TT>keep</TT>', 
+                  <TT>pos</TT> and <TT>fullsize</TT> are changed for the existing
                   status display. If this field is set to `<TT>remove</TT>',
                   the existing status display is removed. If this
                   field is not set or is set to `<TT>replace</TT>', a 
@@ -3802,7 +3812,7 @@ Note that this function is asynchronous; the region will not
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Flip contents of <TT>node</TT>.
+<DD>Flip contents of <TT>split</TT>.
   
 </DD>
 </DL>
@@ -5572,8 +5582,8 @@ Any parameters not explicitly set in <TT>conftab</TT> will be left unchanged.
 </TR>
 <TR><TD ALIGN="LEFT"><TT>pos</TT></TD>
 <TD ALIGN="LEFT">string</TD>
-<TD ALIGN="LEFT">Position: <TT>"tl"</TT>, <TT>"tr"</TT>, 
-                        <TT>"bl"</TT> or <TT>"br"</TT>
+<TD ALIGN="LEFT">Position: `<TT>tl</TT>', `<TT>tr</TT>', 
+                        `<TT>bl</TT>' or `<TT>br</TT>'
                         (for the obvious combinations of 
                         top/left/bottom/right).</TD>
 </TR>
@@ -5834,7 +5844,7 @@ Any parameters not explicitly set in <TT>conftab</TT> will be left unchanged.
 <P>
 
   <DL>
-<DD><A NAME="8232"></A>
+<DD><A NAME="8242"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5906,7 +5916,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8233"></A>
+<DD><A NAME="8243"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5926,7 +5936,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8234"></A>
+<DD><A NAME="8244"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5947,7 +5957,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8235"></A>
+<DD><A NAME="8245"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5968,7 +5978,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8236"></A>
+<DD><A NAME="8246"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6014,7 +6024,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8237"></A>
+<DD><A NAME="8247"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6035,7 +6045,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8238"></A>
+<DD><A NAME="8248"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6055,7 +6065,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8239"></A>
+<DD><A NAME="8249"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6076,7 +6086,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8240"></A>
+<DD><A NAME="8250"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6096,7 +6106,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8241"></A>
+<DD><A NAME="8251"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6116,7 +6126,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8242"></A>
+<DD><A NAME="8252"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6168,7 +6178,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8243"></A>
+<DD><A NAME="8253"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6189,7 +6199,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8244"></A>
+<DD><A NAME="8254"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6211,7 +6221,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8245"></A>
+<DD><A NAME="8255"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>