From 6968c5927b968ab187796b2cc40e4fd052397a18 Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Sun, 13 May 2007 22:05:36 +0000 Subject: [PATCH] add the generated from docbook man pages, for people who don't have docbook-to-man --- doc/openbox-gnome-session.1 | 19 +++++++++++ doc/openbox-kde-session.1 | 19 +++++++++++ doc/openbox.1.in | 80 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 doc/openbox-gnome-session.1 create mode 100644 doc/openbox-kde-session.1 create mode 100644 doc/openbox.1.in diff --git a/doc/openbox-gnome-session.1 b/doc/openbox-gnome-session.1 new file mode 100644 index 0000000..b5f775e --- /dev/null +++ b/doc/openbox-gnome-session.1 @@ -0,0 +1,19 @@ +.TH "OPENBOX" "1" +.SH "NAME" +openbox-gnome-session \(em Run a GNOME session with Openbox as the window manager + +.SH "DESCRIPTION" +.PP +\fBopenbox-gnome-session\fR runs a GNOME session with +Openbox as the window manager. +.SH "SEE ALSO" +.PP +openbox(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, Sun 13 May 2007, 18:05 diff --git a/doc/openbox-kde-session.1 b/doc/openbox-kde-session.1 new file mode 100644 index 0000000..45d5c21 --- /dev/null +++ b/doc/openbox-kde-session.1 @@ -0,0 +1,19 @@ +.TH "OPENBOX" "1" +.SH "NAME" +openbox-kde-session \(em Run a KDE session with Openbox as the window manager + +.SH "DESCRIPTION" +.PP +\fBopenbox-kde-session\fR runs a KDE session with +Openbox as the window manager. +.SH "SEE ALSO" +.PP +openbox(1), openbox-gnome-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, Sun 13 May 2007, 18:05 diff --git a/doc/openbox.1.in b/doc/openbox.1.in new file mode 100644 index 0000000..a4b6d6f --- /dev/null +++ b/doc/openbox.1.in @@ -0,0 +1,80 @@ +.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\-\-config \fITYPE\fR\fP] [\fB\-\-sync\fP] [\fB\-\-debug\fP] [\fB\-\-debug-focus\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 withing 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 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. The default +configuration file is 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 it's configuration. +.IP "\fB\-\-sm-disable\fP" 10 +Do not connect to the session manager. +.IP "\fB\-\-config\fITYPE\fR\fP" 10 +Specify the configuration profile to use. +.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. +.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, Sun 13 May 2007, 18:06 -- 1.9.1