| 1 |
.\" Copyright 1988, 1998 The Open Group |
| 2 |
.\" |
| 3 |
.\" Permission to use, copy, modify, distribute, and sell this software and its |
| 4 |
.\" documentation for any purpose is hereby granted without fee, provided that |
| 5 |
.\" the above copyright notice appear in all copies and that both that |
| 6 |
.\" copyright notice and this permission notice appear in supporting |
| 7 |
.\" documentation. |
| 8 |
.\" |
| 9 |
.\" The above copyright notice and this permission notice shall be included |
| 10 |
.\" in all copies or substantial portions of the Software. |
| 11 |
.\" |
| 12 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 13 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 14 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 15 |
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 16 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 17 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 18 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 19 |
.\" |
| 20 |
.\" Except as contained in this notice, the name of The Open Group shall |
| 21 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 22 |
.\" other dealings in this Software without prior written authorization |
| 23 |
.\" from The Open Group. |
| 24 |
.\" |
| 25 |
.TH XSETROOT 1 "xsetroot 1.1.3" "X Version 11" |
| 26 |
.SH NAME |
| 27 |
xsetroot \- root window parameter setting utility for X |
| 28 |
.SH SYNOPSIS |
| 29 |
.B xsetroot |
| 30 |
[-help] |
| 31 |
[-version] |
| 32 |
[-def] |
| 33 |
[-display \fIdisplay\fP] |
| 34 |
[-cursor \fIcursorfile maskfile\fP] |
| 35 |
[-cursor_name \fIcursorfontname\fP] |
| 36 |
[-xcf \fIcursorfile\fP \fIcursorsize\fP] |
| 37 |
[-bitmap \fIfilename\fP |
| 38 |
| -mod \fIx y\fP |
| 39 |
| -gray |
| 40 |
| -grey |
| 41 |
| -solid \fIcolor\fP] |
| 42 |
[-bg \fIcolor\fP] |
| 43 |
[-fg \fIcolor\fP] |
| 44 |
[-rv] |
| 45 |
[-name \fIstring\fP] |
| 46 |
[-d \fIdisplay\fP] |
| 47 |
.SH DESCRIPTION |
| 48 |
The |
| 49 |
.I xsetroot |
| 50 |
program |
| 51 |
allows you to tailor the appearance of the background ("root") |
| 52 |
window on a workstation display running X. Normally, you experiment with |
| 53 |
.I xsetroot |
| 54 |
until you find a personalized look that you like, then put the |
| 55 |
.I xsetroot |
| 56 |
command that produces it into your X startup file. |
| 57 |
If no options are specified, or if |
| 58 |
.I -def |
| 59 |
is specified, the window is reset to its default state. The |
| 60 |
.I -def |
| 61 |
option can be specified along with other options and only the non-specified |
| 62 |
characteristics will be reset to the default state. |
| 63 |
.PP |
| 64 |
Only one of the background color/tiling changing options |
| 65 |
(-solid, -gray, -grey, -bitmap, and -mod) may be specified at a time. |
| 66 |
.SH OPTIONS |
| 67 |
.PP |
| 68 |
The various options are as follows: |
| 69 |
.IP "\fB-help\fP" |
| 70 |
Print a usage message and exit. |
| 71 |
.IP "\fB-version\fP" |
| 72 |
Print a version message and exit. |
| 73 |
.IP "\fB-def, -default\fP" |
| 74 |
Reset unspecified attributes to the default values. (Restores the background |
| 75 |
to the familiar gray mesh and the cursor to the hollow x shape.) |
| 76 |
.IP "\fB-cursor\fP \fIcursorfile\fP \fImaskfile\fP" |
| 77 |
This lets you change the pointer cursor to whatever |
| 78 |
you want when the pointer cursor is outside of any window. |
| 79 |
Cursor and mask files are bitmaps (little pictures), and can be made with the |
| 80 |
.I bitmap(1) |
| 81 |
program. You probably want the mask file to be all black until you |
| 82 |
get used to the way masks work. |
| 83 |
.IP "\fB-cursor_name\fP \fIcursorfontname\fP" |
| 84 |
This lets you change the pointer cursor to one of the standard |
| 85 |
cursors from the cursor font. Refer to appendix B of the X protocol for |
| 86 |
the names (except that the XC_ prefix is elided for this option). |
| 87 |
.IP "\fB-xcf\fP \fIcursorfile\fP \fIcursorsize\fP" |
| 88 |
This lets you change the pointer cursor to one loaded from an Xcursor file |
| 89 |
as defined by libXcursor, at the specified size. |
| 90 |
.IP "\fB-bitmap\fP \fIfilename\fP" |
| 91 |
Use the bitmap specified in the file to set the window pattern. You can |
| 92 |
make your own bitmap files (little pictures) using the |
| 93 |
.I bitmap(1) |
| 94 |
program. The entire background will be made up of repeated "tiles" of |
| 95 |
the bitmap. |
| 96 |
.IP "\fB-mod\fP \fIx\fP \fIy\fP" |
| 97 |
This is used if you want a plaid-like grid pattern on your screen. |
| 98 |
x and y are integers ranging from 1 to 16. Try the different combinations. |
| 99 |
Zero and negative numbers are taken as 1. |
| 100 |
.IP "\fB-gray, -grey\fP" |
| 101 |
Make the entire background gray (Easier on the eyes). |
| 102 |
.IP "\fB-bg, -background\fP \fIcolor\fP" |
| 103 |
Use ``color'' as the background color. |
| 104 |
.IP "\fB-fg, -foreground\fP \fIcolor\fP" |
| 105 |
Use ``color'' as the foreground color. Foreground and background colors |
| 106 |
are meaningful only in combination with -cursor, -bitmap, or -mod. |
| 107 |
.IP "\fB-rv, -reverse\fP" |
| 108 |
This exchanges the foreground and background colors. Normally the foreground |
| 109 |
color is black and the background color is white. |
| 110 |
.IP "\fB-solid\fP \fIcolor\fP" |
| 111 |
This sets the background of the root window to the specified color. This |
| 112 |
option is only useful on color servers. |
| 113 |
.IP "\fB-name\fP \fIstring\fP" |
| 114 |
Set the name of the root window to ``string''. There is no default value. |
| 115 |
Usually a name is assigned to a window so that the |
| 116 |
window manager can use a text representation when the window is iconified. |
| 117 |
This option is unused since you can't iconify the background. |
| 118 |
.IP "\fB-d, -display\fP \fIdisplay\fP" |
| 119 |
Specifies the server to connect to; see \fIX(7)\fP. |
| 120 |
.SH "SEE ALSO" |
| 121 |
X(7), xset(1), xrdb(1), Xcursor(3) |
| 122 |
.SH AUTHOR |
| 123 |
Mark Lillibridge, MIT Project Athena |