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

[ion3-doc.git] / ionconf / node4.html

diff --git a/ionconf/node4.html b/ionconf/node4.html
index 4eaa00e82c046a51c49d5ab6d561f0cf85f094af..f041fdff8e43d782bf30cf5ae234d050df30af6f 100644 (file)
--- a/ionconf/node4.html
+++ b/ionconf/node4.html
@@ -905,7 +905,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1451"></A>
+<DD><A NAME="1458"></A>

     Set this to <TT>true</TT> for Acrobat Reader. It has an annoying
     habit of trying to manage its dialogs instead of setting them as
     transients and letting the window manager do its job, causing
     Set this to <TT>true</TT> for Acrobat Reader. It has an annoying
     habit of trying to manage its dialogs instead of setting them as
     transients and letting the window manager do its job, causing


@@ -923,7 +923,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1452"></A>
+<DD><A NAME="1459"></A>

     Set this to open the window in a floating frame, when
     in a group.
 
     Set this to open the window in a floating frame, when
     in a group.
 


@@ -938,7 +938,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1453"></A>
+<DD><A NAME="1460"></A>

     Should the window be initially in full screen mode?
 
 </DD>
     Should the window be initially in full screen mode?
 
 </DD>


@@ -952,7 +952,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1454"></A>
+<DD><A NAME="1461"></A>

     Should configure requests on the window be ignored?
     Only has effect on floating windows.
 
     Should configure requests on the window be ignored?
     Only has effect on floating windows.
 


@@ -967,7 +967,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1455"></A>
+<DD><A NAME="1462"></A>

     Ignore extended WM hints <TT>_NET_ACTIVE_WINDOW</TT> request.
 
 </DD>
     Ignore extended WM hints <TT>_NET_ACTIVE_WINDOW</TT> request.
 
 </DD>


@@ -981,7 +981,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1456"></A>
+<DD><A NAME="1463"></A>

     Should a newly created client window always be made
     active, even if the allocated frame isn't.
 
     Should a newly created client window always be made
     active, even if the allocated frame isn't.
 


@@ -996,7 +996,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1457"></A>
+<DD><A NAME="1464"></A>

     If the region specified by <TT>target</TT> winprop does not exist
     (or that winprop is not set), create a new workspace using the 
     previously stored layout (see <A HREF="node7.html#fn:ioncore.deflayout"><TT>ioncore.deflayout</TT></A>) named by
     If the region specified by <TT>target</TT> winprop does not exist
     (or that winprop is not set), create a new workspace using the 
     previously stored layout (see <A HREF="node7.html#fn:ioncore.deflayout"><TT>ioncore.deflayout</TT></A>) named by


@@ -1015,12 +1015,28 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1458"></A>
+<DD><A NAME="1465"></A>

     Discard this winprop after first use.
 
 </DD>
 </DL>
 
     Discard this winprop after first use.
 
 </DD>
 </DL>
 

+<P>
+
+  <DL>
+<DT><STRONG>Winprop:</STRONG></DT>
+<DD><TT>orientation</TT> (string)
+      
+</DD>
+<DT><STRONG>Description:</STRONG></DT>
+<DD><A NAME="1466"></A>
+    The orientation of the window: one of `<TT>vertical</TT>' or
+    `<TT>horizontal</TT>'. This is only useful when using the
+    window as a status display.
+
+</DD>
+</DL>
+

 <P>
 
   <DL>
 <P>
 
   <DL>


@@ -1029,7 +1045,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1459"></A>
+<DD><A NAME="1467"></A>

     Put the window in the statusbar, in the named tray component,
     (The default tray component is called simply `<TT>systray</TT>', 
     and others you give names to in your custom template, always 
     Put the window in the statusbar, in the named tray component,
     (The default tray component is called simply `<TT>systray</TT>', 
     and others you give names to in your custom template, always 


@@ -1046,7 +1062,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1460"></A>
+<DD><A NAME="1468"></A>

     Should a newly mapped client window be switched to within
     its frame.
 
     Should a newly mapped client window be switched to within
     its frame.
 


@@ -1061,7 +1077,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1461"></A>
+<DD><A NAME="1469"></A>

     The name of an object (workspace, frame) that should manage 
     windows of this type. See also <TT>new_group</TT>.
 
     The name of an object (workspace, frame) that should manage 
     windows of this type. See also <TT>new_group</TT>.
 


@@ -1076,7 +1092,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1462"></A>
+<DD><A NAME="1470"></A>

     `<TT>normal</TT>': No change in behaviour. `<TT>current</TT>':
     The window should be thought of as a transient for the current
     active client window (if any) even if it is not marked as a
     `<TT>normal</TT>': No change in behaviour. `<TT>current</TT>':
     The window should be thought of as a transient for the current
     active client window (if any) even if it is not marked as a


@@ -1095,7 +1111,7 @@ usual method of identifying windows, and how to obtain this information.
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
       
 </DD>
 <DT><STRONG>Description:</STRONG></DT>

-<DD><A NAME="1463"></A>
+<DD><A NAME="1471"></A>

     Should frames be made transparent when this window is selected? 
 <BR>  
   
     Should frames be made transparent when this window is selected? 
 <BR>  
   


@@ -1110,15 +1126,15 @@ usual method of identifying windows, and how to obtain this information.
 
 <P>
 Additionally, the winprops 
 
 <P>
 Additionally, the winprops 

-<TT>max_size</TT><A NAME="1464"></A>,
-<TT>min_size</TT><A NAME="1465"></A>,
-<TT>aspect</TT><A NAME="1466"></A>,
-<TT>resizeinc</TT><A NAME="1467"></A>,
+<TT>max_size</TT><A NAME="1472"></A>,
+<TT>min_size</TT><A NAME="1473"></A>,
+<TT>aspect</TT><A NAME="1474"></A>,
+<TT>resizeinc</TT><A NAME="1475"></A>,

 and
 and

-<TT>ignore_max_size</TT><A NAME="1468"></A>,
-<TT>ignore_min_size</TT><A NAME="1469"></A>,
-<TT>ignore_aspect</TT><A NAME="1470"></A>,
-<TT>ignore_resizeinc</TT><A NAME="1471"></A>,
+<TT>ignore_max_size</TT><A NAME="1476"></A>,
+<TT>ignore_min_size</TT><A NAME="1477"></A>,
+<TT>ignore_aspect</TT><A NAME="1478"></A>,
+<TT>ignore_resizeinc</TT><A NAME="1479"></A>,

 may be used to override application-supplied size hints. The four
 first ones are tables with the fields <TT>w</TT> and <TT>h</TT>, indicating
 the width and height size hints in pixels, and the latter ignore
 may be used to override application-supplied size hints. The four
 first ones are tables with the fields <TT>w</TT> and <TT>h</TT>, indicating
 the width and height size hints in pixels, and the latter ignore


@@ -1126,7 +1142,7 @@ winprop is a boolean.
 
 <P>
 Finally, the boolean
 
 <P>
 Finally, the boolean

-<TT>userpos</TT><A NAME="1472"></A> option may be used to
+<TT>userpos</TT><A NAME="1480"></A> option may be used to

 override the <TT>USPosition</TT> flag of the size hints. Normally,
 when this flag is set, Ion tries to respect the supplied window
 position more than when it is not set. Obviously, this makes sense
 override the <TT>USPosition</TT> flag of the size hints. Normally,
 when this flag is set, Ion tries to respect the supplied window
 position more than when it is not set. Obviously, this makes sense


@@ -1142,12 +1158,12 @@ only for floating windows.
 
 <P>
 The identification information supported are
 
 <P>
 The identification information supported are

-<TT>class</TT><A NAME="1473"></A>,
-<TT>role</TT><A NAME="1474"></A>,
-<TT>instance</TT><A NAME="1475"></A>,
-<TT>name</TT><A NAME="1476"></A>,
-<TT>is_transient</TT><A NAME="1477"></A>, and
-<TT>is_dockapp</TT><A NAME="1478"></A>.
+<TT>class</TT><A NAME="1481"></A>,
+<TT>role</TT><A NAME="1482"></A>,
+<TT>instance</TT><A NAME="1483"></A>,
+<TT>name</TT><A NAME="1484"></A>,
+<TT>is_transient</TT><A NAME="1485"></A>, and
+<TT>is_dockapp</TT><A NAME="1486"></A>.

 It is not necessary to specify all of these fields.
 The first three are strings, and must exactly match the
 corresponding information obtained from the window's properties.
 It is not necessary to specify all of these fields.
 The first three are strings, and must exactly match the
 corresponding information obtained from the window's properties.


@@ -1235,7 +1251,7 @@ can be used to list the identification information required to set winprops
 for a window and all the transient windows managed within it. 
 
 <P>
 for a window and all the transient windows managed within it. 
 
 <P>

-<A NAME="1428"></A> 
+<A NAME="1435"></A> 

 Another way to get the identification information is to use <TT>xprop</TT>.
 Simply run To get class and instance, simply run <TT>xprop WM_CLASS</TT>
 and click on the particular window of interest. The class is the latter of
 Another way to get the identification information is to use <TT>xprop</TT>.
 Simply run To get class and instance, simply run <TT>xprop WM_CLASS</TT>
 and click on the particular window of interest. The class is the latter of


@@ -1244,7 +1260,7 @@ windows have this property - use the command <TT>xprop WM_ROLE</TT>.
 This method, however, will not work on transients. 
 
 <P>
 This method, however, will not work on transients. 
 
 <P>

-<A NAME="1432"></A>
+<A NAME="1439"></A>

 So-called ``transient windows'' are usually short-lived dialogs (although
 some programs abuse this property) that have a parent window that they are
 ``transient for''. On tiled workspaces Ion displays these windows 
 So-called ``transient windows'' are usually short-lived dialogs (although
 some programs abuse this property) that have a parent window that they are
 ``transient for''. On tiled workspaces Ion displays these windows 


@@ -1253,7 +1269,7 @@ Unfortunately <TT>xprop</TT> is stupid and can't cope with this situation,
 returning the parent window's properties when the transient is clicked on.
 For this reason you'll have to do a little extra work to get the properties
 for that window.<A NAME="tex2html9"
 returning the parent window's properties when the transient is clicked on.
 For this reason you'll have to do a little extra work to get the properties
 for that window.<A NAME="tex2html9"

-  HREF="#foot1480"><SUP><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN></SUP></A>
+  HREF="#foot1488"><SUP><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN></SUP></A>

 <P>
 Finally, it should be mentioned that too many authors these days
 ``forget'' to set this vital identification to anything meaningful:
 <P>
 Finally, it should be mentioned that too many authors these days
 ``forget'' to set this vital identification to anything meaningful:


@@ -1503,7 +1519,7 @@ for the additional mailboxes (`<TT>*</TT>' varying).
 gotten rid of in the author's opinion.
 
 </DD>
 gotten rid of in the author's opinion.
 
 </DD>

-<DT><A NAME="foot1480">... window.</A><A
+<DT><A NAME="foot1488">... window.</A><A

  HREF="node4.html#tex2html9"><SUP><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN></SUP></A></DT>
 <DD>There's a patch to <TT>xprop</TT> to
 fix this, but nothing seems to be happening with respect to including it in 
  HREF="node4.html#tex2html9"><SUP><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN></SUP></A></DT>
 <DD>There's a patch to <TT>xprop</TT> to
 fix this, but nothing seems to be happening with respect to including it in