doc/openbox.1.in

   1 .TH "OPENBOX" "1"
   2 .SH "NAME"
   3 openbox \(em Next generation, highly configurable window manager
   4
   5 .SH "SYNOPSIS"
   6 .PP
   7 \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]
   8 .SH "DESCRIPTION"
   9 .PP
  10 Openbox is a next generation, highly
  11 configurable window manager. Openbox is compliant with the
  12 latest window manager standards.
  13 .PP
  14 You can start Openbox in three ways:
  15 .PP
  16 If you run a display manager such as GDM, you will find 3 entries
  17 in the login session type menu for Openbox:
  18 \fBGNOME/Openbox\fR, \fBKDE/Openbox\fR       and \fBOpenbox\fR. If you want to use Openbox
  19 within GNOME or KDE, you can choose the appropriate entry, and it will
  20 launch GNOME or KDE with Openbox as the window manager.
  21 .PP
  22 If you don't want to run Openbox withing a desktop environment, then
  23 it is recommended that you instead set up a ~/.xsession file and
  24 use the \fBDefault\fR session type. The ~/.xsession file
  25 should any applications you want to run at startup, and then run
  26 \fBopenbox\fR at the end, such as:
  27 .PP
  28 .RS
  29 .PP
  30 .nf
  31 xsetroot \-solid grey &
  32 gnome-settings-daemon &
  33 exec \fBopenbox\fR
  34 .fi
  35 .RE
  36 .PP
  37 Lastly, if you use \fBstartx\fR to launch your X
  38 session, you should set up a ~/.xinitrc file, exactly the same as the
  39 above ~/.xsession file.
  40 .PP
  41 You can use the \fBobconf\fR tool to configure Openbox
  42 easily with a graphical interface, however more in-depth configuration
  43 is possible by editing the configuration files by hand. Please note that
  44 \fBobconf\fR older than version 2.0 may not work at all
  45 for you.
  46 .PP
  47 The default configuration files are installed in
  48 configdir@/openbox/, and the user configuration is placed in
  49 ~/.config/openbox/. You can copy the default configuration
  50 to ~/.config/openbox and edit it to your liking.
  51 .PP
  52 There are 3 default configuration files, \fBrc.xml\fP,
  53 \fBrc-gnome.xml\fP, and \fBrc-kde.xml\fP. The
  54 rc-gnome.xml is used when you run
  55 \fBopenbox-gnome-session\fR and the rc-kde.xml is used when
  56 you run \fBopenbox-kde-session\fR. The configuration
  57 files should be named the same in ~/.config/openbox/.
  58 .SH "OPTIONS"
  59 .PP
  60 These are the possible options that \fBopenbox\fR accepts:
  61 .IP "\fB\-\-help\fP" 10
  62 Show a summary of the options available.
  63 .IP "\fB\-\-version\fP" 10
  64 Show the version of the program.
  65 .IP "\fB\-\-replace\fP" 10
  66 Replace the currently running window manager.
  67 .IP "\fB\-\-reconfigure\fP" 10
  68 If Openbox is already running on the display, tell it to
  69 reload it's configuration.
  70 .IP "\fB\-\-sm-disable\fP" 10
  71 Do not connect to the session manager.
  72 .IP "\fB\-\-sync\fP" 10
  73 Run in synchronous mode (for debugging).
  74 .IP "\fB\-\-debug\fP" 10
  75 Display debugging output.
  76 .IP "\fB\-\-debug-focus\fP" 10
  77 Display debugging output for focus handling.
  78 .IP "\fB\-\-debug-xinerama\fP" 10
  79 Split the display into two fake xinerama regions, if
  80 xinerama is not already enabled. This is for debugging
  81 xinerama support.
  82 .SH "SEE ALSO"
  83 .PP
  84 obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
  85
  86 .PP
  87 The program's full documentation is available on the website:
  88 \fBhttp://openbox.org/\fP
  89 .PP
  90 Please report bugs to: \fBhttp://bugzilla.icculus.org/
  91 \fP
  92 .\" created by instant / docbook-to-man, Sun 13 May 2007, 20:34