aboutsummaryrefslogtreecommitdiff
path: root/doc/fbsetbg.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fbsetbg.1')
-rw-r--r--doc/fbsetbg.1174
1 files changed, 110 insertions, 64 deletions
diff --git a/doc/fbsetbg.1 b/doc/fbsetbg.1
index 04ebdcc..13c9d7e 100644
--- a/doc/fbsetbg.1
+++ b/doc/fbsetbg.1
@@ -1,77 +1,123 @@
1.\" $Id: fbsetbg.1,v 1.2 2004/05/07 16:25:46 fluxgen Exp $
1.\" 2.\"
2.\" Man page for fbsetbg 3.\" Copyright (c) 2004, Han Boetes <han@fluxbox.org>
3.\" 4.\"
4.\" Copyright (c) 2004 by Bastian Kleineidam <reflexionsniveau@web.de> 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.
5.\" 8.\"
6.TH FBSETBG 1 "16 December 2003" 9.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
7.SH NAME 10.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
8fbsetbg \- set the background wallpaper for fluxbox 11.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
9.SH SYNOPSIS 12.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
10\fBfbsetbg\fP [\fIoptions\fP]... \fIimage\fP 13.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
11.br 14.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
12\fBfbsetbg\fP \fB-l\fP 15.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
13.SH DESCRIPTION 16.\" PERFORMANCE OF THIS DOCUMENTATION
14\fBfbsetbg\fP is a wrapper that tries to find a suitable background-setting 17.\"
15app and then tries to set the wallpaper using that app. You don't have to 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
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
16configure fbsetbg. It just uses the first app it can find. 37configure fbsetbg. It just uses the first app it can find.
17Furthermore it provides clear error messages in a window that make debugging 38.Pp
18problems a lot easier. 39Furthermore it supports remembering the last set wallpaper so you don't
19.SH OPTIONS 40have to edit the style or init-file to change the wallpaper.
20.TP 41.Pp
21\fB-f\fP 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
22Set fullscreen wallpaper. 47Set fullscreen wallpaper.
23.TP 48.It Fl c Ar file
24\fB-c\fP
25Set centered wallpaper. 49Set centered wallpaper.
26.TP 50.It Fl t Ar file
27\fB-t\fP
28Set tiled wallpaper. 51Set tiled wallpaper.
29.TP 52.It Fl a Ar file
30\fB-a\fP
31Set maximized wallpaper, preserving aspect (if your bgsetter doesn't 53Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
32support this we fall back to \fB-f\fP). 54support this option fbsetbg falls back to
33.TP 55.Fl f
34\fB-u\fP 56).
57.It Fl u Ar wallpapersetter
35Use specified wallpapersetter, use no argument to forget. 58Use specified wallpapersetter, use no argument to forget.
36.TP 59.It Fl b Ar bsetrootoptions
37\fB-b\fP
38Forward the options to bsetroot. 60Forward the options to bsetroot.
39.TP 61.It Fl r Ar directory
40\fB-F\fP,\fB-C\fP,\fB-T\fP,\fB-A\fP,\fB-U\fP,\fB-B\fP 62Set random wallpaper from a directory.
41same as uncapsed but without remembering. 63.It Fl F , C , T , A , U , B , R
42.TP 64Same as the uncapsed option but without remembering.
43\fB-h\fP 65.It Fl l
44Display this help. 66Set previous wallpaper. Or, if the random feature was last used, set
45.TP 67another random wallpaper from the same directory.
46\fB-l\fP 68.It Fl i
47Set previous wallpaper. 69Display usefull information about best wallpapersetter found.
48.TP 70.It Fl p
49\fB-i\fP 71Display some usefull tips.
50Information about selected wallpaper command. 72.It Fl h
51.TP 73Display a help message.
52\fB-d\fP 74.El
53Debug info (deprecated, use \fB-i\fP). 75.Sh FILES
54.TP 76.Bl -tag -width "~/.fluxbox/lastwallpaper" -compact
55\fB-p\fP 77.It Pa ~/.fluxbox/lastwallpaper
56Tips. 78In this file the wallpaper you set will be stored, for the
57.SH FILES 79.Fl l
58.TP
59\fB$HOME/.fluxbox/lastwallpaper\fP
60In this file the wallpaper you set will be stored, for the \fB-l\fP
61option. 80option.
62.SH ENVIRONMENT 81.El
63.TP 82.Sh ENVIRONMENT VARIABLES
64\fBwpsetters\fP 83.Pp fbsetbg supports the following environmental variables:
84.Ar wpsetters
65Wallpapersetters to use. 85Wallpapersetters to use.
66.TP 86.Pp
67\fBDISPLAY\fP 87.Ar DISPLAY
68The display you want to set the wallpaper on. 88The display you want to set the wallpaper on.
69.SH EXAMPLES 89.El
70 \fBwpsetters=feh fbsetbg wallpaper.jpg\fP 90.Sh EXAMPLES
71 \fBDISPLAY=:0.0 fbsetbg -l\fP 91.Pp
72.SH AUTHOR 92To use
73This manpage was originally written by Bastian Kleineidam 93.Ar feh
74<calvin@debian.org> for the Debian distribution of fluxbox 94as wallpapersetter and set
75(but may be used by others). 95.Ar wallpapper.jpg
76 96from the current directory as wallpaper.
77The main author of fluxbox is Henrik Kinnunen <fluxgen@fluxbox.org>. 97.Bd -literal -offset indent
98$ wpsetters=feh fbsetbg wallpaper.jpg
99.Ed
100.Pp
101Recall the last set wallpaper on display
102.Ar :0.0
103with the stored options.
104.Bd -literal -offset indent
105$ DISPLAY=:0.0 fbsetbg -l
106.Ed
107.El
108.Sh SEE ALSO
109.Xr bsetroot 1 ,
110.Xr fluxbox 1
111.El
112.Sh ONLINE DOCUMENTATION:
113Much more extensive documentation for
114.Nm
115is provided on:
116http://www.xs4all.nl/~hanb/software/fluxbox/fbsetbg.html
117.El
118.Sh BUGS
119.Nm
120is not foolproof.
121.El
122.Sh AUTHOR
123The author of fbsetbg is Han Boetes <han@fluxbox.org>