blob: 3c31b6169fd5cfc808d55faf9be8238bee687e6a [file] [log] [blame]
rscba19f6b2004-04-19 15:51:52 +00001.TH RIO 1
2.SH NAME
3rio \- rio-like Window Manager for X
4.SH SYNOPSIS
5.B rio
6[
rscba19f6b2004-04-19 15:51:52 +00007.B \-font
rsc058b0112005-01-03 06:40:20 +00008.I fontname
9]
10[
11.B \-grey
12]
13[
14.B \-s
15]
16[
rscba19f6b2004-04-19 15:51:52 +000017.B \-term
18.I termprog
rsc058b0112005-01-03 06:40:20 +000019]
20[
21.B \-version
22]
23[
24.B \-virtuals
25.I num
26]
27[
28.B exit
29|
30.B restart
rscba19f6b2004-04-19 15:51:52 +000031]
Russ Coxad8d5422008-01-31 21:15:43 -050032.PP
33.B xshove
34[
35.I name
36.I rectangle
37]
rscba19f6b2004-04-19 15:51:52 +000038.SH DESCRIPTION
rsc058b0112005-01-03 06:40:20 +000039.if t .ds 85 8\(12
40.if n .ds 85 8-1/2
rscba19f6b2004-04-19 15:51:52 +000041.I Rio
42is a window manager for X which attempts to emulate the window management
43policies of Plan 9's
44.I rio
45window manager.
rsc6a0171e2005-01-14 22:13:05 +000046Rio is derived from David Hogan's 9wm.
rscba19f6b2004-04-19 15:51:52 +000047.PP
48The
49.B \-grey
rsc058b0112005-01-03 06:40:20 +000050option makes the background stippled grey, the default X11 background,
51instead of solid grey, the Plan 9 background.
52.PP
53The
rscba19f6b2004-04-19 15:51:52 +000054.B \-font
rsc058b0112005-01-03 06:40:20 +000055option
rscba19f6b2004-04-19 15:51:52 +000056sets the font in
57.IR rio 's
58menu to
59.IR fname ,
60overriding the default.
rsc058b0112005-01-03 06:40:20 +000061Unlike the other programs in the Plan 9 ports, rio expects this
62font to be an X11 font rather than a Plan 9 font.
63.PP
64The
rscba19f6b2004-04-19 15:51:52 +000065.B \-term
rsc058b0112005-01-03 06:40:20 +000066option
rscba19f6b2004-04-19 15:51:52 +000067specifies an alternative program to run when the
68.I New
69menu item is selected.
rsc058b0112005-01-03 06:40:20 +000070The default is to try
71.IR 9term (1)
72and then to fall back to
73.IR xterm (1).
74The
75.B \-s
76option causes
77.I rio
78to add
79.B -s
80to
81.IR 9term 's
82command-line, starting the window in scrolling mode.
83.PP
84The
rscba19f6b2004-04-19 15:51:52 +000085.B \-version
rsc058b0112005-01-03 06:40:20 +000086option
rscba19f6b2004-04-19 15:51:52 +000087prints the current version on standard error, then exits.
88.PP
rsc058b0112005-01-03 06:40:20 +000089The
90.B \-virtuals
91option sets the number of virtual screens (the default is 1,
92and the maximum is 12).
93.PP
94If the argument
95.B exit
96or
97.B restart
98is given,
99it is sent to an already-running
100.IR rio ,
101causing the extant
rscba19f6b2004-04-19 15:51:52 +0000102.I rio
rsc058b0112005-01-03 06:40:20 +0000103to exit or restart.
104.SS Using rio
rscba19f6b2004-04-19 15:51:52 +0000105.PP
106One window is
107.IR current ,
108and is indicated with a dark border and text;
109characters typed on the keyboard are available in the
110.B /dev/cons
111file of the process in the current window.
112Characters written on
113.B /dev/cons
114appear asynchronously in the associated window whether or not the window
115is current.
116.PP
117Windows are created, deleted and rearranged using the mouse.
118Clicking (pressing and releasing) mouse button 1 in a non-current
119window makes that window current and brings it in front of
120any windows that happen to be overlapping it.
121When the mouse cursor points to the background area or is in
122a window that has not claimed the mouse for its own use,
123pressing mouse button 3 activates a
124menu of window operations provided by
125.IR rio .
126Releasing button 3 then selects an operation.
127At this point, a gunsight or cross cursor indicates that
128an operation is pending.
129The button 3 menu operations are:
130.TF Resize
131.TP
132.B New
133Create a window.
134Press button 3 where one corner of the new rectangle should
135appear (cross cursor), and move the mouse, while holding down button 3, to the
136diagonally opposite corner.
137Releasing button 3 creates the window, and makes it current.
138Very small windows may not be created.
139The new window is created running
140.IR termprog ,
141by default
142.IR 9term (1)
143or, if
144.I 9term
145is not available,
146.IR xterm (1).
147.TP
148.B Resize
149Change the size and location of a window.
150First click button 3 in the window to be changed
151(gunsight cursor).
152Then sweep out a window as for the
153.B New
154operation.
155The window is made current.
156.TP
157.B Move
158Move a window to another location.
159After pressing and holding button 3 over the window to be moved (gunsight cursor),
160indicate the new position by dragging the rectangle to the new location.
161The window is made current.
162Windows may be moved partially off-screen.
163.TP
164.B Delete
165Delete a window. Click in the window to be deleted (gunsight cursor).
166Deleting a window causes a
167.L hangup
168note to be sent to all processes in the window's process group
169(see
170.IR notify (3)).
171.TP
172.B Hide
173Hide a window. Click in the window to be hidden (gunsight cursor);
174it will be moved off-screen.
175Each hidden window is given a menu entry in the button 3 menu
176according to its current window system label.
177.TP
178.I label
179Restore a hidden window.
180.PD
181.PP
182Windows may also be arranged by dragging their borders.
183Pressing button 1 or 2 over a window's border allows one to
184move the corresponding edge or corner, while button 3
185moves the whole window.
rsc058b0112005-01-03 06:40:20 +0000186.PP
187When the mouse cursor points to the background area
188and
189.I rio
190has been started with multiple virtual screens using the
191.B \-virtuals
192option,
193clicking button 2 brings up a menu to select a virtual screen to view.
194Scrolling the mouse wheel while the cursor points at the background
195will cycle through the virtual screens.
Russ Coxad8d5422008-01-31 21:15:43 -0500196.PP
197.I Xshove
198moves or resizes every window whose X11 class or instance strings contain
199.IR name .
200The
201.I rectangle
202argument can be
203\fIwidth\^\^\fLx\fI\^\^height\fR,
204\fIwidth\^\^\fLx\fI\^\^height\^\^\fL@\fI\^\^xmin\fL,\fIxmax\fR,
205\fL'\fIxmin ymin xmax ymax\fL'\fR,
206\fRor
207\fIxmin\fL,\fIymin\fL,\fIxmax\fL,\fIymax\fR.
208A leading
209.B +
210or
211.B -
212causes the rectangle to be interpreted as a delta:
213.L +10,0
214nudges a window to the right, while
215.L +100x100
216grows a window.
217With no arguments,
218.I xshove
219lists all the current X windows.
220.I Xshove
221is not specific to
222.I rio
223and can be used with other window managers.
rscba19f6b2004-04-19 15:51:52 +0000224.SH BUGS
225In
226Plan 9's
227.IR rio ,
228clicking button 2 or button 3 to select a window also sends that
229event to the window itself. This
230.I rio
231does not.
232.PP
233The command-line syntax is non-standard.
234.PP
235In Plan 9's
236.IR rio ,
237newly started applications take over the current window.
238This
239.I rio
240starts a new window for each program.
241(In X11, it appears to be impossible to know which window
242starts a particular program.)
243.PP
244There is a currently a compiled-in limit of 128 hidden windows.
245.SH "SEE ALSO"
246.IR 9term (1),
rsc058b0112005-01-03 06:40:20 +0000247.IR xterm (1)
rsc6a0171e2005-01-14 22:13:05 +0000248.PP
249As mentioned above,
250.I rio
251is mainly maintenance updates
252applied to the original
253.I 9wm
254by David Hogan; see
255.HR http://unauthorised.org/dhog/9wm.html "" .