gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-24 07:02:30 +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

23
doc/wxpaste.1x
View File

@@ -4,7 +4,7 @@
wxpaste \- output a cutbuffer to stdout
.SH SYNOPSIS
.B wxpaste
[options]
.RI [ options ]
.SH DESCRIPTION
.B wxpaste
outputs the contents of the specified cutbuffer to stdout. If no cutbuffer
@@ -12,25 +12,30 @@ is specified, the cutbuffer 0 will be used as default.
.PP
.SH OPTIONS
.TP
.B \-cutbuffer number
.BI \-\-cutbuffer " number"
The data will be pasted from the specified cutbuffer, instead of the default
0.
.TP
.B \-display display\-name
.BI \-display " display\-name"
Specifies the display where wxpaste should look for the data to be pasted.
.TP
.B \-selection [selection\-name]
.B \-\-help
print a help message with the list of options.
.TP
.BR \-\-selection " [\fIselection\-name\fP]"
The data will be copied from the named selection. If cutting from the
selection fails, the cutbuffer will be used. The default value for the
selection name is PRIMARY.
.TP
.B \-\-version
print the version of Window Maker from which the program comes.
.PP
.SH BUGS
.TP
The \-selection option must be the last one. The syntax could be
cleaned, but backwards compatibility prevents that...
When used without a selection name, the \fI\-\-selection\fP option must be the last one.
The syntax could be cleaned, but backwards compatibility prevents that...
INCR and MULTIPLE selection types are not handled. Actually, only simple
text selections are handled, wich should be enough for most uses of a
\fIINCR\fP and \fIMULTIPLE\fP selection types are not handled. Actually, only simple
text selections are handled, which should be enough for most uses of a
utility such as this.
.SH SEE ALSO
.BR wxcopy (1x),