contrib/awesome/awsetbg.1
Bartlomiej Palmowski 0e5fe7d0a2 awesome: new version
2009-11-24 18:23:23 +01:00

274 lines
6.2 KiB
Groff

.\" Title: awsetbg
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\" Date: 11/09/2009
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "AWSETBG" "1" "11/09/2009" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * (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"
awsetbg \- awesome wrapper tool to set background
.SH "Synopsis"
.sp
\fBawsetbg\fR [\-fctaFCTA wallpaper] [\-uU wallpapersetter] [\-m #] [\-bB fbsetrootoptions \&...] [\-rR path] [\-l]
.SH "DESCRIPTION"
.sp
\fBawsetbg\fR is a wrapper that tries to find a suitable background setting application and then tries to set the wallpaper using that application\&. You do not have to configure \fBawsetbg\fR, since it just uses the first application it finds\&.
.sp
Furthermore, it remembers the last wallpaper set, so you do not have to edit anything to change the wallpaper\&.
.SH "OPTIONS"
.PP
\fB\-f\fR file
.RS 4
Set fullscreen wallpaper\&.
.RE
.PP
\fB\-c\fR file
.RS 4
Set centered wallpaper\&.
.RE
.PP
\fB\-t\fR file
.RS 4
Set tiled wallpaper\&.
.RE
.PP
\fB\-a\fR file
.RS 4
Set maximized wallpaper, preserving the aspect ratio\&. If the application chosen does not support this option, fullscreen is used as fall back\&.
.RE
.PP
\fB\-u\fR wallpapersetter
.RS 4
Use the specified wallpaper setter tool\&.
.RE
.PP
\fB\-r\fR directory
.RS 4
Set a random wallpaper from this directory\&.
.RE
.PP
\fB\-F, \-C, \-T, \-A, \-U, \-R\fR
.RS 4
Same as the lowercase options, but without remembering\&.
.RE
.PP
\fB\-l\fR
.RS 4
Set the previous wallpaper\&. If the random feature was the last used, it will set another random wallpaper from this same directory\&.
.RE
.PP
\fB\-i\fR
.RS 4
Display useful information about the best application to set the wallpaper found\&.
.RE
.PP
\fB\-m #\fR
.RS 4
Use montage to create a big image (image should fit screen size)\&. Requires montage(1)\&. # is the number of screens (columns in montage)\&.
.RE
.PP
\fB\-p\fR
.RS 4
Display useful tips\&.
.RE
.PP
\fB\-h\fR
.RS 4
Display help message\&.
.RE
.SH "FILES"
.sp
$XDG_CACHE_HOME/awesome/lastwallpaper or $HOME/\&.cache/awesome/lastwallpaper files contains the last wallpaper set to use with the \-l option\&.
.SH "ENVIRONMENT VARIABLES"
.PP
\fBwpsetters\fR
.RS 4
Wallpaper setters to use\&.
.RE
.PP
\fBDISPLAY\fR
.RS 4
Display you want to set the wallpaper on\&.
.RE
.SH "SEE ALSO"
.sp
awesome(1)
.SH "AUTHORS"
.sp
Julien Danjou <\m[blue]\fBjulien@danjou\&.info\fR\m[]\&\s-2\u[1]\d\s+2> and others\&. awsetbg is derived from fbsetbg which was written by Han Boetes <\m[blue]\fBhan@fluxbox\&.org\fR\m[]\&\s-2\u[2]\d\s+2>\&.
.SH "WWW"
.sp
\m[blue]\fBhttp://awesome\&.naquadah\&.org\fR\m[]
.SH "Notes"
.IP " 1." 4
julien@danjou.info
.RS 4
\%mailto:julien@danjou.info
.RE
.IP " 2." 4
han@fluxbox.org
.RS 4
\%mailto:han@fluxbox.org
.RE