Another round of Module updates.

* Combined FvwmPrompt, FvwmCommand, FvwmConsole, and FvwmMFL into a single SendToFvwm group. * Update the FvwmIdent page. * Some formatting changes, removed Module Description header, and put the table of contents under the main header.
fvwmorg · Apr 2, 2024 · b14cd00 · b14cd00
1 parent defb7b5
commit b14cd00
Show file tree

Hide file tree

Showing 19 changed files with 176 additions and 143 deletions.
diff --git a/Wiki/Modules/FvwmAnimate/index.md b/Wiki/Modules/FvwmAnimate/index.md
@@ -6,12 +6,10 @@ weight: 350
 description: |
   This module animates iconification and de-iconification on command.
 ---
-* TOC
-{:toc}
-
 # FvwmAnimate
 
-## Module Description
+* TOC
+{:toc}
 
 The FvwmAnimate module animates iconification and de-iconification or on command.  There are currently 6 different animation effects.
 

diff --git a/Wiki/Modules/FvwmAuto/index.md b/Wiki/Modules/FvwmAuto/index.md
@@ -9,12 +9,10 @@ description: |
   to automatically raise windows, which is in fact the module's default
   behaviour. This can also be used to auto show/hide a panel/dock.
 ---
-* TOC
-{:toc}
-
 # FvwmAuto
 
-## Module Description
+* TOC
+{:toc}
 
 The FvwmAuto module allows you to define actions for when the pointer enters
 and leaves a window after a specified delay, assuming you are using either
@@ -83,5 +81,5 @@ have more control and respond to more events, use [FvwmEvent](
 -------
 [^1]: This is not how EnterFocus and LeaveFocus operate, but from an
       explanation point of view, it suffices. FvwmAuto also can be configured to
-      respond to `-menter`, -menterleave`, or `-mfocus` events. See the
+      respond to `-menter`, `-menterleave`, or `-mfocus` events. See the
       manual page for more details.
diff --git a/Wiki/Modules/FvwmBacker/index.md b/Wiki/Modules/FvwmBacker/index.md
@@ -8,13 +8,8 @@ description: |
   Any command can be executed when changing desktops so this module can
   be used for more than just switching the background.
 ---
-* TOC
-{:toc}
-
 # FvwmBacker
 
-## Module Description
-
 The FvwmBacker module provides functionality to change the  background when
 changing  desktops.  Any command can be executed to change the backgrounds.
 Actually, any arbitrary command can be sent to fvwm to execute, so  you

diff --git a/Wiki/Modules/FvwmBanner/index.md b/Wiki/Modules/FvwmBanner/index.md
@@ -6,15 +6,11 @@ weight: 50
 description: |
   Displays an Fvwm Logo in the center of the screen for a set amount of time.
 ---
-* TOC
-{:toc}
 
 # FvwmBanner
 
 **Note:** This module has been removed from fvwm3.
 
-## Module Descrpition
-
 Displays an Fvwm Logo in the center of the screen for 3 seconds.
 
 An alternate pixmap can be specified, and the amount of time it's shown can be changed.

diff --git a/Wiki/Modules/FvwmButtons/index.md b/Wiki/Modules/FvwmButtons/index.md
@@ -6,14 +6,11 @@ weight: 800
 description: |
   FvwmButtons provides a method to build docks, panels, taskbars,
   and more.
-
 ---
-* TOC
-{:toc}
-
 # FvwmButtons
 
-## Module Description
+* TOC
+{:toc}
 
 The FvwmButtons module provides a window of buttons which can be used
 to build different type of [/Panels]({{ "/Panels" | prepend: site.wikiurl }}).

diff --git a/Wiki/Modules/FvwmConsole/index.md b/Wiki/Modules/FvwmConsole/index.md
diff --git a/Wiki/Modules/FvwmEvent/index.md b/Wiki/Modules/FvwmEvent/index.md
@@ -7,11 +7,11 @@ description: |
   FvwmEvent can be configured to trigger on specific events. When
   the event is triggered, the module can run any command.
 ---
+# FvwmEvent
+
 * TOC
 {:toc}
 
-# FvwmEvent
-
 *This page was originally written by Thomas Adam, and published in the          
 [Linux Gazete](https://linuxgazette.net/127/adam1.html){:target="_blank"},
 June 2006.*   

diff --git a/Wiki/Modules/FvwmForm/index.md b/Wiki/Modules/FvwmForm/index.md
@@ -7,13 +7,8 @@ description: |
   FvwmForm provides a way to build GUI forms that can be filled
   out and run custom commands.
 ---
-* TOC
-{:toc}
-
 # FvwmForm
 
-## Module Description
-
 FvwmForm provides a mechanism to get user input and act accordingly.
 This is achieved by means of a form that the user can fill out,
 and from which the user can select options he wants Fvwm to take.

diff --git a/Wiki/Modules/FvwmIconMan/index.md b/Wiki/Modules/FvwmIconMan/index.md
@@ -7,14 +7,11 @@ description: |
   FvwmIconMan provides a list of running applications. You can run one or
   multiple managers and they can be configured to display different
   collections of windows.
-
 ---
-* TOC
-{:toc}
-
 # FvwmIconMan
 
-## Module Description
+* TOC
+{:toc}
 
 The FvwmIconMan module provides a grid of Icons (Buttons) that represent
 the running windows on the system. FvwmIconMan can be configured to

diff --git a/Wiki/Modules/FvwmIdent/FvwmIdent_scrot.png b/Wiki/Modules/FvwmIdent/FvwmIdent_scrot.png
diff --git a/Wiki/Modules/FvwmIdent/index.md b/Wiki/Modules/FvwmIdent/index.md
@@ -2,23 +2,41 @@
 layout: wiki
 title: FvwmIdent
 type: module
-weight: 600
+weight: 730
 description: |
-  FvwmIdent will create a window which contains information on the
-  target window selected by the user.
-
+  FvwmIdent will create a window which contains information about
+  the selected window, including its class, resource, window id,
+  status of the window, and more.
 ---
-* TOC
-{:toc}
 
 # FvwmIdent
 
-## Module Description
+To launch FvwmIdent, you need to issue the following `Module` command
+to fvwm via a menu item, key binding, and so on.
+
+{% highlight fvwm %}
+Module FvwmIdent
+{% endhighlight %}
 
-The FvwmIdent module prompts the user to select a target window,
-if the module was not launched from within a window context in
-Fvwm. After that, it pops up a window with information about the
-window which was selected.
+Once run, use the mouse to select a window and a new window will open
+containing information about the window that can be useful when configuring
+or debugging fvwm. The class or resource of a window can be used to help
+better know what names to use when applying `Styles` to the window. It also
+contains other information such as its window id, current size and location,
+current state, which layer it is on, and so forth. Below is a screen shot
+of using FvwmIdent to identify FvwmIdent, to show what information to expect.
 
+![Screen shot of FvwmIdent's output display.](FvwmIdent_scrot.png){:.d-block .mx-auto .img-fluid}
 
+FvwmIdent can either be used as above, where you click on which window to
+identify, or used in a window context menu that can will identify the
+associated window without having to click on it. For example, the default
+configuration binds to a menu to the windows listed in the [FvwmIconMan](
+{{ "/Modules/FvwmIconMan" | prepend: site.wikiurl }}) that opens with
+a right click. Selecting identify from that menu will run FvwmIdent on
+the associated window. You can also identify windows using conditional
+commands. For example to identify the next xterm, use:
 
+{% highlight fvwm %}
+Next (xterm) Module FvwmIdent
+{% endhighlight %}
diff --git a/Wiki/Modules/FvwmPager/index.md b/Wiki/Modules/FvwmPager/index.md
@@ -7,14 +7,11 @@ description: |
   FvwmPager shows a ininature view of the Fvwm Desktops and Pages.
   This can be configured to show only the Current Desktop or any
   selection of Desktops.
-
 ---
-* TOC
-{:toc}
-
 # FvwmPager
 
-## Module Description
+* TOC
+{:toc}
 
 The FvwmPager module shows a miniature view of the Fvwm desktops which are
 specified in the command line. This is a useful reminder of where your

diff --git a/Wiki/Modules/FvwmRearrange/index.md b/Wiki/Modules/FvwmRearrange/index.md
@@ -6,12 +6,10 @@ weight: 750
 description: |
   FvwmRearrange can be used to tile or cascade windows.
 ---
-* TOC
-{:toc}
-
 # FvwmRearrange
 
-## Module Description
+* TOC
+{:toc}
 
 This module can be called to tile or cascade windows.
 

diff --git a/Wiki/Modules/FvwmScript/index.md b/Wiki/Modules/FvwmScript/index.md
@@ -8,13 +8,9 @@ description: |
   desktop accessories which can just display system info or be interactive.
 
 ---
-* TOC
-{:toc}
 
 # FvwmScript
 
-## Module Description
-
 The FvwmScript module allows you to build many graphical applications
 such as desktop accessories, button panel with pop up menus,
 modal dialogs, etc. At the startup, FvwmScript reads the file

diff --git a/Wiki/Modules/FvwmCommand/index.md → Wiki/Modules/SendToFvwm/FvwmCommand/index.md b/Wiki/Modules/FvwmCommand/index.md → Wiki/Modules/SendToFvwm/FvwmCommand/index.md
@@ -1,26 +1,18 @@
 ---
 layout: wiki
 title: FvwmCommand
-type: module
+type: sendtofvwm
 weight: 660
 description: |
   FvwmCommand is a python script which can send commands directly to to
   fvwm from any terminal or script, provided FvwmMFL is running.
 ---
-
 # FvwmCommand
 
-**Note:** In fvwm3, a new module [FvwmPrompt](
-{{ "/Modules/FvwmPrompt" | prepend: site.wikiurl }})
-exists that is a combination of FvwmCommand and [FvwmConsole](
-{{ "/Modules/FvwmConsole" | prepend: site.wikiurl }}).
-Though due to golang dependencies, this new module is not in wide use yet.
-If FvwmPrompt is installed, you should use it instead.
-
 FvwmCommand is a command line tool that allows you to send commands
 directly to fvwm from any terminal or shell by talking to the
-[FvwmMFL]({{ "/Modules/FvwmMFL" | prepend: site.wikiurl }}) socket.
-FvwmCommand then sends the command you give it directly to fvwm.
+[FvwmMFL]({{ "/Modules/SendToFvwm/FvwmMFL" | prepend: site.wikiurl }})
+socket. FvwmCommand then sends the command you give it directly to fvwm.
 For example to launch [FvwmPager](
 {{ "/Modules/FvwmPager" | prepend: site.wikiurl }}) from a terminal:
 
@@ -37,3 +29,8 @@ started FvwmMFL from your start function:
 AddToFunc StartFunction I Module FvwmMFL
 {% endhighlight %}
 
+**Note:** In fvwm3, if [FvwmPrompt](
+{{ "/Modules/SendToFvwm/FvwmPrompt" | prepend: site.wikiurl }})
+is installed, you should use that instead. FvwmPrompt can both send
+single commands exactly like FvwmCommand, it can also open an
+interactive shell that can be used to talk to fvwm.
diff --git a/Wiki/Modules/SendToFvwm/FvwmConsole/index.md b/Wiki/Modules/SendToFvwm/FvwmConsole/index.md
@@ -0,0 +1,54 @@
+---
+layout: wiki
+title: FvwmConsole
+type: sendtofvwm
+weight: 650
+description: |
+  FvwmConsole runs in a terminal (such as xterm) and allows one to send
+  commands to the running instance of fvwm. This is a very useful module
+  in testing new configurations.
+---
+# FvwmConsole
+
+The FvwmConsole module allows the user to type fvwm configuration commands
+into a terminal that are sent to fvwm to be executed immediately. This tool
+is particularly useful for testing new configuration ideas, or opening up
+a console to send fvwm commands without having previously configured a
+menu, button, keybinding, etc in the configuration file.
+
+{% highlight fvwm %}
+# Launch FvwmConsole when fvwm starts.
+AddToFunc StartFunction Module FvwmConsole
+
+# Add FvwmConsole to a menu
+AddToMenu MenuName
+...
++ "Fvwm&Console" Module FvwmConsole -terminal xterm
+{% endhighlight %}
+
+On fvwm3 and newer installs, FvwmConsole may no longer be installed.
+If launching FvwmConsole fails, then it has been replaced[^1] by [FvwmPrompt](
+{{ "/Modules/SendToFvwm/FvwmPrompt" | prepend: site.wikiurl }}),
+and you must use that instead. Another useful tool to send commands to
+send commands to fvwm is [FvwmCommand](
+{{ "/Modules/SendToFvwm/FvwmCommand" | prepend: site.wikiurl }}),
+which can be run from any current command line, without having
+to launch a full console.
+
+# Configuration Options
+
+FvwmConsole inherits its resources from the terminal it is ran in (xterm by
+default). You can append options to FvwmConsole to pass to the terminal to
+change the style of the terminal. You can also use the `-terminal` option
+to change the terminal FvwmConsole uses.
+
+{% highlight fvwm %}
+# Change FvwmConsole's style
+Module FvwmConsole -g 40x10 -fg black -bg green3
+
+# Change FvwmConsole's terminal
+Module FvwmConsole -terminal rxvt 
+{% endhighlight %}
+
+---
+[^1]: Fvwm will only build and install one of FvwmConsole or FvwmPrompt