mirror of
https://github.com/gryf/wmaker.git
synced 2025-12-19 04:20:27 +01:00
c743c4b77b
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>
44 lines
1.1 KiB
Plaintext
44 lines
1.1 KiB
Plaintext
.TH wdread 1x "April 2015"
|
|
.SH "NAME"
|
|
\fBwdread\fR \- read value from defaults database
|
|
.PP
|
|
.SH "SYNOPSIS"
|
|
.B wdread
|
|
.RI [ options ]
|
|
.I domain
|
|
.I key
|
|
.PP
|
|
.SH "DESCRIPTION"
|
|
\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
|
|
print a help message with the list of options
|
|
.TP
|
|
.B \-\-version
|
|
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 0
|
|
when the \fIkey\fP was successfully found and its content printed.
|
|
.TP
|
|
.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;
|
|
by judas@hell on Jan 26 2001
|
|
.PP
|
|
This manpage was written by Rodolfo García Peñas (kix) for the
|
|
Debian GNU/Linux system (but may be used by others).
|