gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2026-03-24 13:43:31 +01:00
Code Issues Projects Releases Wiki Activity

doc: updated man pages for many tools

Browse Source 
This patch perform simple fixes to the man pages and tool help page:
 - minor style updates, to get cleaner pages
 - option re-ordering, to have them in alphabetic order (easier to search for)
 - consistency updates for descriptions and number of dash
 - spell-checking

The biggest changes are:
 - wmagnify: the option 'vdisplay' was not documented at all;

 - getstyle: the list of attributes that are taken for the Style are now
described in their own section to clarify the page;

 - setstyle: the help page left thinking that the file argument was
optional, which is not the case;

 - wdread: as the Exit Code may be useful, and it is not unusable, it is
now documented;

 - wmgenmenu: added information about how the content of the menu is
generated;

 - wmsetbg: added a section about dithering/best-match because as nowadays
most screens are in True Color, the reason for the option may not be clear.

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
Christophe CURIS
2015-04-06 17:57:58 +02:00
committed by Carlos R. Mafra
parent f6c9410ee7
commit c743c4b77b
16 changed files with 262 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
doc/wmsetbg.1x
View File

@@ -1,80 +1,106 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH wmsetbg 1x "January 1999"
.TH wmsetbg 1x "April 2015"
.SH NAME
wmsetbg \- sets the background on the X11 display
.SH SYNOPSIS
.B wmsetbg
[\-display] [{\-v|\-\-version}] [{\-h|\-\-help}] [{\-S|\-\-smooth}]
[{\-X|\-\-xinerama}] [{\-b|\-\-back\-color} \fIcolor\fP]
[{\-t|\-\-tile}|{\-e|\-\-center}|{\-s|\-\-scale}|{\-a|\-\-maxscale}|{\-f|\-\-fillscale} \fIimage\fP]
[{\-d|\-\-dither}|{\-m|\-\-match}] [\-u|\-\-update\-wmaker]
[{\-D|\-\-update\-domain} \fIdomain\fP] [{\-c|\-\-colors} \fIcpc\fP]
[{\-p|\-\-parse} \fItexture\fP] [{\-w|\-\-workspace} \fIworkspace\fP]
.RI [ \-display " display]"
.RI [ \-\-update-domain " domain|" \-\-update-wmaker ]
.RI [ options ]
.RI [ image ]
.SH DESCRIPTION
.B wmsetbg
reads the specified
.I image
(XPM, PNG, jpeg, Tiff, raw PPM) and puts it on the root window. It can
(in any format supported by the
.I WRaster
library) and puts it on the root window. It can
either scale the image or tile it to make it fit the root
window. Window Maker uses this command internally to set the root
window image on start up.
.SH OPTIONS
.TP
.B \-a|\-\-maxscale
scales the specified \fIimage\fP preserving its aspect ratio
.TP
.B \-b|\-\-back\-color
.BR \-\-back\-color | \-b " \fIcolor\fP"
the specified \fIcolor\fP is used as the background color for the
\fItexture\fP. Window Maker temporarely sets the background to this
\fItexture\fP. Window Maker temporary sets the background to this
color while loading and processing the texture. You can specify colors
using their X11 names or as an RGB tiplet (either as "rgb:RR/GG/BB" or
using their X11 names or as an RGB triplet (either as "rgb:RR/GG/BB" or
"#RRGGBB") (reference to appropriate manpage should be here). In the
later case \fIcolor\fB is a quoted string.
.TP
.B \-e|\-\-center
centers the specified \fIimage\fP
.BR \-\-center | \-e
centers the \fIimage\fP in the screen
.TP
.B \-t|\-\-tile
tiles the specified \fIimage\fP
.BR \-\-colors | \-c " \fIcount\fP"
limit the number of colors per channel to use for the image
.TP
.B \-s|\-\-scale
scales the specified \fIimage\fP (default)
.BR \-display " \fIdisplay\fP"
connect to the X \fIdisplay\fP
.TP
.B \-f|\-\-fillscale
.BR \-\-dither | \-d
enable color dithering on \fIimage\fP
.TP
.BR \-\-fillscale | \-f
scales the specified \fIimage\fP to fill screen while preserving aspect ratio
.TP
.B \-d|\-\-dither
dithers colors
.BR \-\-help | \-h
print a help message with the list of options
.TP
.B \-S|\-\-smooth
smooth scaled image
.BR \-\-match | \-m
use the best-matching-color algorithm when converting image to indexed color palette
.TP
.B \-X|\-\-xinerama
stretch image across Xinerama heads
.BR \-\-maxscale | \-a
scales the specified \fIimage\fP to fit inside the screen preserving its aspect ratio
.TP
.B \-m|\-\-match
matches colors
.TP
.B \-u|\-\-update\-wmaker
updates the Window Maker defaults database
.TP
.B \-D|\-\-update\-domain
updates the specified \fIdomain\fP database
.TP
.B \-c|\-\-colors
colors per channel to use
.TP
.B \-p|\-\-parse
.BR \-\-parse | \-p " \fItexture\fP"
parses the specified \fItexture\fP as a \fIproplist style texture\fP
.TP
.B \-w|\-\-workspace
.BR \-\-scale | \-s
scales the specified \fIimage\fP to fill the screen (default)
.TP
.BR \-\-smooth | \-S
use a smooth scaling algorithm when resizing \fIimage\fP
.TP
.BR \-\-tile | \-t
tiles the specified \fIimage\fP
.TP
.BR \-\-update\-domain | \-D " \fIdomain\fP"
updates the specified \fIdomain\fP database
.TP
.BR \-\-update\-wmaker | \-u
updates the Window Maker defaults database
.TP
.BR \-\-version | \-v
print the version of Window Maker from which the program comes
.TP
.BR \-\-workspace | \-w " \fIworkspace\fP"
update background only for the specified \fIworkspace\fP
.TP
.B \-h|\-\-help
print a help message
.BR \-\-xinerama | \-X
stretch image across Xinerama heads
.SH "INDEXED COLOR SCREENS"
If your screen is not in a \fBTrue Color\fP configuration (generally sold as 16,777,216 colors) but
in a indexed color mode (256 colors, 16 colors, ... which are based on a \fBColorMap\fP) then Window
Maker may need to process the image to convert it to a limited number of colors before using it for
a background image.
There are two options to choose what algorithm you want to use:
.TP
.B \-v|\-\-version
print version number
.BR \-\-match " or " \-m
Search for the closest matching color from the current colormap;
this is the fastest algorithm but may lead to less good-looking result.
.TP
.BR \-\-dither " or " \-d
Use a more complex algorithm which modify surrounding pixels to get a closer-looking color on average;
this is slower but provides better looking images.
.LP
If none is specified, then it is Window Maker's configuration choice that will be used.
You can also use the option \fB\-\-colors\fP to reduce the total number of colors from the \fIimage\fP
before the algorithm is applied.
The value specified with the option defines the number of possible values for each primary color
(red, green and blue), for example \fI8\fP would reduce the image to use only 8*8*8=512 colors before
applying the conversion algorithm.
.SH SEE ALSO
.BR wmaker (1x)
.SH AUTHOR
@@ -82,4 +108,3 @@ This man page was written by Marcelo Magallon <mmagallo@debian.org>.
.PP
Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.
wmsetbg was written by Dan Pascu <dan@windowmaker.info>