From d29d4dc370146127788ce3b02f56080f6de63a51 Mon Sep 17 00:00:00 2001 From: fluxgen Date: Fri, 7 May 2004 16:25:46 +0000 Subject: update from Han, new licensed, complete and correct version from the original author --- doc/fbsetbg.1 | 174 +++++++++++++++++++++++++++++++++++++--------------------- 1 file 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 .\" -.\" Copyright (c) 2004 by Bastian Kleineidam +.\" 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" -.SH NAME -fbsetbg \- set the background wallpaper for fluxbox -.SH SYNOPSIS -\fBfbsetbg\fP [\fIoptions\fP]... \fIimage\fP -.br -\fBfbsetbg\fP \fB-l\fP -.SH DESCRIPTION -\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 +.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL +.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE +.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL +.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR +.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +.\" PERFORMANCE OF THIS DOCUMENTATION +.\" +.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 -problems a lot easier. -.SH OPTIONS -.TP -\fB-f\fP +.Pp +Furthermore it supports remembering the last set wallpaper so you don't +have to edit the style or init-file to change the wallpaper. +.Pp +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 -\fB-c\fP +.It Fl c Ar file Set centered wallpaper. -.TP -\fB-t\fP +.It Fl t Ar file Set tiled wallpaper. -.TP -\fB-a\fP +.It Fl a Ar file Set maximized wallpaper, preserving aspect (if your bgsetter doesn't -support this we fall back to \fB-f\fP). -.TP -\fB-u\fP +support this option fbsetbg falls back to +.Fl f +). +.It Fl u Ar wallpapersetter Use specified wallpapersetter, use no argument to forget. -.TP -\fB-b\fP +.It Fl b Ar bsetrootoptions Forward the options to bsetroot. -.TP -\fB-F\fP,\fB-C\fP,\fB-T\fP,\fB-A\fP,\fB-U\fP,\fB-B\fP -same as uncapsed but without remembering. -.TP -\fB-h\fP -Display this help. -.TP -\fB-l\fP -Set previous wallpaper. -.TP -\fB-i\fP -Information about selected wallpaper command. -.TP -\fB-d\fP -Debug info (deprecated, use \fB-i\fP). -.TP -\fB-p\fP -Tips. -.SH FILES -.TP -\fB$HOME/.fluxbox/lastwallpaper\fP -In this file the wallpaper you set will be stored, for the \fB-l\fP +.It Fl r Ar directory +Set random wallpaper from a directory. +.It Fl F , C , T , A , U , B , R +Same as the uncapsed option but without remembering. +.It Fl l +Set previous wallpaper. Or, if the random feature was last used, set +another random wallpaper from the same directory. +.It Fl i +Display usefull information about best wallpapersetter found. +.It Fl p +Display some usefull tips. +.It Fl h +Display a help message. +.El +.Sh FILES +.Bl -tag -width "~/.fluxbox/lastwallpaper" -compact +.It Pa ~/.fluxbox/lastwallpaper +In this file the wallpaper you set will be stored, for the +.Fl l option. -.SH ENVIRONMENT -.TP -\fBwpsetters\fP +.El +.Sh ENVIRONMENT VARIABLES +.Pp fbsetbg supports the following environmental variables: +.Ar wpsetters Wallpapersetters to use. -.TP -\fBDISPLAY\fP +.Pp +.Ar DISPLAY The display you want to set the wallpaper on. -.SH EXAMPLES - \fBwpsetters=feh fbsetbg wallpaper.jpg\fP - \fBDISPLAY=:0.0 fbsetbg -l\fP -.SH AUTHOR -This manpage was originally written by Bastian Kleineidam - for the Debian distribution of fluxbox -(but may be used by others). - -The main author of fluxbox is Henrik Kinnunen . +.El +.Sh EXAMPLES +.Pp +To use +.Ar feh +as wallpapersetter and set +.Ar wallpapper.jpg +from the current directory as wallpaper. +.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 -- cgit v0.11.2