aboutsummaryrefslogtreecommitdiff
path: root/doc/fbsetbg.1.in
diff options
context:
space:
mode:
authorJim Ramsay <i.am@jimramsay.com>2009-02-18 16:36:04 (GMT)
committerJim Ramsay <i.am@jimramsay.com>2009-05-26 20:16:07 (GMT)
commit4b4fa5bdeb1b987e621fb964c3da7a90a241d2d8 (patch)
tree86602f1483d282b7130d6a593a9411ba3ef6c9ef /doc/fbsetbg.1.in
parent0ac042c1ce65cf65ef965f8fc6be80f8a44a9d4b (diff)
downloadfluxbox_pavel-4b4fa5bdeb1b987e621fb964c3da7a90a241d2d8.zip
fluxbox_pavel-4b4fa5bdeb1b987e621fb964c3da7a90a241d2d8.tar.bz2
Moved fbsetbg(1) to asciidoc format
Diffstat (limited to 'doc/fbsetbg.1.in')
-rw-r--r--doc/fbsetbg.1.in333
1 files changed, 333 insertions, 0 deletions
diff --git a/doc/fbsetbg.1.in b/doc/fbsetbg.1.in
new file mode 100644
index 0000000..45505a8
--- /dev/null
+++ b/doc/fbsetbg.1.in
@@ -0,0 +1,333 @@
1.\" Title: fbsetbg
2.\" Author: [see the "AUTHORS" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 02/18/2009
5.\" Manual: Fluxbox Manual
6.\" Source: fbsetbg.txt 1.1.2
7.\" Language: English
8.\"
9.TH "FBSETBG" "1" "02/18/2009" "fbsetbg\&.txt 1\&.1\&.2" "Fluxbox Manual"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170fbsetbg \- Set a background wallpaper or pattern
171.SH "Synopsis"
172.sp
173\fBfbsetbg\fR [\fB\-uU\fR \fIwallpapersetter\fR] [\fB\-fFcCtTaA\fR] \fIwallpaper\fR
174.sp
175\fBfbsetbg\fR [\fB\-uU\fR \fIwallpapersetter\fR] \fB\-rR\fR \fIpath\fR
176.sp
177\fBfbsetbg\fR \fB\-bB\fR \fIfbsetrootoptions\&...\fR
178.sp
179\fBfbsetbg\fR [\-\fBl\fR|\fBh\fR|\fBi\fR|\fBp\fR]
180.SH "DESCRIPTION"
181.sp
182\fBfbsetbg(1)\fR 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\&.
183.sp
184Furthermore it supports remembering the last set wallpaper so you don\'t have to edit the style or init\-file to change the wallpaper\&.
185.sp
186It aims to provide clear error messages in a window that make debugging problems easy\&.
187.SH "OPTIONS"
188.PP
189\fB\-f\fR \fIfile\fR
190.RS 4
191Set fullscreen wallpaper\&.
192.RE
193.PP
194\fB\-c\fR \fIfile\fR
195.RS 4
196Set centered wallpaper\&.
197.RE
198.PP
199\fB\-t\fR \fIfile\fR
200.RS 4
201Set tiled wallpaper\&.
202.RE
203.PP
204\fB\-a\fR \fIfile\fR
205.RS 4
206Set maximized wallpaper, preserving aspect (if your bgsetter doesn\'t support this option fbsetbg falls back to
207\fB\-f\fR)\&.
208.RE
209.PP
210\fB\-u\fR \fIwallpapersetter\fR
211.RS 4
212Use specified wallpapersetter, use no argument to forget\&.
213.RE
214.PP
215\fB\-b\fR \fIfbsetrootoptions\fR
216.RS 4
217Forward the options to fbsetroot\&.
218.RE
219.PP
220\fB\-r\fR \fIdirectory\fR
221.RS 4
222Set random wallpaper from a directory\&.
223.RE
224.PP
225\fB\-F\fR, \fB\-C\fR, \fB\-T\fR, \fB\-A\fR, \fB\-U\fR, \fB\-B\fR, \fB\-R\fR
226.RS 4
227Same as the lowercase option but without remembering\&.
228.RE
229.PP
230\fB\-l\fR
231.RS 4
232Set previous wallpaper\&. Or, if the random feature was last used, set another random wallpaper from the same directory\&.
233.RE
234.PP
235\fB\-i\fR
236.RS 4
237Display usefull information about best wallpapersetter found\&.
238.RE
239.PP
240\fB\-p\fR
241.RS 4
242Display some usefull tips\&.
243.RE
244.PP
245\fB\-h\fR
246.RS 4
247Display a help message\&.
248.RE
249.SH "FILES"
250.PP
251\fB~/\&.fluxbox/lastwallpaper\fR
252.RS 4
253In this file the wallpaper you set will be stored, for the
254\fB\-l\fR
255option\&.
256.RE
257.SH "ENVIRONMENT"
258.PP
259\fBwpsetters\fR
260.RS 4
261Wallpapersetters to use\&. This can be a space\-delimited list of the applications to try, or just a single name\&.
262.RE
263.PP
264\fBDISPLAY\fR
265.RS 4
266The display you want to set the wallpaper on\&.
267.RE
268.SH "EXAMPLES"
269.sp
270To use \fBfeh(1)\fR as wallpapersetter and set \fBwallpapper\&.jpg\fR from the current directory as wallpaper\&.
271.sp
272.if n \{\
273.RS 4
274.\}
275.fam C
276.ps -1
277.nf
278.BB lightgray
279$ wpsetters=feh fbsetbg wallpaper\&.jpg
280.EB lightgray
281.fi
282.fam
283.ps +1
284.if n \{\
285.RE
286.\}
287.sp
288Recall the last set wallpaper on display \fB:0\&.0\fR with the stored options\&.
289.sp
290.if n \{\
291.RS 4
292.\}
293.fam C
294.ps -1
295.nf
296.BB lightgray
297$ DISPLAY=:0\&.0 fbsetbg \-l
298.EB lightgray
299.fi
300.fam
301.ps +1
302.if n \{\
303.RE
304.\}
305.SH "SEE ALSO"
306.sp
307fluxbox(1), fbsetroot(1)
308.SH "ONLINE DOCUMENTATION"
309.PP
310Much more extensive documentation for \fBfbsetbg(1)\fR is provided on:
311.RS 4
312
313\m[blue]\fBhttp://www\&.xs4all\&.nl/~hanb/software/fbsetbg/fbsetbg\&.html\fR\m[]
314.RE
315.SH "BUGS"
316.sp
317\fBfbsetbg(1)\fR is not foolproof\&.
318.SH "AUTHORS"
319.sp
320The author of fbsetbg is Han Boetes <\m[blue]\fBhan@fluxbox\&.org\fR\m[]\&\s-2\u[1]\d\s+2>
321.sp
322This manpage was updated to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
323.SH "Notes"
324.IP " 1." 4
325han@fluxbox.org
326.RS 4
327\%mailto:han@fluxbox.org
328.RE
329.IP " 2." 4
330i.am@jimramsay.com
331.RS 4
332\%mailto:i.am@jimramsay.com
333.RE