gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-18 20:10:29 +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

14
doc/WPrefs.1x
View File

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

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.

67
doc/getstyle.1x
View File

@@ -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
.B \-\-help
print a help message with the list of options.
.TP
.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 \-p
creates a theme pack in the directory named by the theme name appended
with the .themed suffix.
.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

10
doc/seticons.1x
View File

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

55
doc/setstyle.1x
View File

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

34
doc/wdread.1x
View File

@@ -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
.TP
.B \-\-h
\fRlike \-\-help
.TP
.B \-\-v
\fRlike \-\-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;

8
doc/wdwrite.1x
View File

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

34
doc/wmagnify.1x
View File

@@ -1,10 +1,11 @@
.TH WMAGNIFY 1 "March 22, 2006" "" "User Commands"
.TH wmagnify 1x "March 22, 2006"
.SH NAME
wmagnify \- magnify parts of the screen
.SH SYNOPSIS
\fBwmagnify\fR [\fIoptions\fR]
.B wmagnify
.RI [ options ]
.SH DESCRIPTION
\fBwmagnify\fR is a tool which allows you to magnify parts of the screen. The
@@ -12,36 +13,43 @@ main difference from \fBxmag\fR is that the image is refreshed automatically,
following the cursor on the screen.
.SH OPTIONS
The following command line options are available.
The following command line options are available:
.TP
\fB\-m\fR \fIfactor\fR
.BR \-display " \fIdisplay\fP"
Show the magnified area on this \fIdisplay\fR.
.TP
.B \-\-help
print a help message with the list of options.
.TP
.BR \-m " \fIfactor\fP"
Change the magnification factor, default is 2. You can change this also while
running the program, using the keys described below.
.TP
\fB\-r\fR \fIdelay\fR
.BR \-r " \fIdelay\fP"
Change the refresh delay, in milliseconds. Default is 200.
.TP
\fB\-display\fR \fIdisplay\fR
Use \fIdisplay\fR instead of the default one.
.BR \-vdisplay " \fIdisplay\fP"
Take the area to be magnified from this \fIdisplay\fP instead of using the same display as for visualisation.
.SH KEYS
The following keys can be pressed while \fBwmagnify\fR is running to change its
behaviour.
.TP
\fB1,2,3,4,5,6,7,8,9\fR
.BR 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9
Change the magnification factor.
.TP
\fB<space>, f\fR
.BR <space> ", " f
Freeze the camera, making it magnify only the current position.
.TP
\fBn\fR
.B n
Create a new window.
.TP
\fBm\fR
Show/hide the pointer hotspot mark.
.B m
Show/hide the pointer hot spot mark.
.SH SEE ALSO
\fBxmag(1)\fR, \fBwmaker(1)\fR
.BR xmag (1),
.BR wmaker (1)
.SH AUTHOR
This manual page was written by Andrea Bolognani <eof@kiyuko.org> for the

24
doc/wmgenmenu.1
View File

@@ -1,29 +1,29 @@
.TH "wmgenmenu" "1" "15 August 2011"
.TH wmgenmenu 1 "15 August 2011"
.SH "NAME"
\fBwmgenmenu\fR \- Writes a menu structure usable as
~/GNUstep/Defaults/WMRootMenu to stdout
.PP
.SH "SYNOPSIS"
.B wmgenmenu \fR[ \fI\-\-options \fR]
.B wmgenmenu
.RI [ options ]
.PP
.SH "DESCRIPTION"
\fBwmgenmenu \fR\- Writes a menu structure usable as
~/GNUstep/Defaults/WMRootMenu to stdout
\fBwmgenmenu\fR writes a menu structure usable as
~/GNUstep/Defaults/WMRootMenu to stdout.
The output format is a \fIPropList\fP.
.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
.TP
.B \-\-h
\fRlike \-\-help
.TP
.B \-\-v
\fRlike \-\-version
print the version of Window Maker from which the program comes
.PP
.SH "BUGS"
The program is using a built-in structure and list of applications, which means it cannot discover
new programs, but it filters the programs that cannot be found in the \fBPATH\fP.
.SH "AUTHOR"
wmgenmenu is a part of Window Maker. It was written by Carlos R. Mafra and
Tamas TEVESZ.

117
doc/wmsetbg.1x
View File

@@ -1,80 +1,106 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH wmsetbg 1x "January 1999"
.TH wmsetbg 1x "April 2015"
.SH NAME
wmsetbg \- sets the background on the X11 display
.SH SYNOPSIS
.B wmsetbg
[\-display] [{\-v|\-\-version}] [{\-h|\-\-help}] [{\-S|\-\-smooth}]
[{\-X|\-\-xinerama}] [{\-b|\-\-back\-color} \fIcolor\fP]
[{\-t|\-\-tile}|{\-e|\-\-center}|{\-s|\-\-scale}|{\-a|\-\-maxscale}|{\-f|\-\-fillscale} \fIimage\fP]
[{\-d|\-\-dither}|{\-m|\-\-match}] [\-u|\-\-update\-wmaker]
[{\-D|\-\-update\-domain} \fIdomain\fP] [{\-c|\-\-colors} \fIcpc\fP]
[{\-p|\-\-parse} \fItexture\fP] [{\-w|\-\-workspace} \fIworkspace\fP]
.RI [ \-display " display]"
.RI [ \-\-update-domain " domain|" \-\-update-wmaker ]
.RI [ options ]
.RI [ image ]
.SH DESCRIPTION
.B wmsetbg
reads the specified
.I image
(XPM, PNG, jpeg, Tiff, raw PPM) and puts it on the root window. It can
(in any format supported by the
.I WRaster
library) and puts it on the root window. It can
either scale the image or tile it to make it fit the root
window. Window Maker uses this command internally to set the root
window image on start up.
.SH OPTIONS
.TP
.B \-a|\-\-maxscale
scales the specified \fIimage\fP preserving its aspect ratio
.TP
.B \-b|\-\-back\-color
.BR \-\-back\-color | \-b " \fIcolor\fP"
the specified \fIcolor\fP is used as the background color for the
\fItexture\fP. Window Maker temporarely sets the background to this
\fItexture\fP. Window Maker temporary sets the background to this
color while loading and processing the texture. You can specify colors
using their X11 names or as an RGB tiplet (either as "rgb:RR/GG/BB" or
using their X11 names or as an RGB triplet (either as "rgb:RR/GG/BB" or
"#RRGGBB") (reference to appropriate manpage should be here). In the
later case \fIcolor\fB is a quoted string.
.TP
.B \-e|\-\-center
centers the specified \fIimage\fP
.BR \-\-center | \-e
centers the \fIimage\fP in the screen
.TP
.B \-t|\-\-tile
tiles the specified \fIimage\fP
.BR \-\-colors | \-c " \fIcount\fP"
limit the number of colors per channel to use for the image
.TP
.B \-s|\-\-scale
scales the specified \fIimage\fP (default)
.BR \-display " \fIdisplay\fP"
connect to the X \fIdisplay\fP
.TP
.B \-f|\-\-fillscale
.BR \-\-dither | \-d
enable color dithering on \fIimage\fP
.TP
.BR \-\-fillscale | \-f
scales the specified \fIimage\fP to fill screen while preserving aspect ratio
.TP
.B \-d|\-\-dither
dithers colors
.BR \-\-help | \-h
print a help message with the list of options
.TP
.B \-S|\-\-smooth
smooth scaled image
.BR \-\-match | \-m
use the best-matching-color algorithm when converting image to indexed color palette
.TP
.B \-X|\-\-xinerama
stretch image across Xinerama heads
.BR \-\-maxscale | \-a
scales the specified \fIimage\fP to fit inside the screen preserving its aspect ratio
.TP
.B \-m|\-\-match
matches colors
.TP
.B \-u|\-\-update\-wmaker
updates the Window Maker defaults database
.TP
.B \-D|\-\-update\-domain
updates the specified \fIdomain\fP database
.TP
.B \-c|\-\-colors
colors per channel to use
.TP
.B \-p|\-\-parse
.BR \-\-parse | \-p " \fItexture\fP"
parses the specified \fItexture\fP as a \fIproplist style texture\fP
.TP
.B \-w|\-\-workspace
.BR \-\-scale | \-s
scales the specified \fIimage\fP to fill the screen (default)
.TP
.BR \-\-smooth | \-S
use a smooth scaling algorithm when resizing \fIimage\fP
.TP
.BR \-\-tile | \-t
tiles the specified \fIimage\fP
.TP
.BR \-\-update\-domain | \-D " \fIdomain\fP"
updates the specified \fIdomain\fP database
.TP
.BR \-\-update\-wmaker | \-u
updates the Window Maker defaults database
.TP
.BR \-\-version | \-v
print the version of Window Maker from which the program comes
.TP
.BR \-\-workspace | \-w " \fIworkspace\fP"
update background only for the specified \fIworkspace\fP
.TP
.B \-h|\-\-help
print a help message
.BR \-\-xinerama | \-X
stretch image across Xinerama heads
.SH "INDEXED COLOR SCREENS"
If your screen is not in a \fBTrue Color\fP configuration (generally sold as 16,777,216 colors) but
in a indexed color mode (256 colors, 16 colors, ... which are based on a \fBColorMap\fP) then Window
Maker may need to process the image to convert it to a limited number of colors before using it for
a background image.
There are two options to choose what algorithm you want to use:
.TP
.B \-v|\-\-version
print version number
.BR \-\-match " or " \-m
Search for the closest matching color from the current colormap;
this is the fastest algorithm but may lead to less good-looking result.
.TP
.BR \-\-dither " or " \-d
Use a more complex algorithm which modify surrounding pixels to get a closer-looking color on average;
this is slower but provides better looking images.
.LP
If none is specified, then it is Window Maker's configuration choice that will be used.
You can also use the option \fB\-\-colors\fP to reduce the total number of colors from the \fIimage\fP
before the algorithm is applied.
The value specified with the option defines the number of possible values for each primary color
(red, green and blue), for example \fI8\fP would reduce the image to use only 8*8*8=512 colors before
applying the conversion algorithm.
.SH SEE ALSO
.BR wmaker (1x)
.SH AUTHOR
@@ -82,4 +108,3 @@ This man page was written by Marcelo Magallon <mmagallo@debian.org>.
.PP
Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.
wmsetbg was written by Dan Pascu <dan@windowmaker.info>

36
doc/wxcopy.1x
View File

@@ -1,11 +1,11 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH wxcopy 1x "September 1998"
.SH NAME
wxcopy \- copy stdin or file into cutbuffer
wxcopy \- copy stdin or file into X11 cutbuffer
.SH SYNOPSIS
.B wxcopy
[options]
[filename]
.RI [ options ]
.RI [ filename ]
.SH DESCRIPTION
.B wxcopy
copies stdin or
@@ -16,21 +16,27 @@ If a cutbuffer is specified, the data is copied into that cutbuffer,
and no rotation of buffers is performed.
.SH OPTIONS
.TP
.B \-cutbuffer number
Specifies the number of the cutbuffer to copy data to.
.TP
.B \-display display\-name
The data will be copied in the cutbuffers of the specified display/screen.
.TP
.B \-nolimit
Makes the normal 64kb limit check not to be performed, making the buffer
attempt to grow to whatever size is required.
.TP
.B \-clearselection
.B \-\-clear\-selection
Clears the PRIMARY selection owner. In practice it means that when you try
to paste the data with the middle mouse button (for example) it will paste
the data from cut buffer 0, instead of any eventually existing mouse
selection.
.TP
.BI \-\-cutbuffer " number"
Specifies the number of the cutbuffer to copy data to.
.TP
.BR \-display " display\-name"
The data will be copied in the cutbuffers of the specified display/screen.
.TP
.B \-\-help
print a help message with the list of options.
.TP
.B \-\-no\-limit
Makes the normal 64kb limit check not to be performed, making the buffer
attempt to grow to whatever size is required.
.TP
.B \-\-version
print the version of Window Maker from which the program comes.
.PP
.SH SEE ALSO
.BR wxpaste (1x),
@@ -40,5 +46,5 @@ This man page was written by Marcelo Magallon <mmagallo@debian.org>.
.PP
Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.
Binary data compatibility and \-nolimit stuff by Luke Kendall
Binary data compatibility and \-\-no\-limit stuff by Luke Kendall
<luke@research.canon.com.au>.

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),

2
util/seticons.c
View File

@@ -42,7 +42,7 @@ static const char *prog_name;
static noreturn void print_help(int print_usage, int exitval)
{
printf("Usage: %s [-h] [-v] [file]\n", prog_name);
printf("Usage: %s [-h] [-v] file\n", prog_name);
if (print_usage) {
puts("Reads icon configuration from FILE and updates Window Maker.");
puts("");

8
util/wmagnify.c
View File

@@ -436,9 +436,11 @@ int main(int argc, char **argv)
printf("Usage: %s [options]\n", argv[0]);
puts("Options:");
puts(" -display <display> display that should be used");
puts(" -m <number> change magnification factor (default 2)");
puts(" -r <number> change refresh delay, in milliseconds (default 200)");
puts(" -display <display>\tdisplay where to magnification is shown");
puts(" -m <number>\t\tchange magnification factor (default 2)");
puts(" -r <number>\t\tchange refresh delay, in milliseconds (default 200)");
puts(" -vdisplay <display>\tdisplay from which the magnification is taken");
puts(" -h, --help\t\tdisplay this help page");
puts("Keys:");
puts(" 1,2,3,4,5,6,7,8,9 change the magnification factor");
puts(" <space>, f freeze the 'camera', making it magnify only the current\n"

2
util/wmsetbg.c
View File

@@ -1153,7 +1153,7 @@ static void print_help(void)
puts("Sets the workspace background to the specified image or a texture and");
puts("optionally update Window Maker configuration");
puts("");
puts(" -display display to use");
puts(" -display <display> display to use");
puts(" -d, --dither dither image");
puts(" -m, --match match colors");
puts(" -S, --smooth smooth scaled image");

4
util/wxpaste.c
View File

@@ -39,8 +39,8 @@ static const char *prog_name;
static void print_help(void)
{
printf("Usage: %s [OPTIONS] [FILE]\n", prog_name);
puts("Copies data from X selection or cutbuffer to FILE or stdout.");
printf("Usage: %s [OPTIONS]\n", prog_name);
puts("Copies data from X selection or cutbuffer to stdout.");
puts("");
puts(" -display display display to use");
puts(" --cutbuffer number cutbuffer number to get data from");