summaryrefslogtreecommitdiff
path: root/doc/asciidoc/fbsetbg.txt
blob: 03626b2c9b0b6329c0cc560c175c23d15765b5b5 (plain)
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
fbsetbg(1)
==========
Jim Ramsay <i.am@jimramsay.com>
v1.1.2, 18 February 2009
:man source:   fbsetbg.txt
:man version:  {revision}
:man manual:   Fluxbox Manual  

NAME
----
fbsetbg - Set a background wallpaper or pattern

SYNOPSIS
--------
*fbsetbg* [*-uU* 'wallpapersetter'] [*-fFcCtTaA*] 'wallpaper'

*fbsetbg* [*-uU* 'wallpapersetter'] *-rR* 'path'

*fbsetbg* *-bB* 'fbsetrootoptions...'

*fbsetbg* [-*l*|*h*|*i*|*p*]

DESCRIPTION
-----------
*fbsetbg(1)* is a wrapper that tries to find a suitable background-setting app
and then tries to set the wallpaper using that app. You don't have to configure
fbsetbg. It just uses the first app it can find.

Furthermore it supports remembering the last set wallpaper so you don't have to
edit the style or init-file to change the wallpaper.

It aims to provide clear error messages in a window that make debugging problems
easy.

OPTIONS
-------
*-f* 'file'::
Set fullscreen wallpaper.

*-c* 'file'::
Set centered wallpaper.

*-t* 'file'::
Set tiled wallpaper.

*-a* 'file'::
Set maximized wallpaper, preserving aspect (if your bgsetter
doesn't support this option fbsetbg falls back to *-f*).

*-u* 'wallpapersetter'::
Use specified wallpapersetter, use no argument to forget.

*-b* 'fbsetrootoptions'::
Forward the options to fbsetroot.

*-r* 'directory'::
Set random wallpaper from a directory.

*-F*, *-C*, *-T*, *-A*, *-U*, *-B*, *-R*::
Same as the lowercase option but without remembering.

*-l*::
Set previous wallpaper. Or, if the random feature was last used,
set another random wallpaper from the same directory.

*-i*::
Display usefull information about best wallpapersetter found.

*-p*::
Display some usefull tips.

*-h*::
Display a help message.

FILES
-----
*~/.fluxbox/lastwallpaper*::
In this file the wallpaper you set will be stored, for the *-l* option.

ENVIRONMENT
-----------
*wpsetters*::
Wallpapersetters to use. This can be a space-delimited list of the applications
to try, or just a single name.

*DISPLAY*::
The display you want to set the wallpaper on.

EXAMPLES
--------
To use *feh(1)* as wallpapersetter and set *wallpapper.jpg* from the current
directory as wallpaper.

	$ wpsetters=feh fbsetbg wallpaper.jpg

Recall the last set wallpaper on display *:0.0* with the stored options.

	$ DISPLAY=:0.0 fbsetbg -l

SEE ALSO
--------
fluxbox(1), fbsetroot(1)

ONLINE DOCUMENTATION
--------------------
Much more extensive documentation for *fbsetbg(1)* is provided on:::
http://www.xs4all.nl/~hanb/software/fbsetbg/fbsetbg.html

BUGS
----
*fbsetbg(1)* is not foolproof.

AUTHORS
-------
The author of fbsetbg is Han Boetes <han@fluxbox.org>

This manpage was updated to asciidoc format by Jim Ramsay <i.am@jimramsay.com>