gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-19 04:20:27 +01:00
Code Issues Projects Releases Wiki Activity

wmaker: improve the documentation for the command-line options

Browse Source 
There were 2 options that were not documented at all, which are now listed
in the 'wmaker --help';

The man page have been updated according to the 'check-cmdline-opts' script
feedback, including:
 - adding 2 options that were missing (global_def_path, no-drawer);
 - removed 2 options that do not exist anymore (no-cpp, create-stdcmap);
 - sorting the options, to make them easier to search for.

In addition, took opportunity to:
 - remove the double description for 'visual-id';
 - improve a number of descriptions to make them clearer;
 - fix minor stuff (typo, spaces at end of lines).

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
Christophe CURIS
2015-04-06 17:57:54 +02:00
committed by Carlos R. Mafra
parent b6270f5a92
commit 6749e38693
2 changed files with 43 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
doc/wmaker.1x
View File

@@ -1,5 +1,5 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.TH "Window Maker" 1x "January 1999"
.TH "Window Maker" 1x "February 2015"
.SH NAME
wmaker \- X11 window manager with a NEXTSTEP look
.SH SYNOPSIS
@@ -11,53 +11,54 @@ emulate NeXT's look as much as possible, but it deviates from it as
necessary.
.SH "OPTIONS"
.TP
.B \-display host:display.screen
.BI \-display " host:display.screen"
specify display to use.
On multiheaded machines, Window Maker will automatically manage all screens.
If you want Window Maker to manage only a specific screen, you must supply
the screen number you want to have managed with the
the screen number you want to have managed with the
.B \-display
command line argument. For example, if you want Window Maker to manage only
screen 1, start it as:
.B wmaker -display :0.1
.TP
.B \-\-no\-cpp
disable preprocessing of configuration files
.TP
.B \-\-no\-dock
do not show the application Dock
.TP
.B \-\-no\-clip
do not show the workspace Clip
.TP
.B \-\-no\-autolaunch
do not autolaunch applications
.EX
wmaker -display :0.1
.EE
.TP
.B \-\-dont\-restore
do not restore saved session
.TP
.B \-\-locale locale
specify the locale to use
.TP
.B \-\-create-stdcmap
create the standard colormap hint in PseudoColor visuals
.TP
.B \-\-visual\-id
visual id of visual to use
.TP
.B \-\-static
do not update or save configurations
.TP
.B \-\-version
display version number and exit
.TP
.B \-\-visual\-id
specify the ID of the visual to use. See
.BR xdpyinfo (1x)
for a list of visuals available in your display.
.B \-\-global_defaults_path
print the path where the files for the default configuration are installed and exit
.TP
.B \-\-help
print a brief help message
print the list of command line options supported, one per line, and exit
.TP
.BI \-\-locale " locale"
specify the locale (i18n language) to use; Window Maker will also set the variable
.B LANG
which will be inherited by all applications started from Window Maker
.TP
.B \-\-no\-autolaunch
do not launch at start-up the applications that were marked in the configuration as autolanched
.TP
.B \-\-no\-clip
do not show the workspace Clip
.TP
.B \-\-no\-dock
do not show the application Dock
.TP
.B \-\-no\-drawer
disable the Drawers in the Dock
.TP
.B \-\-static
do not update or save automatically the configuration
.TP
.B \-\-version
display Window Maker's version number and exit
.TP
.B \-\-visual\-id
specify the ID of the visual to use; see
.BR xdpyinfo (1x)
for a list of visuals available in your display
.PP
.SH FILES
.TP
@@ -88,7 +89,7 @@ files, user's files will be written to.
This script is automatically executed when Window Maker is started.
.TP
.B ~/GNUstep/Library/WindowMaker/exitscript
This script is automatically executed immediately before Window Maker is
This script is automatically executed immediately before Window Maker is
exited.
.B Note:
If you need to run something that requires the X server to be running
@@ -129,7 +130,7 @@ Guess... ;-)
.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"
.IP GNUSTEP_LOCAL_ROOT
specifies the location of the system-wide \fBlocal\fP GNUstep
directory (this is useful, for example, in those cases where the
@@ -158,4 +159,5 @@ Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>,
Dan Pascu <dan@windowmaker.info> with contributions from many people around
the Internet.
.PP
This manual page was written by Marcelo E. Magallon, <mmagallo@debian.org>.
This manual page was created by Marcelo E. Magallon, <mmagallo@debian.org>
and is maintained by the Window Maker team.

2
src/main.c
View File

@@ -438,6 +438,7 @@ static void print_help(void)
puts(_(" --no-dock do not open the application Dock"));
puts(_(" --no-clip do not open the workspace Clip"));
puts(_(" --no-autolaunch do not autolaunch applications"));
puts(_(" --no-drawer disable drawers in the dock"));
puts(_(" --dont-restore do not restore saved session"));
puts(_(" --locale locale locale to use"));
@@ -447,6 +448,7 @@ static void print_help(void)
#ifndef HAVE_INOTIFY
puts(_(" --no-polling do not periodically check for configuration updates"));
#endif
puts(_(" --global_defaults_path print the path for default config and exit"));
puts(_(" --version print version and exit"));
puts(_(" --help show this message"));
}