nilix/fluxbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Moved fbsetbg(1) to asciidoc format

Browse source
This commit is contained in:
Jim Ramsay 2009-02-18 11:36:04 -05:00
parent 0ac042c1ce
commit 4b4fa5bdeb
5 changed files with 459 additions and 124 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/Makefile.am
View file

@ -2,12 +2,15 @@
# Makefile.am for fluxbox/doc # Makefile.am for fluxbox/doc
SUBDIRS = ru SUBDIRS = ru
CLEANFILES = fluxbox.1 fbrun.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \
fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5
MAINTAINERCLEANFILES = Makefile.in MAINTAINERCLEANFILES = Makefile.in
man_MANS = fbsetroot.1 fbrun.1 fbsetbg.1 startfluxbox.1 \ man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \
fluxbox.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \
EXTRA_DIST=fbsetroot.1 fbsetbg.1 startfluxbox.1 CODESTYLE \ fbsetroot.1 startfluxbox.1
fluxbox.1.in fbrun.1.in fluxbox-apps.5.in fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in EXTRA_DIST=fbsetroot.1 startfluxbox.1 CODESTYLE \
fluxbox.1.in fbrun.1.in fbsetbg.1.in fluxbox-apps.5.in \
fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in
distclean-local: distclean-local:
rm -f *\~ rm -f *\~

2
doc/asciidoc/Makefile
View file

@ -2,7 +2,7 @@
# create manpages from the asciidoc files # create manpages from the asciidoc files
# #
SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt
SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt
MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in)

117
doc/asciidoc/fbsetbg.txt Normal file
View file

@ -0,0 +1,117 @@
fbsetbg(1)
==========
Jim Ramsay <i.am@jimramsay.com>
v1.1.2, 18 February 2009
:man source: fbsetbg.txt
:man version: {revision}
:man manual: Fluxbox Manual
NAME
----
fbsetbg - Set a background wallpaper or pattern
SYNOPSIS
--------
*fbsetbg* [*-uU* 'wallpapersetter'] [*-fFcCtTaA*] 'wallpaper'
*fbsetbg* [*-uU* 'wallpapersetter'] *-rR* 'path'
*fbsetbg* *-bB* 'fbsetrootoptions...'
*fbsetbg* [-*l*|*h*|*i*|*p*]
DESCRIPTION
-----------
*fbsetbg(1)* 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 supports remembering the last set wallpaper so you don't have to
edit the style or init-file to change the wallpaper.
It aims to provide clear error messages in a window that make debugging problems
easy.
OPTIONS
-------
*-f* 'file'::
Set fullscreen wallpaper.
*-c* 'file'::
Set centered wallpaper.
*-t* 'file'::
Set tiled wallpaper.
*-a* 'file'::
Set maximized wallpaper, preserving aspect (if your bgsetter
doesn't support this option fbsetbg falls back to *-f*).
*-u* 'wallpapersetter'::
Use specified wallpapersetter, use no argument to forget.
*-b* 'fbsetrootoptions'::
Forward the options to fbsetroot.
*-r* 'directory'::
Set random wallpaper from a directory.
*-F*, *-C*, *-T*, *-A*, *-U*, *-B*, *-R*::
Same as the lowercase option but without remembering.
*-l*::
Set previous wallpaper. Or, if the random feature was last used,
set another random wallpaper from the same directory.
*-i*::
Display usefull information about best wallpapersetter found.
*-p*::
Display some usefull tips.
*-h*::
Display a help message.
FILES
-----
*~/.fluxbox/lastwallpaper*::
In this file the wallpaper you set will be stored, for the *-l* option.
ENVIRONMENT
-----------
*wpsetters*::
Wallpapersetters to use. This can be a space-delimited list of the applications
to try, or just a single name.
*DISPLAY*::
The display you want to set the wallpaper on.
EXAMPLES
--------
To use *feh(1)* as wallpapersetter and set *wallpapper.jpg* from the current
directory as wallpaper.
$ wpsetters=feh fbsetbg wallpaper.jpg
Recall the last set wallpaper on display *:0.0* with the stored options.
$ DISPLAY=:0.0 fbsetbg -l
SEE ALSO
--------
fluxbox(1), fbsetroot(1)
ONLINE DOCUMENTATION
--------------------
Much more extensive documentation for *fbsetbg(1)* is provided on:::
http://www.xs4all.nl/~hanb/software/fbsetbg/fbsetbg.html
BUGS
----
*fbsetbg(1)* is not foolproof.
AUTHORS
-------
The author of fbsetbg is Han Boetes <han@fluxbox.org>
This manpage was updated to asciidoc format by Jim Ramsay <i.am@jimramsay.com>

118
doc/fbsetbg.1
View file

@ -1,118 +0,0 @@
.\" $Id$
.\"
.\" Copyright (c) 2004, Han Boetes <han@fluxbox.org>
.\"
.\" 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.
.\"
.\" 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 fbsetrootoptions ...
.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.
.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.
.It Fl c Ar file
Set centered wallpaper.
.It Fl t Ar file
Set tiled wallpaper.
.It Fl a Ar file
Set maximized wallpaper, preserving aspect (if your bgsetter doesn't
support this option fbsetbg falls back to
.Fl f
).
.It Fl u Ar wallpapersetter
Use specified wallpapersetter, use no argument to forget.
.It Fl b Ar fbsetrootoptions
Forward the options to fbsetroot.
.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
.El
In this file the wallpaper you set will be stored, for the
.Fl l
option.
.Sh ENVIRONMENT VARIABLES
.Pp fbsetbg supports the following environmental variables:
.Ar wpsetters
Wallpapersetters to use.
.Pp
.Ar DISPLAY
The display you want to set the wallpaper on.
.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
.Sh SEE ALSO
.Xr fbsetroot 1 ,
.Xr fluxbox 1
.Sh ONLINE DOCUMENTATION:
Much more extensive documentation for
.Nm
is provided on:
http://www.xs4all.nl/~hanb/software/fbsetbg/fbsetbg.html
.Sh BUGS
.Nm
is not foolproof.
.Sh AUTHOR
The author of fbsetbg is Han Boetes <han@fluxbox.org>

333
doc/fbsetbg.1.in Normal file
View file

@ -0,0 +1,333 @@
.\" Title: fbsetbg
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\" Date: 02/18/2009
.\" Manual: Fluxbox Manual
.\" Source: fbsetbg.txt 1.1.2
.\" Language: English
.\"
.TH "FBSETBG" "1" "02/18/2009" "fbsetbg\&.txt 1\&.1\&.2" "Fluxbox Manual"
.\" -----------------------------------------------------------------
.\" * (re)Define some macros
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" toupper - uppercase a string (locale-aware)
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\$*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH-xref - format a cross-reference to an SH section
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH - level-one heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
.\" put an extra blank line of space above the head in non-TTY output
.if t \{\
.sp 1
.\}
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SS - level-two heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BB/BE - put background/screen (filled box) around block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BM/EM - put colored marker in margin next to block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
..
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
fbsetbg \- Set a background wallpaper or pattern
.SH "Synopsis"
.sp
\fBfbsetbg\fR [\fB\-uU\fR \fIwallpapersetter\fR] [\fB\-fFcCtTaA\fR] \fIwallpaper\fR
.sp
\fBfbsetbg\fR [\fB\-uU\fR \fIwallpapersetter\fR] \fB\-rR\fR \fIpath\fR
.sp
\fBfbsetbg\fR \fB\-bB\fR \fIfbsetrootoptions\&...\fR
.sp
\fBfbsetbg\fR [\-\fBl\fR|\fBh\fR|\fBi\fR|\fBp\fR]
.SH "DESCRIPTION"
.sp
\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\&.
.sp
Furthermore it supports remembering the last set wallpaper so you don\'t have to edit the style or init\-file to change the wallpaper\&.
.sp
It aims to provide clear error messages in a window that make debugging problems easy\&.
.SH "OPTIONS"
.PP
\fB\-f\fR \fIfile\fR
.RS 4
Set fullscreen wallpaper\&.
.RE
.PP
\fB\-c\fR \fIfile\fR
.RS 4
Set centered wallpaper\&.
.RE
.PP
\fB\-t\fR \fIfile\fR
.RS 4
Set tiled wallpaper\&.
.RE
.PP
\fB\-a\fR \fIfile\fR
.RS 4
Set maximized wallpaper, preserving aspect (if your bgsetter doesn\'t support this option fbsetbg falls back to
\fB\-f\fR)\&.
.RE
.PP
\fB\-u\fR \fIwallpapersetter\fR
.RS 4
Use specified wallpapersetter, use no argument to forget\&.
.RE
.PP
\fB\-b\fR \fIfbsetrootoptions\fR
.RS 4
Forward the options to fbsetroot\&.
.RE
.PP
\fB\-r\fR \fIdirectory\fR
.RS 4
Set random wallpaper from a directory\&.
.RE
.PP
\fB\-F\fR, \fB\-C\fR, \fB\-T\fR, \fB\-A\fR, \fB\-U\fR, \fB\-B\fR, \fB\-R\fR
.RS 4
Same as the lowercase option but without remembering\&.
.RE
.PP
\fB\-l\fR
.RS 4
Set previous wallpaper\&. Or, if the random feature was last used, set another random wallpaper from the same directory\&.
.RE
.PP
\fB\-i\fR
.RS 4
Display usefull information about best wallpapersetter found\&.
.RE
.PP
\fB\-p\fR
.RS 4
Display some usefull tips\&.
.RE
.PP
\fB\-h\fR
.RS 4
Display a help message\&.
.RE
.SH "FILES"
.PP
\fB~/\&.fluxbox/lastwallpaper\fR
.RS 4
In this file the wallpaper you set will be stored, for the
\fB\-l\fR
option\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBwpsetters\fR
.RS 4
Wallpapersetters to use\&. This can be a space\-delimited list of the applications to try, or just a single name\&.
.RE
.PP
\fBDISPLAY\fR
.RS 4
The display you want to set the wallpaper on\&.
.RE
.SH "EXAMPLES"
.sp
To use \fBfeh(1)\fR as wallpapersetter and set \fBwallpapper\&.jpg\fR from the current directory as wallpaper\&.
.sp
.if n \{\
.RS 4
.\}
.fam C
.ps -1
.nf
.BB lightgray
$ wpsetters=feh fbsetbg wallpaper\&.jpg
.EB lightgray
.fi
.fam
.ps +1
.if n \{\
.RE
.\}
.sp
Recall the last set wallpaper on display \fB:0\&.0\fR with the stored options\&.
.sp
.if n \{\
.RS 4
.\}
.fam C
.ps -1
.nf
.BB lightgray
$ DISPLAY=:0\&.0 fbsetbg \-l
.EB lightgray
.fi
.fam
.ps +1
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
fluxbox(1), fbsetroot(1)
.SH "ONLINE DOCUMENTATION"
.PP
Much more extensive documentation for \fBfbsetbg(1)\fR is provided on:
.RS 4
\m[blue]\fBhttp://www\&.xs4all\&.nl/~hanb/software/fbsetbg/fbsetbg\&.html\fR\m[]
.RE
.SH "BUGS"
.sp
\fBfbsetbg(1)\fR is not foolproof\&.
.SH "AUTHORS"
.sp
The author of fbsetbg is Han Boetes <\m[blue]\fBhan@fluxbox\&.org\fR\m[]\&\s-2\u[1]\d\s+2>
.sp
This manpage was updated to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
.SH "Notes"
.IP " 1." 4
han@fluxbox.org
.RS 4
\%mailto:han@fluxbox.org
.RE
.IP " 2." 4
i.am@jimramsay.com
.RS 4
\%mailto:i.am@jimramsay.com
.RE