xoop.1 Added

@@ -0,0 +1,40 @@
+.TH XOOP 1
+.SH NAME
+.B xoop
+\- loop your X cursor around the edges of the screen
+.SH SYNOPSIS
+.B xoop
+[\fB\-x\fR | \fB\-y\fR]
+[\fB\-f\fR]
+[\fB\-d\fR]
+.SH DESCRIPTION
+.B xoop
+turns your desktop into a flat torus, so that when the cursor hits one side it
+continues and reappears out from the opposite side.
+.SH OPTIONS
+.TP
+.BR \-x
+Only allow looping parallel to the x axis.
+.TP
+.BR \-y
+Only allow looping parallel to the y axis.
+.TP
+.BR \-f
+Fork the process.
+.TP
+.BR \-d
+Print extra debug information while running.
+.TP
+.BR \-h
+Print a basic help message.
+.SH MULTIMONITOR
+xoop assumes that a multiple monitor setup creates a large rectangle with 4
+edges, for example if you have two monitors of the same height side-by-side. If
+your multi-monitor setup does not produce a large rectangle then the mouse will
+only teleport on the far outside edges. This is because it is not always clear
+where the mouse should teleport to. Contributions are welcome if you have a
+solution!
+.SH MULTIMONITOR
+xoop is maintained by Matt Colligan @ \fIhttps://mcol.xyz/code/xoop\fR
+.P
+Contributions/comments @ \fImcol@posteo.net\fR

readme Modified

@@ -9,7 +9,7 @@
                                           ██║
                                           ╚═╝
 
-Loop your X cursor around the screen
+Loop your X cursor around the edges of the screen
 
 👉😎👉
 
@@ -22,11 +22,11 @@
 Arguments
 ---------
 
--h  help
--f  fork
 -x  x axis only
 -y  y axis only
+-f  fork
 -d  debug mode
+-h  help
 
 
 To install
@@ -45,10 +45,12 @@
 Multimonitor
 ------------
 
-xoops assumes that a multiple monitor setup creates a large rectangle with 4
+xoop assumes that a multiple monitor setup creates a large rectangle with 4
 edges, for example if you have two monitors of the same height side-by-side. If
 your multi-monitor setup does not produce a large rectangle then the mouse will
-only teleport on the far outside edges.
+only teleport on the far outside edges. This is because it is not always clear
+where the mouse should teleport to. Contributions are welcome if you have a
+solution!
 
 
 Contact

makefile Modified

@@ -3,6 +3,7 @@
 CFLAGS 	  += -Wall -Wextra -pedantic -lxcb -lxcb-randr -lxcb-xinput -lxcb-xfixes
 PREFIX    ?= /usr/local
 BINPREFIX ?= $(PREFIX)/bin
+MANPREFIX ?= $(PREFIX)/man/man1
 
 all: clean $(OUT)
 
@@ -12,9 +13,13 @@
 install:
 	mkdir -p "$(DESTDIR)$(BINPREFIX)"
 	cp -pf "$(OUT)" "$(DESTDIR)$(BINPREFIX)"
+	mkdir -p "${DESTDIR}${MANPREFIX}"
+	cp -pf "${OUT}.1" "${DESTDIR}${MANPREFIX}"
+
 
 uninstall:
 	rm -f "$(DESTDIR)$(BINPREFIX)/$(OUT)"
+	rm -f "$(DESTDIR)$(MANPREFIX)/$(OUT).1"
 
 
 .PHONY: all debug clean install uninstall