Help:Configuration

From Openbox

(Difference between revisions)
Jump to: navigation, search
(Add <desktops> section)
(Add <resize> and an explanation of coordinates)
Line 108: Line 108:
 
'''popupTime''' Time (in milliseconds) to show the popup when switching desktops. Can be set to 0 to disable the popup completely.<br>
 
'''popupTime''' Time (in milliseconds) to show the popup when switching desktops. Can be set to 0 to disable the popup completely.<br>
 
'''names''' Each '''name''' tag names your desktops, in ascending order. Unnamed desktops will be named automatically depending on the locale. You can name more desktops than specified in ''number'' if you want.
 
'''names''' Each '''name''' tag names your desktops, in ascending order. Unnamed desktops will be named automatically depending on the locale. You can name more desktops than specified in ''number'' if you want.
 +
 +
== Resize (and move) ==
 +
<pre>
 +
<resize>
 +
  <drawContents>no</drawContents>
 +
  <popupShow>Always</popupShow>
 +
  <popupPosition>Fixed</popupPosition>
 +
  <popupFixedposition>
 +
    <x>400</x>
 +
    <y>center</y>
 +
  </popupFixedPosition>
 +
</resize>
 +
</pre>
 +
'''drawContents''' Resize the program inside the window while resizing. When disabled the unused space will be filled with a uniform color during a resize.<br>
 +
'''popupShow''' When to show the move/resize popup. ''Always'' always shows it, ''Never'' never shows it, ''Nonpixel'' shows it only when resizing windows that have specified they are resized in increments larger than one pixel, usually terminals.<br>
 +
'''popupPosition''' Where to show the popup.
 +
* ''Top'' shows the popup above the titlebar of the window.
 +
* ''Center'' shows it centered on the window.
 +
* ''Fixed'' shows it in a fixed location on the screen specified by ''popupFixedPosition''.
 +
'''popupFixedPosition''' Specifies where on the screen to show the position when ''Fixed''. Both ''x'' and ''y'' take coordinates as described [[#Coordinates|here]].
 +
 +
== Coordinates ==
 +
Many places in openbox that take a coordinate supports a slightly extended format. Most simply it can be just a number such as ''300''. Such a coordinate will be left- or top-aligned depending on which coordinate it is. To align to the opposite edge, use ''-300''. To specify a negative offset, a ''-'' is also used, so you have to use ''+-10'' to offset 10 pixels negatively to the left/top and ''--10'' for the right/bottom edge. Some things enforce being onscreen though, such as the move/resize popup.

Revision as of 13:36, 19 August 2010

Openbox configuration is made essentially by modifying just one file called rc.xml. Default configuration file can by default be found in /etc/xdg/openbox/ and a user specific file can be placed in ~/.config/openbox/. By default there is also menu.xml which is for menu configuration. Menu configuration is separated from rest of the configs. rc.xml is separated into different sections. All the options are discussed below with examples (unfinished).


Contents

Resistance

<resistance>
  <strength>10</strength>
  <screen_edge_strength>20</screen_edge_strength>
</resistance>

strength Tells Openbox how much resistance (in pixels) there is between two windows before it lets them overlap.
screen_edge_strength Basically the same as strength but between window and the screen edge.

Focus

<focus>
  <focusNew>yes</focusNew>
  <focusLast>yes</focusLast>
  <followMouse>no</followMouse>
  <focusDelay>200</focusDelay>
  <raiseOnFocus>no</raiseOnFocus>
</focus>

focusNew Openbox will automatically give focus to new windows when they are created, otherwise the focus will stay as it is.
followMouse Makes focus follow mouse. e.g. when the mouse is being moved the focus will be given to window under the mouse cursor.
focusLast When switching desktops, focus the last focused window on that desktop again, regardless of where the mouse is. Only applies followMouse is set.
focusDelay The time (in milliseconds) Openbox will wait before giving focus to the window under mouse cursor. Only applies if followMouse is set.
underMouse Focus windows under the mouse not only when the mouse moves, but also when it enters another window due to other reasons (e.g. the window the mouse was in moved/closed/iconified etc). Only applies if followMouse is set.
raiseOnFocus Also raises windows to top when they are focused. Only applies if followMouse is set.

Placement

<placement>
  <policy>Smart</policy>
</placement>

policy can be either Smart or UnderMouse.

  • Smart will cause new windows to be placed automatically by Openbox.
  • UnderMouse makes new windows to be placed under the mouse cursor.

Theme

<theme>
  <name>Clearlooks</name>
  <titleLayout>NLIMC</titleLayout>
  <keepBorder>yes</keepBorder>
  <animateIconify>yes</animateIconify>
  <font place="ActiveWindow">
    <name>sans</name>
    <size>8</size>
    <weight>bold</weight>
    <slant>normal</slant>
  </font>
  <font place="InactiveWindow">
    <name>sans</name>
    <size>8</size>
    <weight>bold</weight>
    <slant>normal</slant>
  </font>
  <font place="MenuHeader">
    <name>sans</name>
    <size>9</size>
    <weight>normal</weight>
    <slant>normal</slant>
  </font>
  <font place="MenuItem">
    <name>sans</name>
    <size>9</size>
    <weight>normal</weight>
    <slant>normal</slant>
  </font>
  <font place="OnScreenDisplay">
    <name>sans</name>
    <size>9</size>
    <weight>bold</weight>
    <slant>normal</slant>
  </font>
</theme>

name The name of the Openbox theme to use.

titleLayout tells in which order and what buttons should be in a window's titlebar. The following letters can be used, each only once.
(thumbnail)
titleLayout example using <titleLayout>MSLDNI</titleLayout>
(thumbnail)
another titleLayout example using <titleLayout>CLIM</titleLayout>
  • N :window icon
  • L :window label (aka. title)
  • I: iconify
  • M: maximize
  • C: close
  • S: shade (roll up/down)
  • D: omnipresent (on all desktops).

keepBorder tells if windows should keep the border drawn by Openbox when window decorations are turned off.
animateIconify adds a little iconification animation if enabled.

Desktops

<desktops>
  <number>4</number>
  <firstdesk>1</firstdesk>
  <popupTime>1000</popupTime>
  <names>
    <name>work</name>
    <name>play</name>
    <name>dull</name>
    <name>boy</name>
  </names>
</desktops>

number The number of virtual desktops to use.
firstdesk The number of the desktop to use when first started.
popupTime Time (in milliseconds) to show the popup when switching desktops. Can be set to 0 to disable the popup completely.
names Each name tag names your desktops, in ascending order. Unnamed desktops will be named automatically depending on the locale. You can name more desktops than specified in number if you want.

Resize (and move)

<resize>
  <drawContents>no</drawContents>
  <popupShow>Always</popupShow>
  <popupPosition>Fixed</popupPosition>
  <popupFixedposition>
    <x>400</x>
    <y>center</y>
  </popupFixedPosition>
</resize>

drawContents Resize the program inside the window while resizing. When disabled the unused space will be filled with a uniform color during a resize.
popupShow When to show the move/resize popup. Always always shows it, Never never shows it, Nonpixel shows it only when resizing windows that have specified they are resized in increments larger than one pixel, usually terminals.
popupPosition Where to show the popup.

  • Top shows the popup above the titlebar of the window.
  • Center shows it centered on the window.
  • Fixed shows it in a fixed location on the screen specified by popupFixedPosition.

popupFixedPosition Specifies where on the screen to show the position when Fixed. Both x and y take coordinates as described here.

Coordinates

Many places in openbox that take a coordinate supports a slightly extended format. Most simply it can be just a number such as 300. Such a coordinate will be left- or top-aligned depending on which coordinate it is. To align to the opposite edge, use -300. To specify a negative offset, a - is also used, so you have to use +-10 to offset 10 pixels negatively to the left/top and --10 for the right/bottom edge. Some things enforce being onscreen though, such as the move/resize popup.

Personal tools