gears.surface: Update required lgi version
[awesome.git] / manpages / awsetbg.1.txt
blob52d1de9bfef2db781a42f4d3b7012af8e80d7a6f
1 awsetbg(1)
2 =========
4 NAME
5 ----
6 awsetbg - awesome wrapper tool to set background
8 SYNOPSIS
9 --------
10 *awsetbg* [-fctaFCTA wallpaper] [-uU wallpapersetter] [-m #] [-bB fbsetrootoptions ...] [-rR path] [-l]
12 DESCRIPTION
13 -----------
14 *awsetbg* is a wrapper that tries to find a suitable background setting application and then
15 tries to set the wallpaper using that application. You do not have to configure *awsetbg*, since
16 it just uses the first application it finds.
18 Furthermore, it remembers the last wallpaper set, so you do not have to edit anything to change
19 the wallpaper.
21 OPTIONS
22 -------
23 *-f* file::
24     Set fullscreen wallpaper.
25 *-c* file::
26     Set centered wallpaper.
27 *-t* file::
28     Set tiled wallpaper.
29 *-a* file::
30     Set maximized wallpaper, preserving the aspect ratio. If the application chosen does not support this
31     option, fullscreen is used as fall back.
32 *-u* wallpapersetter::
33     Use the specified wallpaper setter tool.
34 *-r* directory::
35     Set a random wallpaper from this directory.
36 *-F, -C, -T, -A, -U, -R*::
37     Same as the lowercase options, but without remembering.
38 *-l*::
39     Set the previous wallpaper. If the random feature was the last used, it will set another
40     random wallpaper from this same directory.
41 *-i*::
42     Display useful information about the best application to set the wallpaper found.
43 *-m #*::
44     Use montage to create a big image (image should fit screen size). Requires montage(1).
45     # is the number of screens (columns in montage).
46 *-p*::
47     Display useful tips.
48 *-h*::
49     Display help message.
51 FILES
52 -----
53 $XDG_CACHE_HOME/awesome/lastwallpaper or $HOME/.cache/awesome/lastwallpaper
54 files contains the last wallpaper set to use with the -l option.
56 ENVIRONMENT VARIABLES
57 ---------------------
58 *wpsetters*::
59     Wallpaper setters to use.
60 *DISPLAY*::
61     Display you want to set the wallpaper on.
63 SEE ALSO
64 --------
65 awesome(1)
68 AUTHORS
69 -------
70 Julien Danjou <julien@danjou.info> and others.
71 awsetbg is derived from fbsetbg which was written by Han Boetes <han@fluxbox.org>.
73 WWW
74 ---
75 http://awesome.naquadah.org