update from Han, new licensed, complete and correct version from the original author

author: fluxgen <fluxgen> 2004-05-07 16:25:46 (GMT)
committer: fluxgen <fluxgen> 2004-05-07 16:25:46 (GMT)
commit: d29d4dc370146127788ce3b02f56080f6de63a51 (patch)
tree: 8dad142b3ad54d4d7651bf8816f017bec1438605
parent: d95fcc2dbba7fdf3884452bd69c352c87ae1e57b (diff)
download: fluxbox_paul-d29d4dc370146127788ce3b02f56080f6de63a51.zip
fluxbox_paul-d29d4dc370146127788ce3b02f56080f6de63a51.tar.bz2
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 @@
+.\" $Id: fbsetbg.1,v 1.2 2004/05/07 16:25:46 fluxgen Exp $
 .\"
-.\" Man page for fbsetbg
+.\" Copyright (c) 2004, Han Boetes <han@fluxbox.org>
 .\"
-.\" Copyright (c) 2004 by Bastian Kleineidam <reflexionsniveau@web.de>
+.\" Permission to use, copy, modify, and distribute this documentation for
+.\" any purpose with or without fee is hereby granted, provided that the
+.\" above copyright notice and this permission notice appear in all copies.
 .\"
-.TH FBSETBG 1 "16 December 2003"
+.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-.SH NAME
+.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
-fbsetbg \- set the background wallpaper for fluxbox
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-.SH SYNOPSIS
+.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-\fBfbsetbg\fP [\fIoptions\fP]... \fIimage\fP
+.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-.br
+.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-\fBfbsetbg\fP \fB-l\fP
+.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-.SH DESCRIPTION
+.\" PERFORMANCE OF THIS DOCUMENTATION
-\fBfbsetbg\fP 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
+.Dd May  4, 2004
+.Dt FBSETBG 1
+.Os
+.Sh NAME
+.Nm fbsetbg
+.Nd "set a background/wallpaper"
+.Sh SYNOPSIS
+.Nm fbsetbg
+.Bk -words
+.Op Fl fctaFCTA Ar wallpaper
+.Op Fl uU Ar wallpapersetter
+.Op Fl bB Ar bsetrootoptions ...
+.Op Fl rR Ar path
+.Op Fl l
+.Ek
+.Sh DESCRIPTION
+.Nm
+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 provides clear error messages in a window that make debugging
+.Pp
-problems a lot easier.
+Furthermore it supports remembering the last set wallpaper so you don't
-.SH OPTIONS
+have to edit the style or init-file to change the wallpaper.
-.TP
+.Pp
-\fB-f\fP
+It aims to provide clear error messages in a window that make debugging
+problems easy.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl f Ar file
 Set fullscreen wallpaper.
-.TP
+.It Fl c Ar file
-\fB-c\fP
 Set centered wallpaper.
-.TP
+.It Fl t Ar file
-\fB-t\fP
 Set tiled wallpaper.
-.TP
+.It Fl a Ar file
-\fB-a\fP
 Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
-support this we fall back to \fB-f\fP).
+support this option fbsetbg falls back to
-.TP
+.Fl f
-\fB-u\fP
+).
+.It Fl u Ar wallpapersetter
 Use specified wallpapersetter, use no argument to forget.
-.TP
+.It Fl b Ar bsetrootoptions
-\fB-b\fP
 Forward the options to bsetroot.
-.TP
+.It Fl r Ar directory
-\fB-F\fP,\fB-C\fP,\fB-T\fP,\fB-A\fP,\fB-U\fP,\fB-B\fP
+Set random wallpaper from a directory.
-same as uncapsed but without remembering.
+.It Fl F , C , T , A , U , B , R
-.TP
+Same as the uncapsed option but without remembering.
-\fB-h\fP
+.It Fl l
-Display this help.
+Set previous wallpaper. Or, if the random feature was last used, set
-.TP
+another random wallpaper from the same directory.
-\fB-l\fP
+.It Fl i
-Set previous wallpaper.
+Display usefull information about best wallpapersetter found.
-.TP
+.It Fl p
-\fB-i\fP
+Display some usefull tips.
-Information about selected wallpaper command.
+.It Fl h
-.TP
+Display a help message.
-\fB-d\fP
+.El
-Debug info (deprecated, use \fB-i\fP).
+.Sh FILES
-.TP
+.Bl -tag -width "~/.fluxbox/lastwallpaper" -compact
-\fB-p\fP
+.It Pa ~/.fluxbox/lastwallpaper
-Tips.
+In this file the wallpaper you set will be stored, for the
-.SH FILES
+.Fl l
-.TP
-\fB$HOME/.fluxbox/lastwallpaper\fP
-In this file the wallpaper you set will be stored, for the \fB-l\fP
 option.
-.SH ENVIRONMENT
+.El
-.TP
+.Sh ENVIRONMENT VARIABLES
-\fBwpsetters\fP
+.Pp fbsetbg supports the following environmental variables:
+.Ar wpsetters
 Wallpapersetters to use.
-.TP
+.Pp
-\fBDISPLAY\fP
+.Ar DISPLAY
 The display you want to set the wallpaper on.
-.SH EXAMPLES
+.El
-  \fBwpsetters=feh fbsetbg wallpaper.jpg\fP
+.Sh EXAMPLES
-  \fBDISPLAY=:0.0 fbsetbg -l\fP
+.Pp
-.SH AUTHOR
+To use
-This manpage was originally written by Bastian Kleineidam
+.Ar feh
-<calvin@debian.org> for the Debian distribution of fluxbox
+as wallpapersetter and set
-(but may be used by others).
+.Ar wallpapper.jpg
+from the current directory as wallpaper.
-The main author of fluxbox is Henrik Kinnunen <fluxgen@fluxbox.org>.
+.Bd -literal -offset indent
+$ wpsetters=feh fbsetbg wallpaper.jpg
+.Ed
+.Pp
+Recall the last set wallpaper on display
+.Ar :0.0
+with the stored options.
+.Bd -literal -offset indent
+$ DISPLAY=:0.0 fbsetbg -l
+.Ed
+.El
+.Sh SEE ALSO
+.Xr bsetroot 1 ,
+.Xr fluxbox 1
+.El
+.Sh ONLINE DOCUMENTATION:
+Much more extensive documentation for
+.Nm
+is provided on:
+http://www.xs4all.nl/~hanb/software/fluxbox/fbsetbg.html
+.El
+.Sh BUGS
+.Nm
+is not foolproof.
+.El
+.Sh AUTHOR
+The author of fbsetbg is Han Boetes <han@fluxbox.org>
author	fluxgen <fluxgen>	2004-05-07 16:25:46 (GMT)
committer	fluxgen <fluxgen>	2004-05-07 16:25:46 (GMT)
commit	d29d4dc370146127788ce3b02f56080f6de63a51 (patch)
tree	8dad142b3ad54d4d7651bf8816f017bec1438605
parent	d95fcc2dbba7fdf3884452bd69c352c87ae1e57b (diff)
download	fluxbox_paul-d29d4dc370146127788ce3b02f56080f6de63a51.zip fluxbox_paul-d29d4dc370146127788ce3b02f56080f6de63a51.tar.bz2

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
8	fbsetbg \- 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	.\"
15	app 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
		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
16	configure fbsetbg. It just uses the first app it can find.	37	configure fbsetbg. It just uses the first app it can find.
17	Furthermore it provides clear error messages in a window that make debugging	38	.Pp
18	problems a lot easier.	39	Furthermore it supports remembering the last set wallpaper so you don't
19	.SH OPTIONS	40	have to edit the style or init-file to change the wallpaper.
20	.TP	41	.Pp
21	\fB-f\fP	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
22	Set fullscreen wallpaper.	47	Set fullscreen wallpaper.
23	.TP	48	.It Fl c Ar file
24	\fB-c\fP
25	Set centered wallpaper.	49	Set centered wallpaper.
26	.TP	50	.It Fl t Ar file
27	\fB-t\fP
28	Set tiled wallpaper.	51	Set tiled wallpaper.
29	.TP	52	.It Fl a Ar file
30	\fB-a\fP
31	Set maximized wallpaper, preserving aspect (if your bgsetter doesn't	53	Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
32	support this we fall back to \fB-f\fP).	54	support this option fbsetbg falls back to
33	.TP	55	.Fl f
34	\fB-u\fP	56	).
		57	.It Fl u Ar wallpapersetter
35	Use specified wallpapersetter, use no argument to forget.	58	Use specified wallpapersetter, use no argument to forget.
36	.TP	59	.It Fl b Ar bsetrootoptions
37	\fB-b\fP
38	Forward the options to bsetroot.	60	Forward 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	62	Set random wallpaper from a directory.
41	same as uncapsed but without remembering.	63	.It Fl F , C , T , A , U , B , R
42	.TP	64	Same as the uncapsed option but without remembering.
43	\fB-h\fP	65	.It Fl l
44	Display this help.	66	Set previous wallpaper. Or, if the random feature was last used, set
45	.TP	67	another random wallpaper from the same directory.
46	\fB-l\fP	68	.It Fl i
47	Set previous wallpaper.	69	Display usefull information about best wallpapersetter found.
48	.TP	70	.It Fl p
49	\fB-i\fP	71	Display some usefull tips.
50	Information about selected wallpaper command.	72	.It Fl h
51	.TP	73	Display a help message.
52	\fB-d\fP	74	.El
53	Debug 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
56	Tips.	78	In 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
60	In this file the wallpaper you set will be stored, for the \fB-l\fP
61	option.	80	option.
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
65	Wallpapersetters to use.	85	Wallpapersetters to use.
66	.TP	86	.Pp
67	\fBDISPLAY\fP	87	.Ar DISPLAY
68	The display you want to set the wallpaper on.	88	The 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	92	To use
73	This manpage was originally written by Bastian Kleineidam	93	.Ar feh
74	<calvin@debian.org> for the Debian distribution of fluxbox	94	as wallpapersetter and set
75	(but may be used by others).	95	.Ar wallpapper.jpg
76		96	from the current directory as wallpaper.
77	The 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
		101	Recall the last set wallpaper on display
		102	.Ar :0.0
		103	with 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:
		113	Much more extensive documentation for
		114	.Nm
		115	is provided on:
		116	http://www.xs4all.nl/~hanb/software/fluxbox/fbsetbg.html
		117	.El
		118	.Sh BUGS
		119	.Nm
		120	is not foolproof.
		121	.El
		122	.Sh AUTHOR
		123	The author of fbsetbg is Han Boetes <han@fluxbox.org>