summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDana Jansens <danakj@orodu.net>2007-05-15 02:02:40 +0000
committerDana Jansens <danakj@orodu.net>2007-05-15 02:02:40 +0000
commitb74cff0302e70d702e958a8205a6f6e2e2858192 (patch)
tree2befabba0b24c6d115636f3a1bc335760cc3fb5a /doc
parent5d85502e3b12ae2301b28d624d7fa60a66f646bb (diff)
changes to the manual pages.
adding openbox-session. add paths to the xsession .desktop files
Diffstat (limited to 'doc')
-rw-r--r--doc/openbox-gnome-session.17
-rw-r--r--doc/openbox-gnome-session.1.sgml5
-rw-r--r--doc/openbox-kde-session.17
-rw-r--r--doc/openbox-kde-session.1.sgml5
-rw-r--r--doc/openbox.1.in85
-rw-r--r--doc/openbox.1.sgml37
6 files changed, 30 insertions, 116 deletions
diff --git a/doc/openbox-gnome-session.1 b/doc/openbox-gnome-session.1
index 1aca9a25..68e29f7b 100644
--- a/doc/openbox-gnome-session.1
+++ b/doc/openbox-gnome-session.1
@@ -6,12 +6,9 @@ openbox-gnome-session \(em Run a GNOME session with Openbox as the window manage
.PP
\fBopenbox-gnome-session\fR runs a GNOME session with
Openbox as the window manager.
-.PP
-When running inside GNOME like this, Openbox will use the
-\fBrc-gnome.xml\fP configuration file.
.SH "SEE ALSO"
.PP
-openbox(1), openbox-kde-session (1).
+openbox(1), openbox-kde-session (1), openbox-session(1).
.PP
The program's full documentation is available on the website:
@@ -19,4 +16,4 @@ The program's full documentation is available on the website:
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Sun 13 May 2007, 19:01
+.\" created by instant / docbook-to-man, Mon 14 May 2007, 21:59
diff --git a/doc/openbox-gnome-session.1.sgml b/doc/openbox-gnome-session.1.sgml
index 702fab70..01236aff 100644
--- a/doc/openbox-gnome-session.1.sgml
+++ b/doc/openbox-gnome-session.1.sgml
@@ -38,14 +38,11 @@ manpage.1: manpage.sgml
<para><command>&dhpackage;</command> runs a GNOME session with
Openbox as the window manager.</para>
-
- <para>When running inside GNOME like this, Openbox will use the
- <literal>rc-gnome.xml</literal> configuration file.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
- <para>openbox(1), openbox-kde-session (1).
+ <para>openbox(1), openbox-kde-session (1), openbox-session(1).
</para>
<para>The program's full documentation is available on the website:
diff --git a/doc/openbox-kde-session.1 b/doc/openbox-kde-session.1
index b76c1bdc..e877cb0f 100644
--- a/doc/openbox-kde-session.1
+++ b/doc/openbox-kde-session.1
@@ -6,12 +6,9 @@ openbox-kde-session \(em Run a KDE session with Openbox as the window manager
.PP
\fBopenbox-kde-session\fR runs a KDE session with
Openbox as the window manager.
-.PP
-When running inside KDE like this, Openbox will use the
-\fBrc-kde.xml\fP configuration file.
.SH "SEE ALSO"
.PP
-openbox(1), openbox-gnome-session (1).
+openbox(1), openbox-gnome-session (1), openbox-session (1).
.PP
The program's full documentation is available on the website:
@@ -19,4 +16,4 @@ The program's full documentation is available on the website:
.PP
Please report bugs to: \fBhttp://bugzilla.icculus.org/
\fP
-.\" created by instant / docbook-to-man, Sun 13 May 2007, 19:01
+.\" created by instant / docbook-to-man, Mon 14 May 2007, 21:59
diff --git a/doc/openbox-kde-session.1.sgml b/doc/openbox-kde-session.1.sgml
index d481ff02..aeb114a4 100644
--- a/doc/openbox-kde-session.1.sgml
+++ b/doc/openbox-kde-session.1.sgml
@@ -38,14 +38,11 @@ manpage.1: manpage.sgml
<para><command>&dhpackage;</command> runs a KDE session with
Openbox as the window manager.</para>
-
- <para>When running inside KDE like this, Openbox will use the
- <literal>rc-kde.xml</literal> configuration file.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
- <para>openbox(1), openbox-gnome-session (1).
+ <para>openbox(1), openbox-gnome-session (1), openbox-session (1).
</para>
<para>The program's full documentation is available on the website:
diff --git a/doc/openbox.1.in b/doc/openbox.1.in
deleted file mode 100644
index 1e6f2feb..00000000
--- a/doc/openbox.1.in
+++ /dev/null
@@ -1,85 +0,0 @@
-.TH "OPENBOX" "1"
-.SH "NAME"
-openbox \(em Next generation, highly configurable window manager
-
-.SH "SYNOPSIS"
-.PP
-\fBopenbox\fR [\fB\-\-help\fP] [\fB\-\-version\fP] [\fB\-\-replace\fP] [\fB\-\-reconfigure\fP] [\fB\-\-sm-disable\fP] [\fB\-\-sync\fP] [\fB\-\-debug\fP] [\fB\-\-debug-focus\fP] [\fB\-\-debug-xinerama\fP]
-.SH "DESCRIPTION"
-.PP
-Openbox is a next generation, highly
-configurable window manager. Openbox is compliant with the
-latest window manager standards.
-.PP
-You can start Openbox in three ways:
-.PP
-If you run a display manager such as GDM, you will find 3 entries
-in the login session type menu for Openbox:
-\fBGNOME/Openbox\fR, \fBKDE/Openbox\fR and \fBOpenbox\fR. If you want to use Openbox
-within GNOME or KDE, you can choose the appropriate entry, and it will
-launch GNOME or KDE with Openbox as the window manager.
-.PP
-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 \fBDefault\fR session type. The ~/.xsession file
-should start any applications you want to run at startup, and then run
-\fBopenbox\fR at the end, such as:
-.PP
-.RS
-.PP
-.nf
-xsetroot \-solid grey &
-gnome-settings-daemon &
-exec \fBopenbox\fR
-.fi
-.RE
-.PP
-Lastly, if you use \fBstartx\fR to launch your X
-session, you should set up a ~/.xinitrc file, exactly the same as the
-above ~/.xsession file.
-.PP
-You can use the \fBobconf\fR 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
-\fBobconf\fR older than version 2.0 may not work at all
-for you.
-.PP
-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
-to ~/.config/openbox and edit it to your liking.
-.SH "OPTIONS"
-.PP
-These are the possible options that \fBopenbox\fR accepts:
-.IP "\fB\-\-help\fP" 10
-Show a summary of the options available.
-.IP "\fB\-\-version\fP" 10
-Show the version of the program.
-.IP "\fB\-\-replace\fP" 10
-Replace the currently running window manager.
-.IP "\fB\-\-reconfigure\fP" 10
-If Openbox is already running on the display, tell it to
-reload its configuration.
-.IP "\fB\-\-sm-disable\fP" 10
-Do not connect to the session manager.
-.IP "\fB\-\-sync\fP" 10
-Run in synchronous mode (for debugging).
-.IP "\fB\-\-debug\fP" 10
-Display debugging output.
-.IP "\fB\-\-debug-focus\fP" 10
-Display debugging output for focus handling.
-.IP "\fB\-\-debug-xinerama\fP" 10
-Split the display into two fake xinerama regions, if
-xinerama is not already enabled. This is for debugging
-xinerama support.
-.SH "SEE ALSO"
-.PP
-obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
-
-.PP
-The program's full documentation is available on the website:
-\fBhttp://openbox.org/\fP
-.PP
-Please report bugs to: \fBhttp://bugzilla.icculus.org/
-\fP
-.\" created by instant / docbook-to-man, Mon 14 May 2007, 17:39
diff --git a/doc/openbox.1.sgml b/doc/openbox.1.sgml
index 1cce5545..70766ba4 100644
--- a/doc/openbox.1.sgml
+++ b/doc/openbox.1.sgml
@@ -63,20 +63,31 @@ manpage.1: manpage.sgml
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
@@ -84,9 +95,9 @@ manpage.1: manpage.sgml
<command>obconf</command> older than version 2.0 may not work at all
for you.</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>