Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manualpage formatting fixes/tweaks. #1006

Merged
merged 1 commit into from
Apr 11, 2024
Merged

Manualpage formatting fixes/tweaks. #1006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions doc/FvwmAuto.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ FvwmAuto - the fvwm auto-raise module

== SYNOPSIS

....
Module FvwmAuto Timeout [-passid] [-menter|-menterleave|-mfocus] [EnterCommand [LeaveCommand]]
....
**Module FvwmAuto Timeout [-passid] [-menter|-menterleave|-mfocus] [EnterCommand [LeaveCommand]]**

_FvwmAuto_ can only be invoked by fvwm. Command line invocation of the
_FvwmAuto_ will not work.
Expand Down Expand Up @@ -147,7 +145,5 @@ powerful. There is a short example in the _fvwm_ man page.

== AUTHOR

....
FvwmAuto just appeared one day, nobody knows how.
FvwmAuto was simply rewritten 09/96, nobody knows by whom.
....
4 changes: 1 addition & 3 deletions doc/FvwmButtons.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ FvwmButtons - the fvwm buttonbox module

== SYNOPSIS

....
Module FvwmButtons [-g geometry] [-transient | -transientpanel] [name[configfile]]
....
**Module FvwmButtons [-g geometry] [-transient | -transientpanel] [name[configfile]]**

_FvwmButtons_ can only be invoked by fvwm. Command line invocation of
the _FvwmButtons_ module will not work.
Expand Down
1 change: 1 addition & 0 deletions doc/FvwmCommand.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ FvwmCommand accepts the following command-line arguments:
Use unix socket (__filename__) to connect to __FvwmMFL__

-i [infolevel]::
+
----
0 - default
>0 - print output from FvwmMFL
Expand Down
16 changes: 8 additions & 8 deletions doc/FvwmConsole.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ bound to a menu or mouse button or keystroke to invoke it later.
FvwmConsole uses _xterm_(1). All resources set for xterm are inherited
unless overridden by command line options.

____
....
Module FvwmConsole -g 40x10 -fg black -bg green3
____
....

A different terminal emulator can be specified with the -terminal
option. However, only terminal programs that understand the options
-name, -title and -e can be used.

____
....
Module FvwmConsole -terminal rxvt
____
....

Previous versions of FvwmConsole supported a -e option to choose a
different front-end. Although this option is still provided for
Expand All @@ -59,10 +59,10 @@ what you are doing.

Also X resources can be set in your ~/.Xdefaults file:

____
....
FvwmConsole*VT100*geometry: 40x4 +
FvwmConsole*font: 7x14
____
....

== COMMAND EDITING

Expand All @@ -71,7 +71,7 @@ Overwise a simple input reading function which
doesn't have editing capabilities is used.
For more details, refer GNU readline man and info pages.

____
....
Ctrl-A::
- beginning of line
Ctrl-B::
Expand Down Expand Up @@ -102,7 +102,7 @@ Esc <::
- beginning of history
Esc >::
- end of history
____
....

== EXITING

Expand Down
10 changes: 4 additions & 6 deletions doc/FvwmEvent.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,7 @@ parameter.

== AUTHORS

....
1994 FvwmSound Mark Boyns (boyns@sdsu.edu)
1994 FvwmAudio Mark Scott (mscott@mcd.mot.com)
1996 FvwmAudio Albrecht Kadlec
1998 FvwmEvent Albrecht Kadlec (albrecht@auto.tuwien.ac.at)
....
* 1994 FvwmSound Mark Boyns (boyns@sdsu.edu)
* 1994 FvwmAudio Mark Scott (mscott@mcd.mot.com)
* 1996 FvwmAudio Albrecht Kadlec
* 1998 FvwmEvent Albrecht Kadlec (albrecht@auto.tuwien.ac.at)
182 changes: 99 additions & 83 deletions doc/FvwmIconMan.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,62 +80,63 @@ dislike of paging though a long man page, so here is a terse reference
chart describing the available options. They are described in more
detail in the next section.

....
Name Description Default

NumManagers number of managers 1
Action binds command to event Mouse 0 N sendcommand Iconify
Background default background gray
ButtonGeometry size of button in pixels
Colorset default colorset
DontShow list of windows to ignore
DrawIcons use mini icons false
FocusAndSelectButton flat grey black
FocusAndSelectColorset
FocusButton style for focused buttons up grey black
FocusColorset
FollowFocus show which win has focus false
Font 8x13
Foreground default text color white
Format describes button label "%c: %i"
IconName manager icon name FvwmIconMan
IconAndSelectButton up black grey
IconAndSelectColorset
IconButton style for icon buttons up black grey
IconColorset
ManagerGeometry size of manager in buttons 0x1
MaxButtonWidth max width of a button
MaxButtonWidthByColumns
NoIconAction animate iconification NOP
PlainButton style for normal buttons up black grey
PlainColorset
ReliefThickness size of button relief 2
Resolution window filters desk page
Reverse normal, icon or none none
SelectButton style for selected buttons flat black grey
SelectColorset
Shape use shape extension false
Show list of windows to show
ShowOnlyIcons only icons visible false
ShowNoIcons icons are not displayed false
ShowTransient transient windows visible false
ShowOnlyFocused only focused visible false
Sort keep managers sorted name
SortWeight weight for sorting
Tips Tool Tips mode none
TipsDelays Tool Tips mapping delays 1000 300
TipsFont Font for Tool Tips default fvwm font
TipsColorset Tool Tips Colorset 0
TipsFormat describes Tips label the Format value
TipsBorderWidth Tool Tips border size 1
TipsPlacement Tips placement vs button updown
TipsJustification Tips Just vs button leftup
TipsOffsets Tips placement Offsets 3 2
Title manager title FvwmIconMan
TitleButton style for title button raisededge black grey
TitleColorset
UseWinList honor WinListSkip? true
....
[cols="<,<,<"]
|===
|Name |Description |Default

|NumManagers |number of managers |1
|Action |binds command to event |Mouse 0 N sendcommand Iconify
|Background |default background |gray
|ButtonGeometry |size of button in pixels |
|Colorset |default colorset |
|DontShow |list of windows to ignore |
|DrawIcons |use mini icons |false
|FocusAndSelectButton| |flat grey black
|FocusAndSelectColorset| |
|FocusButton |style for focused buttons |up grey black
|FocusColorset | |
|FollowFocus |show which win has focus |false
|Font | |8x13
|Foreground |default text color |white
|Format |describes button label |"%c: %i"
|IconName |manager icon name |FvwmIconMan
|IconAndSelectButton| |up black grey
|IconAndSelectColorset| |
|IconButton |style for icon buttons |up black grey
|IconColorset | |
|ManagerGeometry |size of manager in buttons |0x1
|MaxButtonWidth |max width of a button |
|MaxButtonWidthByColumns| |
|NoIconAction |animate iconification |NOP
|PlainButton |style for normal buttons |up black grey
|PlainColorset | |
|ReliefThickness |size of button relief |2
|Resolution |window filters |desk page
|Reverse |normal, icon or none |none
|SelectButton |style for selected buttons |flat black grey
|SelectColorset | |
|Shape |use shape extension |false
|Show |list of windows to show |
|ShowOnlyIcons |only icons visible |false
|ShowNoIcons |icons are not displayed |false
|ShowTransient |transient windows visible |false
|ShowOnlyFocused |only focused visible |false
|Sort |keep managers sorted |name
|SortWeight |weight for sorting |
|Tips |Tool Tips mode |none
|TipsDelays |Tool Tips mapping delays |1000 300
|TipsFont |Font for Tool Tips |default fvwm font
|TipsColorset |Tool Tips Colorset |0
|TipsFormat |describes Tips label |the Format value
|TipsBorderWidth |Tool Tips border size |1
|TipsPlacement |Tips placement vs button |updown
|TipsJustification |Tips Just vs button |leftup
|TipsOffsets |Tips placement Offsets |3 2
|Title |manager title |FvwmIconMan
|TitleButton |style for title button |raisededge black grey
|TitleColorset | |
|UseWinList |honor WinListSkip? |true
|===

== CONFIGURATION OPTIONS

Expand Down Expand Up @@ -298,13 +299,12 @@ only show windows (not) on the stated page.
+
_[!]screen [S]_ shows windows (not) on monitor _S_, which can be:
+
> _NAME_: The "NAME" of the specific RandR monitor.
+
> _c_: The current RandR monitor (containing the pointer)
+
> _p_: The primary RandR monitor
+
> _g_: The global monitor
--
* _NAME_: The "NAME" of the specific RandR monitor.
* _c_: The current RandR monitor (containing the pointer)
* _p_: The primary RandR monitor
* _g_: The global monitor
--
+
Since all windows are on the global monitor, _screen g_ effectively does
nothing. _c_ is the current monitor at the time resolution is issued, and
Expand Down Expand Up @@ -373,7 +373,7 @@ the sort type is set to _weighted_.
If _true_, then honor the WinListSkip style flag. Otherwise, all
windows are subject to possible management according to the show and
dontshow lists.

+
The two following options control which windows get handled by which
managers. A manager can get two lists, one of windows to show, and one
of windows to ignore. If only the _show_ list is given, then that
Expand Down Expand Up @@ -403,7 +403,7 @@ than one manager, then the manager with the lowest id gets it.
Only windows that are not iconified are shown if _boolean_ is true.
*FvwmIconMan: [id] ShowOnlyFocused boolean::
Only window with the focus is shown if _boolean_ is true.

+
The following two options control tips.

*FvwmIconMan: [id] Tips value::
Expand Down Expand Up @@ -577,53 +577,72 @@ sendcommand Command::
warp::
Warps cursor to current button, if any.

*Examples:* gotobutton select, gotobutton Down, select
*Examples:*

....
gotobutton select, gotobutton Down, select
....

Selects the button below the currently selected button. Since the
current button is already initialized to the selected button, this may
be shortened to "gotobutton Down, select".

....
gotobutton Up, select
....

Selects the button above the currently selected button.

....
gotobutton 0, select
....

Selects the first button of the current manager. If there is no current
manager, which is the case when no button is selected, then this does
nothing.

....
gotobutton -1, select
....

Selects the last button of the current manager.

....
gotobutton focus, select
....

Selects the button corresponding to the focused window.

....
gotobutton focus, Iconify
....

Sends the fvwm command Iconify to the focused window. Note that this
does not change the selected button.

....
bif Next 3, gotobutton 0, select, ret, gotobutton Next, select
....

If a button is selected, and it's the last button, go to button 0. If
it's not the last button, go to the next button. Otherwise, do nothing.
Basically, this action cycles through all buttons in the current
manager.

bif select 7, bif focus 3, gotomanager 0, select, ret, gotobutton focus,
\ select, ret, gotobutton down, select
....
bif select 7, bif focus 3, gotomanager 0, select, ret, gotobutton focus, \
select, ret, gotobutton down, select
....

This is good for sending to FvwmIconMan with a SendToModule command. If
there is a selected button, it moves down. Otherwise, if there is a
focused button, it is selected. Otherwise, button 0 of manager 0 gets
selected.

bif select Select, bif focus Focus, gotomanager 0, select, ret, label
Focus, \ gotobutton focus, select, ret, label Select, gotobutton down,
select
....
bif select Select, bif focus Focus, gotomanager 0, select, ret, label Focus, \
gotobutton focus, select, ret, label Select, gotobutton down, select
....

Same as previous, but using the label instruction.

Expand Down Expand Up @@ -744,17 +763,14 @@ Brady Montz (bradym@cs.arizona.edu).

== THANKS

....
Thanks to:
David Berson <berson@cs.pitt.edu>,
Gren Klanderman <greg@alphatech.com>,
David Goldberg <dsg@mitre.org>,
Pete Forman <gsez020@compo.bedford.waii.com>,
Neil Moore <amethyst@maxwell.ml.org>,
Josh M. Osborne <stripes@va.pubnix.com,
Adam Rice <wysiwyg@glympton.airtime.co.uk>,
Chris Siebenmann <cks@hawkwind.utcs.toronto.edu>,
Bjorn Victor <victor@delial.docs.uu.se>.

David Berson <berson@cs.pitt.edu>,
Gren Klanderman <greg@alphatech.com>,
David Goldberg <dsg@mitre.org>,
Pete Forman <gsez020@compo.bedford.waii.com>,
Neil Moore <amethyst@maxwell.ml.org>,
Josh M. Osborne <stripes@va.pubnix.com,
Adam Rice <wysiwyg@glympton.airtime.co.uk>,
Chris Siebenmann <cks@hawkwind.utcs.toronto.edu>,
Bjorn Victor <victor@delial.docs.uu.se>,
for contributing either code or truly keen ideas.
....
2 changes: 1 addition & 1 deletion doc/FvwmPager.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ done about this - except not using SloppyFocus in the pager.
desktop. Pair this with _MonitorLabels_ to change the desktop of each
monitor by clicking on their label.

*FvwmPager: IsNotShared:
*FvwmPager: IsNotShared::
This setting turns off the previous, _IsShared_, setting.

== AUTHOR
Expand Down
Loading
Loading