doc: updated man pages for many tools

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>

doc/WPrefs.1x

@@ -1,9 +1,9 @@
-.TH "Window Maker" 1x "March 2001" "Debian Project"
+.TH WPrefs 1x "March 2001"
 .SH NAME
 WPrefs \- Window Maker configuration tool
 .SH SYNOPSIS
 .B WPrefs
-.I "[-options]"
+.RI [ options ]
 .SH "DESCRIPTION"
 WPrefs.app is the preferences "editor" for the WindowMaker window manager. It
 can be used to set most of the preference options of WindowMaker and define
@@ -18,14 +18,14 @@ of WindowMaker that are not related to configuration.
 system-wide configuration file is saved.\fP
 .SH "OPTIONS"
 .TP
-.B \-display host:display.screen
+.BI \-display " host:display.screen"
 specify display to use.
 .TP
-.B \-\-version
-display version number and exit
-.TP
 .B \-\-help
-display help message and exit
+print a help message with the list of options
+.TP
+.B \-\-version
+print the version of Window Maker from which the program comes
 .SH FILES
 .TP
 .B ~/GNUstep/Defaults/WindowMaker

doc/geticonset.1x

@@ -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.

doc/getstyle.1x

@@ -1,55 +1,58 @@
 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
-.TH getstyle 1x "January 1999"
+.TH getstyle 1x "April 2015"
 .SH NAME
 getstyle \- dumps the current Window Maker style related configuration or
 creates a theme pack.
 .SH SYNOPSIS
 .B getstyle
-[[\-t|\-\-theme-options] [\-p|\-\-pack] [style file]]
+.RI [ \-t | \-\-theme-options "] [" \-p | \-\-pack "] [" "style file" ]
 .SH DESCRIPTION
 .B getstyle
 can either dump the current Window Maker style related configuration
 information to a file/stdout or create a self-contained theme pack. A theme
-pack is a directory that contains everything that is needed by a
+pack is a directory that contains everything that is needed for a
 redistributable theme, including the style information and pixmaps used by it.
 
 Note that style information stored in the global configuration of the
 system is not read.
 
-The following options are stored by default: \fITitleJustify\fP,
-\fIClipTitleFont\fP, \fIWindowTitleFont\fP, \fIMenuTitleFont\fP,
-\fIMenuTextFont\fP, \fIIconTitleFont\fP,
-\fILargeDisplayFont\fP, \fIHighlightColor\fP, \fIHighlightTextColor\fP,
-\fIClipTitleColor\fP, \fICClipTitleColor\fP, \fIFTitleColor\fP,
-\fIPTitleColor\fP, \fIUTitleColor\fP, \fIFTitleBack\fP,
-\fIPTitleBack\fP, \fIUTitleBack\fP, \fIResizebarBack\fP,
-\fIMenuTitleColor\fP, \fIMenuTextColor\fP, \fIMenuDisabledColor\fP,
-\fIMenuTitleBack\fP, \fIMenuTextBack\fP, \fIIconBack\fP,
-\fIIconTitleColor\fP, \fIIconTitleBack\fP, \fIFrameBorderWidth\fP,
-\fIFrameBorderColor\fP, \fIFrameSelectedBorderColor\fP,
-\fIMenuStyle\fP, \fIWindowTitleExtendSpace\fP,
-\fIMenuTitleExtendSpace\fP, and \fIMenuTextExtendSpace\fP.
-
-If either \fB-t\fP or \fB--theme-options\fP is specified, in addition
-to the previous options, \fIWorkspaceBack\fP is \fIalso\fP stored,
-along with any user-definable mouse cursor settings
-(\fINormalCursor\fP, \fIArrowCursor\fP, \fIMoveCursor\fP,
-\fIResizeCursor\fP,
-\fITopLeftResizeCursor\fP, \fITopRightResizeCursor\fP,
-\fIBottomLeftResizeCursor\fP, \fIBottomRightResizeCursor\fP,
-\fIVerticalResizeCursor\fP, \fIHorizontalResizeCursor\fP,
-\fIWaitCursor\fP, \fIQuestionCursor\fP, \fITextCursor\fP,
-\fISelectCursor\fP) that are present.
-
 .SH OPTIONS
 .TP
-.B \-t
-dumps theme related information too, which includes the root background
-texture.  This option is always enabled when the \-p option is used.
+.B \-\-help
+print a help message with the list of options.
 .TP
-.B \-p
+.BR \-\-pack " or " \-p
 creates a theme pack in the directory named by the theme name appended
 with the .themed suffix.
+.TP
+.BR \-\-theme-options " or " \-t
+dumps theme related information too, which includes the root background
+texture.  This option is always enabled when the \-p option is used.
+.TP
+.B \-\-version
+print the version of Window Maker from which the program comes.
+
+.SH "STYLE CONTENT"
+
+The following options are stored by default:
+.IR TitleJustify ", " ClipTitleFont ", " WindowTitleFont ", " MenuTitleFont ,
+.IR MenuTextFont ", " IconTitleFont ", " LargeDisplayFont ", " HighlightColor ,
+.IR HighlightTextColor ", " ClipTitleColor ", " CClipTitleColor ", " FTitleColor ,
+.IR PTitleColor ", " UTitleColor ", " FTitleBack ", " PTitleBack ,
+.IR UTitleBack ", " ResizebarBack ", " MenuTitleColor ", " MenuTextColor ,
+.IR MenuDisabledColor ", " MenuTitleBack ", " MenuTextBack ", " IconBack ,
+.IR IconTitleColor ", " IconTitleBack ", " FrameBorderWidth ", " FrameBorderColor ,
+.IR FrameSelectedBorderColor ", " MenuStyle ", " WindowTitleExtendSpace ,
+.IR MenuTitleExtendSpace ", and " MenuTextExtendSpace .
+
+If either \fB-t\fP or \fB--theme-options\fP is specified, in addition
+to the previous options, \fIWorkspaceBack\fP is also stored,
+along with any user-definable mouse cursor settings
+.RI ( NormalCursor ", " ArrowCursor ", " MoveCursor ", " ResizeCursor ,
+.IR TopLeftResizeCursor ", " TopRightResizeCursor ", " BottomLeftResizeCursor ,
+.IR BottomRightResizeCursor ", " VerticalResizeCursor ", " HorizontalResizeCursor ,
+.IR WaitCursor ", " QuestionCursor ", " TextCursor ", " SelectCursor )
+that are present.
 
 .SH ENVIRONMENT
 .IP GNUSTEP_USER_ROOT

doc/seticons.1x

@@ -9,21 +9,23 @@ seticons \- sets the icon images used in Window Maker
 .B seticons
 reads
 .I iconsfile
-and writes its contents to the WMWindowAttributes domain, efectively
+and writes its contents to the
+.I WMWindowAttributes
+domain, effectively
 setting the icons Window Maker uses for a given class (for example,
 XTerm, "xterm.XTerm", "rxvt.XTerm", "pine.XTerm", etc)
 .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
 This is the actual file that's written.

doc/setstyle.1x

@@ -1,44 +1,47 @@
 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
-.TH setstyle 1x "January 1999"
+.TH setstyle 1x "April 2015"
 .SH NAME
 setstyle \- set style related options for Window Maker or loads a theme
 .SH SYNOPSIS
 .B setstyle
-.I "[--no-fonts] [--no-cursors] [--help] [--version]"
-.I stylefile
+.RI [ options ]
+.IR stylefile | themepack
 .SH DESCRIPTION
 .B setstyle
-reads
+reads the file
 .I stylefile
-and writes its contents to the WindowMaker domain, effectively setting
-the Window Maker style. If the supplied path is a directory, it will
-be treated as a theme pack and it will be loaded appropriately. If the
-\fB\-\-no\-fonts\fP flag is specified, font related options
-(\fIIconTitleFont\fP, \fIClipTitleFont\fP,
-\fIMenuTextFont\fP, \fIMenuTitleFont\fP, \fIWindowTitleFont\fP) in the
-style file will be ignored.
-
-If the \fB\-\-no\-cursors\fP flag is specified, any mouse cursor
-definitions (\fINormalCursor\fP, \fIArrowCursor\fP, \fIMoveCursor\fP,
-\fIResizeCursor\fP,
-\fITopLeftResizeCursor\fP, \fITopRightResizeCursor\fP,
-\fIBottomLeftResizeCursor\fP, \fIBottomRightResizeCursor\fP,
-\fIVerticalResizeCursor\fP, \fIHorizontalResizeCursor\fP,
-\fIWaitCursor\fP, \fIQuestionCursor\fP, \fITextCursor\fP,
-\fISelectCursor\fP) in the style or theme will be ignored.
+and writes its contents to the
+.I WMWindowMaker
+domain, effectively setting the Window Maker style.
+If the supplied path is a directory
+.RI ( themepack ),
+it will be treated as a theme pack and it will be loaded appropriately.
 .SH OPTIONS
 .TP
-.B \-\-no\-fonts
-ignore font related options in style file.
+.B \-\-help
+print a help message with the list of options.
+.TP
+.BR \-\-ignore " \fIkeyword\fP"
+ignore the attribute named \fIkeyword\fP from the style file.
+You can specify this option as many times as needed.
+You may find a non-exhaustive list of the keywords from the
+.BR getstyle (1x)
+man page.
 .TP
 .B \-\-no\-cursors
-ignore cursor definition options in style file.
+ignore cursor definition options from the style file
+.RI ( NormalCursor ", " ArrowCursor ", " MoveCursor ", " ResizeCursor ,
+.IR TopLeftResizeCursor ", " TopRightResizeCursor ", " BottomLeftResizeCursor ,
+.IR BottomRightResizeCursor ", " VerticalResizeCursor ", " HorizontalResizeCursor ,
+.IR WaitCursor ", " QuestionCursor ", " TextCursor ", " SelectCursor ).
 .TP
-.B \-\-help
-print a help message
+.B \-\-no\-fonts
+ignore font related options from the style file
+.RI ( IconTitleFont ", " ClipTitleFont ", " MenuTextFont ,
+.IR MenuTitleFont ", " WindowTitleFont ).
 .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

doc/wdread.1x

@@ -1,27 +1,39 @@
-.TH wdread 1x "15 August 2011"
+.TH wdread 1x "April 2015"
 .SH "NAME"
 \fBwdread\fR \- read value from defaults database
 .PP
 .SH "SYNOPSIS"
-.B wdread \fR[ \fI\-\-options \fR]
+.B wdread
+.RI [ options ]
+.I domain
+.I key
 .PP
 .SH "DESCRIPTION"
-\fBwdread \fR\- read value from defaults database
+\fBwdread\fR\ gets the value associated with the key \fIkey\fR from the domain \fIdomain\fR
+and prints it on stdout.
 .PP
 .SH "OPTIONS"
 .TP
 .B \-\-help
-\fRdisplay this help and exit
+print a help message with the list of options
 .TP
 .B \-\-version
-\fRoutput version information and exit
+print the version of Window Maker from which the program comes
+.PP
+.SH "EXIT STATUS"
+The program \fBwdread\fP will exit with the following code:
 .TP
-.B \-\-h
-\fRlike \-\-help
+.B 0
+when the \fIkey\fP was successfully found and its content printed.
 .TP
-.B \-\-v
-\fRlike \-\-version
-.PP
+.B 1
+if the program was not invoked properly (unknown option or incorrect argument count).
+.TP
+.B 1
+if the \fIdomain\fP's file could not be read (probably nonexistent domain).
+.TP
+.B 2
+if the \fIkey\fP was not found in the \fIdomain\fP.
 .SH "AUTHOR"
 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>,
 wdread is a part of Window Maker, was  cowardly remade from wdwrite.c;

doc/wdwrite.1x

@@ -14,19 +14,19 @@ writes
 and
 .I value
 to the specified
-.I domain.
+.IR domain .
 .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
 The domains reside in GNUSTEP_USER_ROOT/Defaults/
 .SH SEE ALSO