adding .cvsignore files to the repository to clean up the output whenever you commit...
[dana/openbox.git] / doc / bsetroot.1
1 .\"
2 .\" Man page for Bsetroot
3 .\"
4 .\" Copyright (c) 2000 by Wilbert Berendsen <wbsoft@xs4all.nl>
5 .\"
6 .TH bsetroot 1 "June 16th, 2000" "0.60.3"
7 .SH NAME
8 bsetroot \- Openbox utility to change root window appearance
9 .SH SYNOPSIS
10 .BR bsetroot " \-help"
11 .br
12 .B bsetroot
13 .RI "[ \-display " display " ] \-solid " color
14 .br
15 .B bsetroot
16 .RI "[ \-display " display " ] \-mod " "x y" " \-fg " color " \-bg " color
17 .br
18 .B bsetroot
19 .RI "[ \-display " display " ] \-gradient " texture " \-from " color " \-to " color
20 .SH DESCRIPTION
21 Bsetroot is a utility that can control the appearance of the root window in
22 three ways: Either give it a solid color, or write a two color modula pattern
23 to it, or render a gradient texture, based on two different colors.
24 .PP
25 Bsetroot resembles
26 .IR xsetroot (1)
27 in this functionality but it supports multiple screen displays, and gradient
28 textures the same way as Openbox does.
29 It doesn't handle cursors etc.
30 Bsetroot is part of the Openbox package.
31 .SH OPTIONS
32 Bsetroot operates in three ways, you must choose one of the first 3 options:
33 .TP
34 .BI \-solid " color"
35 Sets the root window to specified color.
36 .TP
37 .BI \-mod " x y"
38 Creates a modula pattern. You must specify
39 .BR \-bg " and " \-fg
40 colors.
41 .TP
42 .BI \-gradient " texturestring"
43 Renders the specified texture string to the root window.
44 For possible texture strings, please refer to
45 .IR openbox (1).
46 You must also specify both a
47 .BR \-from " and a " \-to
48 color.
49 .TP
50 .BI \-display " display"
51 Tells Bsetroot to connect to the specified display.
52 .TP
53 .BI "\-bg, \-background " color
54 Background color.
55 Needed for
56 .B \-mod
57 patterns.
58 .TP
59 .BI "\-fg, \-foreground " color
60 Foreground color.
61 Needed for
62 .B \-mod
63 patterns.
64 .TP
65 .BI \-from " color"
66 Start color for rendering textures.
67 Needed for
68 .B \-gradient
69 operation mode.
70 .TP
71 .BI \-to " color"
72 Ending color for rendering textures.
73 Needed for
74 .B \-gradient
75 operation mode.
76 .TP
77 .B \-help
78 Prints version info and short help text.
79 .SH AUTHOR
80 Bsetroot was written and maintained by Brad Hughes
81 .nh \" hyphenation off
82 (blackbox@alug.org)
83 .hy \" on again
84 and Jeff Raven
85 .nh
86 (jraven@psu.edu).
87 .hy
88 .SH SEE ALSO
89 .IR openbox (1)