/
openbox.1.sgml
204 lines (178 loc) · 6.98 KB
/
openbox.1.sgml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>OPENBOX</refentrytitle>">
<!ENTITY dhpackage "openbox">
]>
<refentry>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>A minimalistic, highly configurable, next generation window
manager with extensive standards support.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>--help</option></arg>
<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>
<arg><option>--debug-focus</option></arg>
<arg><option>--debug-xinerama</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>Openbox is minimalistic, highly configurable, next generation window
manager with extensive standards support.</para>
<para>You can start Openbox in three ways:</para>
<para>If you run a display manager such as GDM, you will find 3 entries
in the login session type menu for Openbox:
<command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
and <command>Openbox</command>. 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.</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>
xsetroot -solid grey &
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 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.</para>
<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>
<title>OPTIONS</title>
<para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Show a summary of the options available.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Show the version of the program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--replace</option></term>
<listitem>
<para>Replace the currently running window manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--reconfigure</option></term>
<listitem>
<para>If Openbox is already running on the display, tell it to
reload its configuration.</para>
</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>--sm-disable</option></term>
<listitem>
<para>Do not connect to the session manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sync</option></term>
<listitem>
<para>Run in synchronous mode (for debugging).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>Display debugging output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug-focus</option></term>
<listitem>
<para>Display debugging output for focus handling.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug-xinerama</option></term>
<listitem>
<para>Split the display into two fake xinerama regions, if
xinerama is not already enabled. This is for debugging
xinerama support.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<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>
<para>Please report bugs to: <literal>http://bugzilla.icculus.org/
</literal></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->