Re: [PATCH] (6) Man page changes -- second attempt
On Sat, Nov 20, 2021 at 02:37:29PM -0700, Jaimos Skriletz wrote: > Lintian found a few minor typos in the manual pages. Patch attached. Thanks; applied them to my working branch. Ciao Dominik ^_^ ^_^ -- Dominik Vogt
Re: [PATCH] (6) Man page changes -- second attempt
On Wed, Nov 17, 2021 at 11:20 AM Thomas Adam wrote: > > On Wed, Nov 17, 2021 at 02:35:32PM +0100, Dominik Vogt wrote: > > On Tue, Nov 16, 2021 at 01:36:53AM +0100, Dominik Vogt wrote: > > > This is the full set of patches for splitting the man page, to be > > > applied to master. > > > > Second attempt. The style docs are not moved aound in the man > > page. The .section files have been renamed to .ad because > > asciidoc only evaluates "ifdef" in included files if they have a > > known extesion. ".adoc" cannot be used because the pattern rules > > in the Makefile.am would conflict. > > > > The patch stack has been reshuffled and patches have heen merged, > > and two new ones on top have been added. > > Thanks, Dominik. This applies cleanly now. I've also added an OVERVIEW > section to fvwm3all.adoc explaining how the man page is split up into > different sections. > > I'm going to merge this to master, albeit I'm hoping to create some additional > sections as well so it doesn't feel like this change is incomplete. > Lintian found a few minor typos in the manual pages. Patch attached. jaimos diff --git a/doc/fvwm3_manpage_source.adoc b/doc/fvwm3_manpage_source.adoc index d78b5d22..48f3d3b7 100644 --- a/doc/fvwm3_manpage_source.adoc +++ b/doc/fvwm3_manpage_source.adoc @@ -26,7 +26,7 @@ large, and you can scroll around within the desktop. The multiple disjoint desktops pretend there are really several screens to work at, but each screen is completely unrelated to the others. -Fvwm provides _keyboard accelerators_ that allow to perform practically +Fvwm provides _keyboard accelerators_ that allow one to perform practically all window manager functions, including moving and resizing windows and operating the menus, using keyboard shortcuts. @@ -2493,7 +2493,7 @@ AddToMenu RootMenu Menu styles describe the looks and behaviour like normal styles do for windows. Menu styles are assigned to individual or all menus, -and changing the menu style immediately affects all menus taht use +and changing the menu style immediately affects all menus that use it. (If a menu style is used from within a menu, the changes are applied the next time an affected menu is opened.) @@ -4012,7 +4012,7 @@ style. Moving a window to the edge of the screen can be used to drag the window to other pages. (See *EdgeScroll*, and the _EdgeMoveDelay_ style for more information.) + -Holding down _Alt_ disables snapping and allows to switch pages +Holding down _Alt_ disables snapping and allows one to switch pages without any delay. Interactive movement can be aborted with the _Escape_ key or any mouse button not set to place the window. By default mouse button 2 is set to cancel the move operation. To change this you may
Re: [PATCH] (6) Man page changes -- second attempt
On Wed, Nov 17, 2021 at 08:18:07PM +0100, Dominik Vogt wrote:
> On Wed, Nov 17, 2021 at 04:40:55PM +, Thomas Adam wrote:
> > I've also added an OVERVIEW
> > section to fvwm3all.adoc explaining how the man page is split up into
> > different sections.
>
> Shoudn't that go to fvwm3.1 as well?
I wouldn't have thought so -- in that, if you're reading fvwm3.1, you've
chosen that deliberately, or already read fvwm3all.1. In the same way that we
wouldn't add it to fvwm3{commands,menus,styles}.1
Kindly,
Thomas
Re: [PATCH] (6) Man page changes -- second attempt
On Wed, Nov 17, 2021 at 04:40:55PM +, Thomas Adam wrote: > On Wed, Nov 17, 2021 at 02:35:32PM +0100, Dominik Vogt wrote: > > On Tue, Nov 16, 2021 at 01:36:53AM +0100, Dominik Vogt wrote: > > > This is the full set of patches for splitting the man page, to be > > > applied to master. > > > > Second attempt. The style docs are not moved aound in the man > > page. The .section files have been renamed to .ad because > > asciidoc only evaluates "ifdef" in included files if they have a > > known extesion. ".adoc" cannot be used because the pattern rules > > in the Makefile.am would conflict. > > > > The patch stack has been reshuffled and patches have heen merged, > > and two new ones on top have been added. > > Thanks, Dominik. This applies cleanly now. Nice. > I've also added an OVERVIEW > section to fvwm3all.adoc explaining how the man page is split up into > different sections. Shoudn't that go to fvwm3.1 as well? Ciao Dominik ^_^ ^_^ -- Dominik Vogt
Re: [PATCH] (6) Man page changes -- second attempt
On Wed, Nov 17, 2021 at 02:35:32PM +0100, Dominik Vogt wrote: > On Tue, Nov 16, 2021 at 01:36:53AM +0100, Dominik Vogt wrote: > > This is the full set of patches for splitting the man page, to be > > applied to master. > > Second attempt. The style docs are not moved aound in the man > page. The .section files have been renamed to .ad because > asciidoc only evaluates "ifdef" in included files if they have a > known extesion. ".adoc" cannot be used because the pattern rules > in the Makefile.am would conflict. > > The patch stack has been reshuffled and patches have heen merged, > and two new ones on top have been added. Thanks, Dominik. This applies cleanly now. I've also added an OVERVIEW section to fvwm3all.adoc explaining how the man page is split up into different sections. I'm going to merge this to master, albeit I'm hoping to create some additional sections as well so it doesn't feel like this change is incomplete. The PR is here: https://github.com/fvwmorg/fvwm3/pull/637 Kindly, Thomas
Re: [PATCH] (6) Man page changes -- second attempt
On Tue, Nov 16, 2021 at 01:36:53AM +0100, Dominik Vogt wrote:
> This is the full set of patches for splitting the man page, to be
> applied to master.
Second attempt. The style docs are not moved aound in the man
page. The .section files have been renamed to .ad because
asciidoc only evaluates "ifdef" in included files if they have a
known extesion. ".adoc" cannot be used because the pattern rules
in the Makefile.am would conflict.
The patch stack has been reshuffled and patches have heen merged,
and two new ones on top have been added.
0001: Man page split (only one patch now)
0002,3,4: General cleanup in man page.
0005: (new) Remove "open look" and "xview" from man page.
0006: (new) Remove "GlobalOpts" from man page, code and oteher files.
Ciao
Dominik ^_^ ^_^
--
Dominik Vogt
From de749130845071272c41c34e84de2ebd8e6dc61d Mon Sep 17 00:00:00 2001
From: Dominik Vogt
Date: Mon, 15 Nov 2021 16:52:38 +0100
Subject: [PATCH 1/6] Split main man page.
fvwm3.1 basic documentation
fvwm3commands.1 command documentation
fvwm3all.1 all documentation
fvwm3menus.1 menu documentation
---
doc/.gitignore| 1 +
doc/{modules => }/FvwmAnimate.adoc| 0
doc/{modules => }/FvwmAuto.adoc | 0
doc/{modules => }/FvwmBacker.adoc | 0
doc/{modules => }/FvwmButtons.adoc| 0
doc/{bin => }/FvwmCommand.adoc| 0
doc/{modules => }/FvwmConsole.adoc| 0
doc/{modules => }/FvwmEvent.adoc | 0
doc/{modules => }/FvwmForm.adoc | 0
doc/{modules => }/FvwmIconMan.adoc| 0
doc/{modules => }/FvwmIdent.adoc | 0
doc/{modules => }/FvwmMFL.adoc| 0
doc/{modules => }/FvwmPager.adoc | 0
doc/{modules => }/FvwmPerl.adoc | 0
doc/{bin => }/FvwmPrompt.adoc | 0
doc/{modules => }/FvwmRearrange.adoc | 0
doc/{modules => }/FvwmScript.adoc | 0
doc/Makefile.am | 61 +-
doc/README| 8 -
doc/{bin => }/fvwm-config.adoc| 0
doc/{bin => }/fvwm-convert-2.6.adoc | 0
doc/{bin => }/fvwm-menu-desktop.adoc | 0
doc/{bin => }/fvwm-root.adoc | 0
doc/fvwm3.adoc| 7 +
.../fvwm3.adoc => fvwm3_manpage_source.adoc} | 545 +-
doc/fvwm3all.adoc | 7 +
doc/fvwm3commands.adoc| 7 +
doc/fvwm3menus.adoc | 7 +
doc/fvwm3styles.adoc | 7 +
29 files changed, 350 insertions(+), 300 deletions(-)
create mode 100644 doc/.gitignore
rename doc/{modules => }/FvwmAnimate.adoc (100%)
rename doc/{modules => }/FvwmAuto.adoc (100%)
rename doc/{modules => }/FvwmBacker.adoc (100%)
rename doc/{modules => }/FvwmButtons.adoc (100%)
rename doc/{bin => }/FvwmCommand.adoc (100%)
rename doc/{modules => }/FvwmConsole.adoc (100%)
rename doc/{modules => }/FvwmEvent.adoc (100%)
rename doc/{modules => }/FvwmForm.adoc (100%)
rename doc/{modules => }/FvwmIconMan.adoc (100%)
rename doc/{modules => }/FvwmIdent.adoc (100%)
rename doc/{modules => }/FvwmMFL.adoc (100%)
rename doc/{modules => }/FvwmPager.adoc (100%)
rename doc/{modules => }/FvwmPerl.adoc (100%)
rename doc/{bin => }/FvwmPrompt.adoc (100%)
rename doc/{modules => }/FvwmRearrange.adoc (100%)
rename doc/{modules => }/FvwmScript.adoc (100%)
rename doc/{bin => }/fvwm-config.adoc (100%)
rename doc/{bin => }/fvwm-convert-2.6.adoc (100%)
rename doc/{bin => }/fvwm-menu-desktop.adoc (100%)
rename doc/{bin => }/fvwm-root.adoc (100%)
create mode 100644 doc/fvwm3.adoc
rename doc/{fvwm3/fvwm3.adoc => fvwm3_manpage_source.adoc} (99%)
create mode 100644 doc/fvwm3all.adoc
create mode 100644 doc/fvwm3commands.adoc
create mode 100644 doc/fvwm3menus.adoc
create mode 100644 doc/fvwm3styles.adoc
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index ..38ff07fe
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+/*.ad
diff --git a/doc/modules/FvwmAnimate.adoc b/doc/FvwmAnimate.adoc
similarity index 100%
rename from doc/modules/FvwmAnimate.adoc
rename to doc/FvwmAnimate.adoc
diff --git a/doc/modules/FvwmAuto.adoc b/doc/FvwmAuto.adoc
similarity index 100%
rename from doc/modules/FvwmAuto.adoc
rename to doc/FvwmAuto.adoc
diff --git a/doc/modules/FvwmBacker.adoc b/doc/FvwmBacker.adoc
similarity index 100%
rename from doc/modules/FvwmBacker.adoc
rename to doc/FvwmBacker.adoc
diff --git a/doc/modules/FvwmButtons.adoc b/doc/FvwmButtons.adoc
similarity index 100%
rename from doc/modules/FvwmButtons.adoc
rename to doc/FvwmButtons.adoc
diff --git a/doc/bin/FvwmCommand.adoc b/doc/FvwmCommand.adoc
similarity index 100%
rename from doc/bin/FvwmCommand.adoc
rename to doc/FvwmCommand.adoc
diff --git a/doc/modules/FvwmConsole.adoc b/doc/FvwmConsole.adoc
similarity index
