gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2026-01-05 21:34:17 +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

18
doc/geticonset.1x
View File

@@ -1,27 +1,29 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH geticonset 1x "January 1999"
.SH NAME
geticonset \- gets the current Window Maker iconset
geticonset \- gets the current Window Maker icon set
.SH SYNOPSIS
.B geticonset
.I [options] [iconsetfile]
.RI [ options ]
.RI [ iconsetfile ]
.SH DESCRIPTION
.B geticonset
reads the WMWindowAttributes domain, and writes the iconset found
there either to stdout or to
.I iconsetfile.
reads the
.I WMWindowAttributes
domain, and writes the icon set found there either to stdout or to the file
.IR iconsetfile .
.SH OPTIONS
.TP
.B \-\-help
print a help message
print a help message with the list of options
.TP
.B \-\-version
print version number
print the version of Window Maker from which the program comes
.SH ENVIRONMENT
.IP GNUSTEP_USER_ROOT
specifies the initial path for the Defaults directory. "Defaults/" is
appended to this variable to determine the actual location of the
databases. If the varialbe is not set, it defaults to "~/GNUstep"
databases. If the variable is not set, it defaults to "~/GNUstep"
.SH FILES
.IP GNUSTEP_USER_ROOT/Defaults/WMWindowAttributes
is the actual file that's read.