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.

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

Doc: split manpages into sections #637

Merged
merged 7 commits into from
Nov 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion dev-docs/COMMANDS
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ The recognized commands for fvwm 2.6.6 (from cvs) as of 09-Sep-2014:
Focus - Give focus to a window
FocusStyle - Configure focus and raise policy for windows
Function - Execute a user defined function, see AddToFunc
GlobalOpts - (obsolete, use corresponding Style * instead)
GnomeButton - Pass mouse button presses on root to GNOME program
GnomeShowDesks - Limit GNOME pager to the number of desks
GotoDesk - Switch viewport to another desk same page
Expand Down
1 change: 0 additions & 1 deletion dev-docs/PARSING.md
Original file line number Diff line number Diff line change
Expand Up @@ -1819,7 +1819,6 @@ CMD_WINDOWSHADEANIMATE = "WindowShadeAnimate" ; Style * WindowShadeSteps
CMD_WINDOWSDESK = "WindowsDesk" ; See 'MoveToDesk'
CMD_DESK = "Desk" ; See 'Gotodesk'
CMD_EDGERESISTANCE = "EdgeResistance" ; Style * EdgeMoveDelay, EdgeMoveResistance
CMD_GLOBALOPTS = "GlobalOpts" ; Various Style options
CMD_HIDEGEOMETRYWINDOW = "HideGeometryWindow" ; GeometryWindow Hide
CMD_HILIGHTCOLOR = "HilightColor" ; Style
CMD_ICONFONT = "IconFont" FONTNAME ; Style
Expand Down
1 change: 1 addition & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/*.ad
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
61 changes: 31 additions & 30 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
docdir = @FVWM_DOCDIR@
MODULE_ADOCS = $(wildcard fvwm3/fvwm3.adoc bin/*.adoc modules/*.adoc)
MODULE_ADOC = \
fvwm3.adoc \
fvwm3all.adoc \
fvwm3commands.adoc \
fvwm3menus.adoc \
fvwm3styles.adoc \
$(wildcard Fvwm*.adoc) \
$(wildcard fvwm-*.adoc)

EXTRA_DIST = $(MODULE_ADOCS)
EXTRA_DIST = $(MODULE_ADOC)

if FVWM_BUILD_MANDOC
BUILD_MANS = $(patsubst %.adoc,%, $(MODULE_ADOCS))
else
BUILD_MANS =
endif

all: docs
docs: $(BUILD_MANS)
nothing:

clean:
rm -fr man1/
rm -f *.1 *.ad

distclean-local: clean

if FVWM_BUILD_MANDOC
QUIET_ASCIIDOC = @echo ' ' DOC ' ' $@'.1';

%: %.adoc
$(QUIET_ASCIIDOC) \
NAME=`basename "$@" | "$(SED)" -e "${transform}"`; \
$(ASCIIDOC) -b manpage $< -o "man1/$$NAME.1"

install-data-local:
install -d -m 755 $(DESTDIR)$(mandir)/man1/
@for i in $(notdir $(BUILD_MANS)); do \
NAME=`basename "$$i" | "$(SED)" -e "${transform}"`; \
install -m 644 "man1/$$NAME.1" $(DESTDIR)$(mandir)/man1/; \
done

uninstall-local:
@for i in $(notdir $(BUILD_MANS)); do \
NAME=`basename "$$i" | "$(SED)" -e "${transform}"`; \
rm -f "$(DESTDIR)$(mandir)/man1/$$NAME.1"; \
done
man1_MANS = $(patsubst %.adoc,%.1, $(MODULE_ADOC))
EXTRACT_SECTIONS = \
commands \
menus \
styles
SECTION_FILES = $(patsubst %,fvwm3_%.ad, $(EXTRACT_SECTIONS))

all: docs
docs: $(man1_MANS)
$(man1_MANS): $(SECTION_FILES)

%.ad: fvwm3_manpage_source.adoc
SECTION=$(patsubst fvwm3_%.ad,%,$@); \
cat "$<" | \
"$(GREP)" -A 1000000 -- "^// BEGIN '$$SECTION'" | \
"$(GREP)" -B 1000000 -- "^// END '$$SECTION'" | \
"$(GREP)" -v "^// .* '$$SECTION'" > "$@"

%.1: %.adoc
"$(ASCIIDOC)" -b manpage -a "$(patsubst %.1,%,$@)" "$<" -o "$@"
endif
8 changes: 0 additions & 8 deletions doc/README
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,3 @@ For more information about the specific markup available, see:

* https://asciidoctor.org/docs/asciidoc-writers-guide/
* https://asciidoctor.org/docs/user-manual/

To add additional documents, see:

doc/fvwm3/*.adoc
doc/modules/*.adoc

Documentation for modules now resides under `doc/`, rather than its own
module.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions doc/fvwm3.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= FVWM3(1)

== NAME

fvwm3 - F? Virtual Window Manager for X11

include::fvwm3_manpage_source.adoc[]
Loading