summaryrefslogtreecommitdiff
path: root/doc/fbsetbg.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fbsetbg.1')
-rw-r--r--doc/fbsetbg.1118
1 files changed, 0 insertions, 118 deletions
diff --git a/doc/fbsetbg.1 b/doc/fbsetbg.1
deleted file mode 100644
index 2f83282..0000000
--- a/doc/fbsetbg.1
+++ /dev/null
@@ -1,118 +0,0 @@
1.\" $Id$
2.\"
3.\" Copyright (c) 2004, Han Boetes <han@fluxbox.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this documentation for
6.\" any purpose with or without fee is hereby granted, provided that the
7.\" above copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
11.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16.\" PERFORMANCE OF THIS DOCUMENTATION
17.\"
18.Dd May 4, 2004
19.Dt FBSETBG 1
20.Os
21.Sh NAME
22.Nm fbsetbg
23.Nd "set a background/wallpaper"
24.Sh SYNOPSIS
25.Nm fbsetbg
26.Bk -words
27.Op Fl fctaFCTA Ar wallpaper
28.Op Fl uU Ar wallpapersetter
29.Op Fl bB Ar fbsetrootoptions ...
30.Op Fl rR Ar path
31.Op Fl l
32.Ek
33.Sh DESCRIPTION
34.Nm
35is a wrapper that tries to find a suitable background-setting app and
36then tries to set the wallpaper using that app. You don't have to
37configure fbsetbg. It just uses the first app it can find.
38.Pp
39Furthermore it supports remembering the last set wallpaper so you don't
40have to edit the style or init-file to change the wallpaper.
41.Pp
42It aims to provide clear error messages in a window that make debugging
43problems easy.
44.Sh OPTIONS
45.Bl -tag -width Ds
46.It Fl f Ar file
47Set fullscreen wallpaper.
48.It Fl c Ar file
49Set centered wallpaper.
50.It Fl t Ar file
51Set tiled wallpaper.
52.It Fl a Ar file
53Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
54support this option fbsetbg falls back to
55.Fl f
56).
57.It Fl u Ar wallpapersetter
58Use specified wallpapersetter, use no argument to forget.
59.It Fl b Ar fbsetrootoptions
60Forward the options to fbsetroot.
61.It Fl r Ar directory
62Set random wallpaper from a directory.
63.It Fl F , C , T , A , U , B , R
64Same as the uncapsed option but without remembering.
65.It Fl l
66Set previous wallpaper. Or, if the random feature was last used, set
67another random wallpaper from the same directory.
68.It Fl i
69Display usefull information about best wallpapersetter found.
70.It Fl p
71Display some usefull tips.
72.It Fl h
73Display a help message.
74.El
75.Sh FILES
76.Bl -tag -width "~/.fluxbox/lastwallpaper" -compact
77.It Pa ~/.fluxbox/lastwallpaper
78.El
79In this file the wallpaper you set will be stored, for the
80.Fl l
81option.
82.Sh ENVIRONMENT VARIABLES
83.Pp fbsetbg supports the following environmental variables:
84.Ar wpsetters
85Wallpapersetters to use.
86.Pp
87.Ar DISPLAY
88The display you want to set the wallpaper on.
89.Sh EXAMPLES
90.Pp
91To use
92.Ar feh
93as wallpapersetter and set
94.Ar wallpapper.jpg
95from the current directory as wallpaper.
96.Bd -literal -offset indent
97$ wpsetters=feh fbsetbg wallpaper.jpg
98.Ed
99.Pp
100Recall the last set wallpaper on display
101.Ar :0.0
102with the stored options.
103.Bd -literal -offset indent
104$ DISPLAY=:0.0 fbsetbg -l
105.Ed
106.Sh SEE ALSO
107.Xr fbsetroot 1 ,
108.Xr fluxbox 1
109.Sh ONLINE DOCUMENTATION:
110Much more extensive documentation for
111.Nm
112is provided on:
113http://www.xs4all.nl/~hanb/software/fbsetbg/fbsetbg.html
114.Sh BUGS
115.Nm
116is not foolproof.
117.Sh AUTHOR
118The author of fbsetbg is Han Boetes <han@fluxbox.org>