Skip to content

Commit

Permalink
Man page cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
lgsobalvarro authored Jun 21, 2021
1 parent 5385696 commit c34e1c3
Showing 1 changed file with 28 additions and 111 deletions.
139 changes: 28 additions & 111 deletions doc/fvwm3/fvwm3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ Any module started by command line arguments is assumed to be a module
that sends back config commands. All command line modules have to quit
before fvwm proceeds on to the StartFunction and setting border
decorations and styles. There is a potential deadlock if you start a
module other than *FvwmCpp*/*FvwmM4*/*FvwmPerl* but there is a timeout
so fvwm eventually gets going.
module other than *FvwmPerl* but there is a timeout so fvwm eventually
gets going.
+
As an example, starting the pager this way hangs fvwm until the timeout,
but the following should work well:
Expand Down Expand Up @@ -125,8 +125,8 @@ a multi-screen display.
*-V* | *--version*::

Prints the version of fvwm to _stderr_. Also prints an information about
the compiled in support for readline, xpm, png, svg, GNOME hints,
EWMH hints, session management, bidirectional text, multibyte
the compiled in support for readline, xpm, png, svg, EWMH hints,
session management, bidirectional text, multibyte
characters, RandR and Xft aa font rendering.

*-C* | *--visual* _visual-class_::
Expand Down Expand Up @@ -564,7 +564,6 @@ AddToFunc StartFunction
DestroyFunc InitFunction
AddToFunc InitFunction
+ I Module FvwmBanner
+ I Module FvwmIconMan
+ I Exec xsetroot -solid cyan
+ I Exec xterm
Expand All @@ -574,9 +573,6 @@ DestroyFunc RestartFunction
AddToFunc RestartFunction
+ I Module FvwmIconMan
DestroyFunc SessionInitFunction
AddToFunc SessionInitFunction
+ I Module FvwmBanner

This comment has been minimized.

Copy link
@somiaj

somiaj Jun 21, 2021

I don't think you want to clobber the SessionInitFunction example, maybe think of something else to do with it.

DestroyFunc SessionRestartFunction
AddToFunc SessionRestartFunction
Expand All @@ -590,7 +586,6 @@ note, all these special functions may be emulated now using
....
DestroyFunc StartFunction
AddToFunc StartFunction
+ I Test (Init) Module FvwmBanner

This comment has been minimized.

Copy link
@somiaj

somiaj Jun 21, 2021

Same issue here, I wouldn't clobber the + I Test (Init) example, as this is useful, just needs something besides FvwmBanner.

+ I Module FvwmPager * *
+ I Test (Restart) Beep
Expand Down Expand Up @@ -863,12 +858,6 @@ AddToFunc UrgencyDoneFunc
+ I Nop
....

== GNOME COMPLIANCE

Fvwm attempts to be GNOME (version 1) compliant. Check
_http://www.gnome.org_ for what that may mean. To disable GNOME hints
for some or all windows, the _GNOMEIgnoreHints_ style can be used.

== EXTENDED WINDOW MANAGER HINTS

Fvwm attempts to respect the extended window manager hints (ewmh or EWMH
Expand Down Expand Up @@ -3622,41 +3611,26 @@ instead.
relative pathname, fvwm looks into each directory listed in turn, and
uses the first file found.
+
If a directory is given in the form "/some/dir;.ext", this means all
images in this directory have the extension ".ext" that should be
forced. The original image name (that may contain another extension or
no extension at all) is not probed, instead ".ext" is added or
replaces the original extension. This is useful, for example, if a
user has some image directories with ".xpm" images and other image
directories with the same names, but ".png" images.
If a directory is given in the form "/some/dir;.ext", this means all
images in this directory have the extension ".ext" that should be
forced. The original image name (that may contain another extension or
no extension at all) is not probed, instead ".ext" is added or
replaces the original extension. This is useful, for example, if a
user has some image directories with ".xpm" images and other image
directories with the same names, but ".png" images.
+
The _path_ may contain environment variables such as _$HOME_ (or
_$\{HOME}_). Further, a '+' in the _path_ is expanded to the previous
value of the path, allowing appending or prepending to the path
easily.
The _path_ may contain environment variables such as _$HOME_ (or
_$\{HOME}_). Further, a '+' in the _path_ is expanded to the previous
value of the path, allowing appending or prepending to the path
easily.
+
For example:
For example:

This comment has been minimized.

Copy link
@somiaj

somiaj Jun 21, 2021

Are these tabs actually needed, most of the document only tabs the first paragraph, then the others are all joined between +?

+

....
ImagePath $HOME/icons:+:/usr/include/X11/bitmaps
....

+
Note: if the *FvwmM4* module is used to parse your _config_ files,
then m4 may want to mangle the word "include" which frequently shows
up in the *ImagePath* command. To fix this one may add
+

....
undefine(`include')
....

+
prior to the *ImagePath* command, or better: use the *-m4-prefix*
option to force all *m4* directives to have a prefix of "m4_" (see the
*FvwmM4* man page).

*LocalePath* _path_::
Specifies a colon separated list of "locale path" in which to search
for string translations. A locale path is constituted by a directory
Expand Down Expand Up @@ -5175,8 +5149,8 @@ _StartsOnPageIgnoresTransients_, _IconTitle_ / _!IconTitle_,
_MwmButtons_ / _FvwmButtons_, _MwmBorder_ / _FvwmBorder_, _MwmDecor_ /
_!MwmDecor_, _MwmFunctions_ / _!MwmFunctions_, _HintOverride_ /
_!HintOverride_, _!Button_ / _Button_, _ResizeHintOverride_ /
_!ResizeHintOverride_, _OLDecor_ / _!OLDecor_, _GNOMEUseHints_ /
_GNOMEIgnoreHints_, _StickyIcon_ / _SlipperyIcon_,
_!ResizeHintOverride_, _OLDecor_ / _!OLDecor_, /
_StickyIcon_ / _SlipperyIcon_,
_StickyAcrossPagesIcon_ / _!StickyAcrossPagesIcon_,
_StickyAcrossDesksIcon_ / _!StickyAcrossDesksIcon_, _ManualPlacement_
/ _CascadePlacement_ / _MinOverlapPlacement_ /
Expand Down Expand Up @@ -6611,13 +6585,6 @@ _OLDecor_ makes fvwm attempt to recognize and respect the olwm and
olvwm hints that many older XView and OLIT applications use. Switch
this option off with _NoOLDecor_.
+
With _GNOMEIgnoreHints_ fvwm ignores all GNOME hints for the window,
even if GNOME compliance is compiled in. This is useful for those
pesky applications that try to be more clever than the user and use
GNOME hints to force the window manager to ignore the user's
preferences. The _GNOMEUseHints_ style switches back to the default
behavior.
+
_UseDecor_ This style is deprecated and will be removed in the future.
There are plans to replace it with a more flexible solution in
fvwm-3.0.
Expand Down Expand Up @@ -8093,19 +8060,7 @@ section *Conditional Commands* for the meaning of return codes).
*SetEnv* _variable_ _value_::
Set an environment variable to a new value, similar to the shell's
export or setenv command. The _variable_ and its _value_ are inherited
by processes started directly by fvwm. This can be especially useful
in conjunction with the *FvwmM4* module. For example:
+

....
SetEnv height HEIGHT
....

+
makes the *FvwmM4* set variable _HEIGHT_ usable by processes started
by fvwm as the environment variable _$height_. If _value_ includes
whitespace, you should enclose it in quotes. If no _value_ is given,
the variable is deleted.
by processes started directly by fvwm.

*Silent* _command_::
A number of commands require a window to operate on. If no window was
Expand Down Expand Up @@ -8867,18 +8822,14 @@ Module FvwmForm MyForm
At the current time the available modules (included with fvwm) are
*FvwmAnimate* (produces animation effects when a window is iconified
or de-iconified), *FvwmAuto* (an auto raise module), *FvwmBacker* (to
change the background when you change desktops), *FvwmBanner* (to
display a spiffy XBM, XPM, PNG or SVG), *FvwmButtons* (brings up a
customizable tool bar), *FvwmCommandS* (a command server to use with
shell's FvwmCommand client), *FvwmConsole* (to execute fvwm commands
directly), *FvwmCpp* (to preprocess your _config_ with cpp),
*FvwmEvent* (trigger various actions by events), *FvwmForm* (to bring
up dialogs), *FvwmIconMan* (a flexible icon manager), *FvwmIdent* (to
get window info), *FvwmM4* (to preprocess your _config_ with m4),
*FvwmPager* (a mini version of the desktop), *FvwmPerl* (a Perl
manipulator and preprocessor), *FvwmProxy* (to locate and control
obscured windows by using small proxy windows), *FvwmRearrange* (to
rearrange windows), *FvwmScript* (another powerful dialog toolkit),
change the background when you change desktops), *FvwmButtons* (brings
up a customizable tool bar), *FvwmConsole* (to execute fvwm commands
directly), *FvwmEvent* (trigger various actions by events), *FvwmForm*
(to bring up dialogs), *FvwmIconMan* (a flexible icon manager),
*FvwmIdent* (to get window info), *FvwmMFL* (a front-loader module),
*FvwmPager* (a mini version of the desktop), *FvwmPerl* (a Perl manipulator
and preprocessor), *FvwmRearrange* (to rearrange windows), *FvwmScript*
(another powerful dialog toolkit).
These modules have their own man pages. There may be other modules out
on there as well.
+
Expand Down Expand Up @@ -9008,16 +8959,9 @@ different screens works independently.
The same as *Restart* without parameters but the name for the current
window manager is replaced with the specified _window_manager_ and
original arguments are preserved.
+
This command is useful if you use initial arguments like
+

....
-cmd FvwmCpp
....

+
and want to switch to another fvwm version without losing the initial
To switch to another fvwm version without losing the initial
arguments.
*Restart* *--dont-preserve-state* [_other-params_]::
The same as
Expand Down Expand Up @@ -9055,27 +8999,6 @@ color (often based on the background color), background face (this
includes images and all kinds of gradients). There is a way to render
background face and specify other color operations.

In the 2.4.x versions a special module *FvwmTheme* was introduced to
manage colorsets. Starting with the 2.5.x beta version, the *FvwmTheme*
functionality was moved to the core fvwm, so this module became
obsolete. In 2.6.7 the *FvwmTheme* module was removed.

The old syntax:

....
DestroyModuleConfig FvwmTheme: *
*FvwmTheme: Colorset 0 fg black, bg rgb:b4/aa/94
*FvwmTheme: Colorset 1 fg black, bg rgb:a1/b2/c8
....

corresponds to the new syntax:

....
CleanupColorsets
Colorset 0 fg black, bg rgb:b4/aa/94
Colorset 1 fg black, bg rgb:a1/b2/c8
....

*Colorset* _num_ [_options_]::
Creates or modifies colorset _num_. Colorsets are identified by this
number. The number can start at zero and can be a very large number.
Expand All @@ -9099,12 +9022,6 @@ By convention, colorsets are numbered like this:
# 7 = hilight colors
....

+
If you need to have more colors and do not want to reinvent the wheel,
you may use the convention used in fvwm-themes, it defines the meaning
of the first 40 colorsets for nearly all purposes:
+
_http://fvwm-themes.sourceforge.net/doc/colorsets_
+
Each colorset has four colors, an optional pixmap and an optional
shape mask. The four colors are used by modules as the foreground,
Expand Down

0 comments on commit c34e1c3

Please sign in to comment.