summaryrefslogtreecommitdiff
path: root/doc/asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc')
-rw-r--r--doc/asciidoc/Makefile2
-rw-r--r--doc/asciidoc/fbsetbg.txt117
2 files changed, 118 insertions, 1 deletions
diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile
index 70db7ef..e169230 100644
--- a/doc/asciidoc/Makefile
+++ b/doc/asciidoc/Makefile
@@ -2,7 +2,7 @@
2# create manpages from the asciidoc files 2# create manpages from the asciidoc files
3# 3#
4 4
5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt 5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt
6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt 6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt
7 7
8MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) 8MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in)
diff --git a/doc/asciidoc/fbsetbg.txt b/doc/asciidoc/fbsetbg.txt
new file mode 100644
index 0000000..03626b2
--- /dev/null
+++ b/doc/asciidoc/fbsetbg.txt
@@ -0,0 +1,117 @@
1fbsetbg(1)
2==========
3Jim Ramsay <i.am@jimramsay.com>
4v1.1.2, 18 February 2009
5:man source: fbsetbg.txt
6:man version: {revision}
7:man manual: Fluxbox Manual
8
9NAME
10----
11fbsetbg - Set a background wallpaper or pattern
12
13SYNOPSIS
14--------
15*fbsetbg* [*-uU* 'wallpapersetter'] [*-fFcCtTaA*] 'wallpaper'
16
17*fbsetbg* [*-uU* 'wallpapersetter'] *-rR* 'path'
18
19*fbsetbg* *-bB* 'fbsetrootoptions...'
20
21*fbsetbg* [-*l*|*h*|*i*|*p*]
22
23DESCRIPTION
24-----------
25*fbsetbg(1)* is a wrapper that tries to find a suitable background-setting app
26and then tries to set the wallpaper using that app. You don't have to configure
27fbsetbg. It just uses the first app it can find.
28
29Furthermore it supports remembering the last set wallpaper so you don't have to
30edit the style or init-file to change the wallpaper.
31
32It aims to provide clear error messages in a window that make debugging problems
33easy.
34
35OPTIONS
36-------
37*-f* 'file'::
38Set fullscreen wallpaper.
39
40*-c* 'file'::
41Set centered wallpaper.
42
43*-t* 'file'::
44Set tiled wallpaper.
45
46*-a* 'file'::
47Set maximized wallpaper, preserving aspect (if your bgsetter
48doesn't support this option fbsetbg falls back to *-f*).
49
50*-u* 'wallpapersetter'::
51Use specified wallpapersetter, use no argument to forget.
52
53*-b* 'fbsetrootoptions'::
54Forward the options to fbsetroot.
55
56*-r* 'directory'::
57Set random wallpaper from a directory.
58
59*-F*, *-C*, *-T*, *-A*, *-U*, *-B*, *-R*::
60Same as the lowercase option but without remembering.
61
62*-l*::
63Set previous wallpaper. Or, if the random feature was last used,
64set another random wallpaper from the same directory.
65
66*-i*::
67Display usefull information about best wallpapersetter found.
68
69*-p*::
70Display some usefull tips.
71
72*-h*::
73Display a help message.
74
75FILES
76-----
77*~/.fluxbox/lastwallpaper*::
78In this file the wallpaper you set will be stored, for the *-l* option.
79
80ENVIRONMENT
81-----------
82*wpsetters*::
83Wallpapersetters to use. This can be a space-delimited list of the applications
84to try, or just a single name.
85
86*DISPLAY*::
87The display you want to set the wallpaper on.
88
89EXAMPLES
90--------
91To use *feh(1)* as wallpapersetter and set *wallpapper.jpg* from the current
92directory as wallpaper.
93
94 $ wpsetters=feh fbsetbg wallpaper.jpg
95
96Recall the last set wallpaper on display *:0.0* with the stored options.
97
98 $ DISPLAY=:0.0 fbsetbg -l
99
100SEE ALSO
101--------
102fluxbox(1), fbsetroot(1)
103
104ONLINE DOCUMENTATION
105--------------------
106Much more extensive documentation for *fbsetbg(1)* is provided on:::
107http://www.xs4all.nl/~hanb/software/fbsetbg/fbsetbg.html
108
109BUGS
110----
111*fbsetbg(1)* is not foolproof.
112
113AUTHORS
114-------
115The author of fbsetbg is Han Boetes <han@fluxbox.org>
116
117This manpage was updated to asciidoc format by Jim Ramsay <i.am@jimramsay.com>