Added a man page

1 files changed, 102 insertions, 0 deletions

diff --git a/doc/FvwmIvyRelay.1 b/doc/FvwmIvyRelay.1
new file mode 100644
index 0000000..d470786
--- /dev/null
+++ b/doc/FvwmIvyRelay.1
@@ -0,0 +1,102 @@
+.\"
+.\"	FvwmIvyRelay \- a relay between Fvwm2 and an Ivy bus
+.\"
+.\"	Copyright (C) 2000
+.\"	Stéphane Chatty, France
+.\"
+.\" 
+.de EX		\"Begin example
+.ne 5
+.if n .sp 1
+.if t .sp .5
+.nf
+.in +.25i
+..
+.de EE
+.fi
+.in -.25i
+.if n .sp 1
+.if t .sp .5
+..
+.ta .2i .4i .6i .8i
+.TH FvwmIvyRelay 1 "Jul 11, 2000"
+
+.SH NAME
+.B FvwmIvyRelay
+- a relay module between Fvwm2 and an Ivy bus
+
+.SH SYNOPSIS
+.B FvwmIvyRelay
+must be spawned by fvwm.
+It will not run from the command line or a visual
+shell.
+
+.B FvwmIvyRelay
+will be launched by fvwm if the appropriate instructions are present in the
+.I .fvwm2rc
+file, either as a line instruction:
+.EX
+Module FvwmIvyRelay
+.EE
+or through functions, as in the following InitFunction and RestartFunction:
+.EX
+AddToFunc "InitFunction" "I" Module FvwmPager 0 8
++   "I" Module  FvwmIvyRelay
+
+AddToFunc "RestartFunction" "I" Module  Module FvwmPager 0 8
++	"I" Module	FvwmIvyRelay
+.EE
+
+.SH DESCRIPTION
+.B FvwmIvyRelay
+is a fvwm module that allows all applications connected to an Ivy bus to talk
+with fvwm, sending fvwm commands or being notified of window-management-related
+events.
+
+.SH COMMANDS
+.B FvwmIvyRelay
+connects to the Ivy bus as soon as it is launched, and
+subscribes to all messages of the form
+.EX
+.I FVWM <fvwm command>.
+.EE
+All commands received in such messages are retransmitted to fvwm that executes
+them. Examples:
+.EX
+FVWM Desk 1
+FVWM Restart fvwm2
+.EE
+The list of allowed command can be found in the documentation of fvwm2.
+
+.SH EVENTS
+.B FvwmIvyRelay
+translates all the events it receives from fvwm into Ivy messages. The
+following events are available:
+
+.EX
+FVWM:display Page id=<page-id> x=<x> y=<y> maxx=<maxx> maxy=<maxy>
+FVWM:display ChangedDesk id=<desk-id>
+FVWM:display New Window id=<win-id> x=<x> y=<y> w=<w> h=<h> desk=<desk-id>
+FVWM:display Configured Window id=<win-id> x=<x> y=<y> w=<w> h=<h> desk=<desk-id>
+FVWM:display Raised Window id=<win-id>
+FVWM:display Lower Window id=<win-id>
+FVWM:display Destroyed Window id=<win-id>
+.EE
+
+.SH CONFIGURATION
+None so far. Future configuration should include the list of events types to be
+retransmitted on the bus, and the bus address to use.
+
+.SH BUGS
+This is a very early version. The syntax of events should be improved. Data
+requests should probably be added. This documentation should be more
+descriptive, especially as regards events. Configuration should be added. No
+other bug reported so far.
+
+
+.SH SEE ALSO
+fvwm2(1), Ivy(1)
+
+.SH AUTHOR
+.nf
+Stéphane Chatty <chatty@free.fr>