~ubuntu-branches/ubuntu/trusty/fluxbox/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/fbsetbg.1

  • Committer: Bazaar Package Importer
  • Author(s): Dmitry E. Oboukhov
  • Date: 2008-07-01 10:38:14 UTC
  • mfrom: (2.1.12 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080701103814-khx2b6il152x9p93
Tags: 1.0.0+deb1-8
* x-dev has been removed from build-depends (out-of-date package).
* Standards-Version bumped to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" $Id: fbsetbg.1 3700 2004-11-19 11:37:27Z mathias $
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 bsetrootoptions ...
30
 
.Op Fl rR Ar path
31
 
.Op Fl l
32
 
.Ek
33
 
.Sh DESCRIPTION
34
 
.Nm
35
 
is a wrapper that tries to find a suitable background-setting app and
36
 
then tries to set the wallpaper using that app. You don't have to
37
 
configure fbsetbg. It just uses the first app it can find.
38
 
.Pp
39
 
Furthermore it supports remembering the last set wallpaper so you don't
40
 
have to edit the style or init-file to change the wallpaper.
41
 
.Pp
42
 
It aims to provide clear error messages in a window that make debugging
43
 
problems easy.
44
 
.Sh OPTIONS
45
 
.Bl -tag -width Ds
46
 
.It Fl f Ar file
47
 
Set fullscreen wallpaper.
48
 
.It Fl c Ar file
49
 
Set centered wallpaper.
50
 
.It Fl t Ar file
51
 
Set tiled wallpaper.
52
 
.It Fl a Ar file
53
 
Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
54
 
support this option fbsetbg falls back to
55
 
.Fl f
56
 
).
57
 
.It Fl u Ar wallpapersetter
58
 
Use specified wallpapersetter, use no argument to forget.
59
 
.It Fl b Ar bsetrootoptions
60
 
Forward the options to bsetroot.
61
 
.It Fl r Ar directory
62
 
Set random wallpaper from a directory.
63
 
.It Fl F , C , T , A , U , B , R
64
 
Same as the uncapsed option but without remembering.
65
 
.It Fl l
66
 
Set previous wallpaper. Or, if the random feature was last used, set
67
 
another random wallpaper from the same directory.
68
 
.It Fl i
69
 
Display usefull information about best wallpapersetter found.
70
 
.It Fl p
71
 
Display some usefull tips.
72
 
.It Fl h
73
 
Display a help message.
74
 
.El
75
 
.Sh FILES
76
 
.Bl -tag -width "~/.fluxbox/lastwallpaper" -compact
77
 
.It Pa ~/.fluxbox/lastwallpaper
78
 
.El
79
 
In this file the wallpaper you set will be stored, for the
80
 
.Fl l
81
 
option.
82
 
.Sh ENVIRONMENT VARIABLES
83
 
.Pp fbsetbg supports the following environmental variables:
84
 
.Ar wpsetters
85
 
Wallpapersetters to use.
86
 
.Pp
87
 
.Ar DISPLAY
88
 
The display you want to set the wallpaper on.
89
 
.Sh EXAMPLES
90
 
.Pp
91
 
To use
92
 
.Ar feh
93
 
as wallpapersetter and set
94
 
.Ar wallpapper.jpg
95
 
from the current directory as wallpaper.
96
 
.Bd -literal -offset indent
97
 
$ wpsetters=feh fbsetbg wallpaper.jpg
98
 
.Ed
99
 
.Pp
100
 
Recall the last set wallpaper on display
101
 
.Ar :0.0
102
 
with the stored options.
103
 
.Bd -literal -offset indent
104
 
$ DISPLAY=:0.0 fbsetbg -l
105
 
.Ed
106
 
.Sh SEE ALSO
107
 
.Xr bsetroot 1 ,
108
 
.Xr fluxbox 1
109
 
.Sh ONLINE DOCUMENTATION:
110
 
Much more extensive documentation for
111
 
.Nm
112
 
is provided on:
113
 
http://www.xs4all.nl/~hanb/software/fluxbox/fbsetbg.html
114
 
.Sh BUGS
115
 
.Nm
116
 
is not foolproof.
117
 
.Sh AUTHOR
118
 
The author of fbsetbg is Han Boetes <han@fluxbox.org>