From b05a82f3bb868cd2bc17e5541fc3271b6ffc4216 Mon Sep 17 00:00:00 2001 From: Jon TURNEY Date: Sat, 15 Jun 2013 13:46:51 +0100 Subject: Add some content to manpage Add some basic content to the manpage Install manpage into section 1 --- .gitignore | 1 + Makefile.am | 3 +-- configure.ac | 2 +- xwinclip.man | 4 ---- xwinclip.man.in | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 56 insertions(+), 7 deletions(-) delete mode 100644 xwinclip.man create mode 100644 xwinclip.man.in diff --git a/.gitignore b/.gitignore index f6309c9..d142a83 100644 --- a/.gitignore +++ b/.gitignore @@ -22,4 +22,5 @@ missing mkinstalldirs stamp-h1 xwinclip.exe +xwinclip.man xwinclip.pc diff --git a/Makefile.am b/Makefile.am index eb1d199..da79fb2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -14,8 +14,7 @@ libXWinclip_la_SOURCES = \ libXWinclip_la_LDFLAGS = -static -no-undefined -man_MANS = xwinclip.man -EXTRA_DIST = $(man_MANS) +man1_MANS = xwinclip.man bin_PROGRAMS = xwinclip xwinclip_SOURCES = main.c debug.c diff --git a/configure.ac b/configure.ac index abeed74..7390b59 100644 --- a/configure.ac +++ b/configure.ac @@ -39,5 +39,5 @@ case $host_os in ;; esac -AC_CONFIG_FILES([xwinclip.pc Makefile]) +AC_CONFIG_FILES([xwinclip.pc xwinclip.man Makefile]) AC_OUTPUT diff --git a/xwinclip.man b/xwinclip.man deleted file mode 100644 index 71d791f..0000000 --- a/xwinclip.man +++ /dev/null @@ -1,4 +0,0 @@ -.TH XWINCLIP 1 __xorgversion__ -.SH NAME -xwinclip - diff --git a/xwinclip.man.in b/xwinclip.man.in new file mode 100644 index 0000000..3a9d251 --- /dev/null +++ b/xwinclip.man.in @@ -0,0 +1,53 @@ +.TH xwinclip 1 @PACKAGE_VERSION@ +.SH NAME +xwinclip - An X11 and Windows clipboard integration tool + +.SH SYNOPSIS +.B xwinclip [OPTION]... + +.SH DESCRIPTION +\fIxwinclip\fP is a tool for copying and pasting text between the Windows and X11 clipboard systems. + +\fIxwinclip\fP watches for updates to either clipboard and copies data between them when either one is updated. + +\fIxwinclip\fP monitors the X PRIMARY and CLIBPOARD selections for changes in ownership, and makes +the contents of the most recent one to change available to paste from the Windows clipboard. + +It also monitors the contents of the Windows clipboard for changes, taking ownership of the PRIMARY and +CLIPBOARD selections, and making the contents of the Windows clipboard available in them. + +.B Note well: +The \fIXWin(1)\fP X server has internal clipboard integration that is enabled by default. +Do \fINOT\fP run \fIxwinclip\fP unless \fIXWin(1)\fP has been started with the -noclipboard option. + +.SH OPTIONS +\fIxwinclip\fP accepts the following optional command line switches: + +.TP 8 +.B \-display [display] +Specifies the X server display to connect to. +.TP 8 +.B \-nounicodeclipboard +Do not use unicode text on the clipboard. + +.SH "SEE ALSO" +XWin(1) + +.SH BUGS +Some X clients, notably ones written in Tcl/Tk, do not re-assert ownership of the PRIMARY selection or update +it's timestamp when it's contents change, which currently prevents \fIxwinclip\fP from correctly noticing that +the PRIMARY selection's contents have changed. + +Windows clipboard rendering is synchronous in the WM_RENDER*FORMAT message (that is, we must have placed the +contents onto the clipboard by the time we return from processing this message), but we must wait for the X +client which owns the selection to convert the selection to our requested format. This is currently achieved +using a fixed timeout of one second. + +The XWin(1) server should indicate somehow (by placing an atom on the root window?) that it is running with it's +internal clipboard integration enabled, and xwinclip should notice this and exit with an appropriate error. + +Probably others. + +.SH AUTHORS +Contributors to xwinclip include Benjamin Riefenstahl, Roland Cassard, Brian Genisio, Colin Harrison, +Harold L Hunt II, Matsuzaki Kensuke, Jon Turney, Chris Twiner and Jeremy Wilkins. -- cgit v1.2.3