1
0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-19 12:28:22 +01:00
Files
wmaker/doc/setstyle.1x
Christophe CURIS c743c4b77b 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>
2015-04-18 19:31:10 +01:00

60 lines
2.0 KiB
Plaintext

.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH setstyle 1x "April 2015"
.SH NAME
setstyle \- set style related options for Window Maker or loads a theme
.SH SYNOPSIS
.B setstyle
.RI [ options ]
.IR stylefile | themepack
.SH DESCRIPTION
.B setstyle
reads the file
.I stylefile
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 \-\-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 from the style file
.RI ( NormalCursor ", " ArrowCursor ", " MoveCursor ", " ResizeCursor ,
.IR TopLeftResizeCursor ", " TopRightResizeCursor ", " BottomLeftResizeCursor ,
.IR BottomRightResizeCursor ", " VerticalResizeCursor ", " HorizontalResizeCursor ,
.IR WaitCursor ", " QuestionCursor ", " TextCursor ", " SelectCursor ).
.TP
.B \-\-no\-fonts
ignore font related options from the style file
.RI ( IconTitleFont ", " ClipTitleFont ", " MenuTextFont ,
.IR MenuTitleFont ", " WindowTitleFont ).
.TP
.B \-\-version
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 variable is not set, it defaults to "~/GNUstep"
.SH FILES
.IP GNUSTEP_USER_ROOT/Defaults/WindowMaker
This is the actual file that's written.
.SH SEE ALSO
.BR getstyle (1x),
.BR wmaker (1x)
.SH AUTHOR
This man page was written by Marcelo Magallon <mmagallo@debian.org>.
.PP
Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.