<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>Next generation, highly configurable window manager
- </refpurpose>
+ <refpurpose>A minimalistic, highly configurable, next generation window
+ manager with extensive standards support.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<arg><option>--version</option></arg>
<arg><option>--replace</option></arg>
<arg><option>--reconfigure</option></arg>
+ <arg><option>--restart</option></arg>
<arg><option>--sm-disable</option></arg>
<arg><option>--sync</option></arg>
<arg><option>--debug</option></arg>
<refsect1>
<title>DESCRIPTION</title>
- <para>Openbox is a next generation, highly
- configurable window manager. Openbox is compliant with the
- latest window manager standards.</para>
+ <para>Openbox is minimalistic, highly configurable, next generation window
+ manager with extensive standards support.</para>
<para>You can start Openbox in three ways:</para>
within GNOME or KDE, you can choose the appropriate entry, and it will
launch GNOME or KDE with Openbox as the window manager.</para>
- <para>If you don't want to run Openbox within a desktop environment, then
- it is recommended that you instead set up a ~/.xsession file and
- use the <command>Default</command> session type. The ~/.xsession file
- should start any applications you want to run at startup, and then run
- <command>&dhpackage;</command> at the end, such as:</para>
+ <para>The third option at log in, which is <command>Openbox</command>
+ without a session manager, uses the <command>openbox-session</command>
+ command to start Openbox. On log in, <command>&dhpackage;</command> will
+ run the ~/.config/openbox/autostart.sh script if it exists, and will run
+ the system-wide script @configdir@/openbox/autostart.sh otherwise. You
+ may place anything you want to run automatically in those files, for
+ example:
+ </para>
-
<blockquote><literallayout>
+ <blockquote><literallayout>
xsetroot -solid grey &
- gnome-settings-daemon &
- exec <command>&dhpackage;</command></literallayout></blockquote>
+ gnome-settings-daemon &</literallayout></blockquote>
+
+ <para>Make sure that each line is followed by a "&" or else the script will
+ stop there and further commands will not be executed. You can use the
+ @configdir@/openbox/autostart.sh file as an example for creating your
+ own.</para>
+
+ <para>The default @configdir@/openbox/autostart.sh runs a number of things
+ with Openbox.</para>
<para>Lastly, if you use <command>startx</command> to launch your X
- session, you should set up a ~/.xinitrc file, exactly the same as the
- above ~/.xsession file.</para>
+ session, you can set up a ~/.xinitrc file to run
+ <command>openbox-session</command> and follow the same directions as
+ above regarding the autostart.sh file.</para>
<para>You can use the <command>obconf</command> tool to configure Openbox
easily with a graphical interface, however more in-depth configuration
- is possible by editing the configuration files by hand. Please note that
- <command>obconf</command> older than version 2.0 may not work at all
- for you.</para>
+ is possible by editing the configuration files by hand.</para>
- <para>The default configuration files are installed in
- @configdir@/openbox/rc.xml, and the user configuration is placed in
- ~/.config/openbox/rc.xml. You can copy the default configuration
+ <para>The default configuration and menu files are installed in
+ @configdir@/openbox/, and the user configuration is placed in
+ ~/.config/openbox/. You can copy the default configuration and menus
to ~/.config/openbox and edit it to your liking.</para>
</refsect1>
<refsect1>
<varlistentry>
<term><option>--help</option></term>
<listitem>
- <para>Show a summary of the options available.</para>
+ <para>Show a summary of the command line options available
+ and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
- <para>Show the version of the program.</para>
+ <para>Show the version of the program and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--config-file FILE</option></term>
+ <listitem>
+ <para>Specify the path to the config file to use.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--reconfigure</option></term>
<listitem>
<para>If Openbox is already running on the display, tell it to
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--restart</option></term>
+ <listitem>
+ <para>If Openbox is already running on the display, tell it to
+ restart. This is useful if you have upgraded Openbox and don't
+ want to restart X.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--exit</option></term>
+ <listitem>
+ <para>Exit Openbox.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--sm-disable</option></term>
<listitem>
<para>Do not connect to the session manager.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--startup CMD</option></term>
+ <listitem>
+ <para>Run CMD after starting.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>Display debugging output.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--debug-session</option></term>
+ <listitem>
+ <para>Display debugging output for session management.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--debug-xinerama</option></term>
<listitem>
<para>Split the display into two fake xinerama regions, if
<refsect1>
<title>SEE ALSO</title>
- <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
- </para>
+ <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
+ openbox-kde-session(1).</para>
<para>The program's full documentation is available on the website:
<literal>http://openbox.org/</literal></para>
projects / dana / openbox.git / blobdiff