awsetbg: add manpage

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Julien Danjou 2008-11-21 11:43:36 +01:00
parent 5afca2e182
commit 281e562182
2 changed files with 73 additions and 0 deletions

View File

@ -90,6 +90,7 @@ set(AWE_CLIENT_SRCS
set(AWE_MAN_SRCS
${SOURCE_DIR}/awesome.1.txt
${SOURCE_DIR}/awsetbg.1.txt
${SOURCE_DIR}/awesome-client.1.txt
${SOURCE_DIR}/awesomerc.5.txt)

72
awsetbg.1.txt Normal file
View File

@ -0,0 +1,72 @@
awsetbg(1)
=========
NAME
----
awsetbg - awesome wrapper tool to set background
SYNOPSIS
--------
*awsetbg* [-fctaFCTA wallpaper] [-uU wallpapersetter] [-m #] [-bB fbsetrootoptions ...] [-rR path] [-l]
DESCRIPTION
-----------
*awsetbg* 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 *awsetbg*, since
it just uses te first application it find.
Furthermore, it remembers the last wallpaper set, so you do not have to edit anything to change
the wallpaper.
OPTIONS
-------
*-f* file::
Set fullscreen wallpaper.
*-c* file::
Set centered wallpaper.
*-t* file::
Set centered wallpaper.
*-a* file::
Set maximized wallpaper, preserving aspect. If the application chosen do not support this
option, fullscreen is used as fallback.
*-u* wallpapersetter::
Use the specified wallpaper setter tool.
*-r* directory::
Set a random wallpaper from this directory.
*-F, -C, -T, -A, -U, -R*::
Same as the lowercaser option, but without remembering.
*-l*::
Set the previous wallpaper. If the random feature was the last used, it will set another
random wallpaper from this same directory.
*-i*::
Display useful information about the best application to set the wallpaper found.
*-p*::
Display useful tips.
*-h*::
Display help message.
FILES
-----
$XDG_CACHE_HOME/awesome/lastwallpaper or $HOME/.cache/awesome/lastwallpaper
files contains the last wallpaper set to use with the -l option.
ENVIRONMENT VARIABLES
---------------------
*wpsetters*::
Wallpaper setters to use.
*DISPLAY*::
Display you want to set the wallpaper on.
SEE ALSO
--------
awesome(1)
AUTHORS
-------
Julien Danjou <julien@danjou.info> and others.
awsetbg is derived from fbsetbg which was written by Han Boetes <han@fluxbox.org>.
WWW
---
http://awesome.naquadah.org