summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon TURNEY <jon.turney@dronecode.org.uk>2012-11-04 11:23:03 +0000
committerJon TURNEY <jon.turney@dronecode.org.uk>2012-11-30 14:26:40 +0000
commit390a47dec246aee2e5e504b8873b834892e568f9 (patch)
treebcf3fb56bde84aa845aef7607b9247e6899b5371
parentf542f19f344ff951d271105d9cbddf523d9e1623 (diff)
Add a brief manpage
-rw-r--r--Makefile.am2
-rw-r--r--configure.ac1
-rw-r--r--man/Makefile.am1
-rw-r--r--man/xtow.man44
4 files changed, 47 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index af437a6..9f0d419 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1 +1 @@
-SUBDIRS = src
+SUBDIRS = src man
diff --git a/configure.ac b/configure.ac
index 0d0cb4e..21c2793 100644
--- a/configure.ac
+++ b/configure.ac
@@ -24,5 +24,6 @@ AC_PROG_INSTALL
PKG_CHECK_MODULES(XCWM, xcwm)
AC_CONFIG_FILES([Makefile
+ man/Makefile
src/Makefile])
AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..4464e37
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1 @@
+dist_man1_MANS=xtow.man
diff --git a/man/xtow.man b/man/xtow.man
new file mode 100644
index 0000000..debbe3c
--- /dev/null
+++ b/man/xtow.man
@@ -0,0 +1,44 @@
+.TH xtow 1
+.SH NAME
+xtow \- An X Compositing Window Manager for Microsoft Windows
+
+.SH SYNOPSIS
+.B xtow [ options ]
+
+.SH DESCRIPTION
+\fIxtow\fP is a Compositing Window Manager for the X Window System running on Microsoft Windows.
+
+\fIxtow\fP is designed to connect to a headless X server which supports the Composite extension,
+for example, \fIXorg(1)\fP using the xf86-video-dummy driver, and will draw the contents of X windows
+from that X server into native \fIWindows\fP windows.
+
+.SH OPTIONS
+\fIxtow\fP accepts the following command line switches, \fIall\fP of which are optional:
+
+.TP 8
+.B \-display [display]
+Specifies the X server display to connect to.
+.TP 8
+.B \-nodwm
+Do not use DWM, even if available (Windows Vista or later). per-pixel transparency will not be
+supported.
+.TP 8
+.B \-blur
+If DWM is available, use the glass effect to blur the image beneath transparent areas.
+
+.SH "WINDOW PROPERTIES"
+Partial conformance to ICCCM and EWMH standards.
+
+The widely used but non-standard _NET_WM_WINDOW_OPACITY window property sets the transparency of
+a window, with 0 being transparent and 0xffffffff being opaque.
+
+.SH "SEE ALSO"
+XWin(1).
+
+.SH BUGS
+Lots. This is a prototype for testing libXcwm at this stage.
+
+.SH AUTHORS
+xtow was written by Jon Turney. It uses libXcwm to do most of the heavy lifting of tracking
+X windows and talking xcb to the X server, and re-uses most of the code from \fIXWin(1)\fP's
+integrated window manager for managing the native windows.