Import my usual \dash macro into all these man pages, and use it for
[sgt/utils] / xcopy / xcopy.but
index a318954..e02bfcb 100644 (file)
@@ -1,19 +1,20 @@
 \cfg{man-identity}{xcopy}{1}{2004-08-02}{Simon Tatham}{Simon Tatham}
-\cfg{man-mindepth}{1}
 
-\C{xcopy-manpage} Man page for \cw{xcopy}
+\define{dash} \u2013{-}
 
-\H{xcopy-manpage-name} NAME
+\title Man page for \cw{xcopy}
 
-\cw{xcopy} - read and write text to/from an X selection from the
+\U NAME
+
+\cw{xcopy} \dash read and write text to/from an X selection from the
 command line
 
-\H{xcopy-manpage-synopsis} SYNOPSIS
+\U SYNOPSIS
 
 \c xcopy [ -r ] [ -u | -c ] [ -C ]
 \e bbbbb   bb     bb   bb     bb
 
-\H{xcopy-manpage-description} DESCRIPTION
+\U DESCRIPTION
 
 \cw{xcopy} is a command-line utility for manipulating the X selection.
 
@@ -42,7 +43,7 @@ of handling it in the form of plain text, UTF-8, or compound
 (multiple-character-set) text. Use the \cw{-u}, \cw{-c} and \cw{-C}
 options to control this aspect of its behaviour.
 
-\H{xcopy-manpage-options} OPTIONS
+\U OPTIONS
 
 By default (if \cw{-r} is not supplied), \cw{xcopy} operates in
 write mode.
@@ -91,19 +92,78 @@ window, you might well want to paste a string full of escape
 sequences and control characters, in which case you may need to use
 \cw{-C} to disable conversion to compound text.
 
-\H{xcopy-manpage-bugs} BUGS
+\dt \cw{-b}
+
+\dd Causes \cw{xcopy} to read or write the clipboard instead of the
+selection. (Modern GNOME and KDE-style programs can often interact
+with both. The \e{selection} is the traditional X-style storage
+location which you typically copy things into just by selecting them
+with the mouse, and paste with the middle mouse button. The
+\e{clipboard} is a more Windows-like location which you access using
+explicit Cut, Copy and Paste commands in your application.)
+
+\dt \cw{-t}
+
+\dd Causes \cw{xcopy}, in read mode only, to return the list of
+possible target types currently stored in the selection. This is
+probably only useful for debugging X applications or X selection
+issues.
+
+\dt \cw{-T}
+
+\dd Causes \cw{xcopy}, in read mode only, to return the time stamp
+for the current selection. This is probably only useful for
+debugging X applications or X selection issues.
+
+\dt \cw{-a} \e{target atom}
+
+\dd Causes \cw{xcopy}, in read mode only, to return the selection
+contents corresponding to some particular user-specified target
+type. The target type can be anything listed by \cq{xcopy -r -t}.
+
+\dt \cw{-v}
+
+\dd Causes \cw{xcopy}, in read mode only, to produce a verbose
+commentary on the progress of reading the X selection. Can be useful
+for debugging interactions with other programs.
 
-Occasionally \cw{xcopy -r} completely fails to notice selection data
-owned by another process. I have not yet reproduced this reliably;
-if anyone can, some work with \cw{xmon}(1) would be much
-appreciated...
+\dt \cw{-F}
+
+\dd Causes \cw{xcopy} not to fork, when in write mode. Instead the
+original \cw{xcopy} process will continue to run until the selection
+is taken away from it. Probably only useful when debugging
+\cw{xcopy} itself, although it's just possible that it might turn
+out to be useful for some other special purpose (e.g. having the
+process waiting for it know when the selection owner has changed).
+
+\dt \cw{-d} \e{size}
+
+\dd Alters the maximum size of data transferred in one lump by
+\cw{xcopy}. (Probably most useful for diagnostic purposes.)
+
+\dt \cw{-I}
+
+\dd Inhibits \cw{xcopy}, in write mode, from using the \cw{INCR}
+mechanism for transferring large amounts of selection data a piece at
+a time and waiting for the recipient to acknowledge each chunk before
+sending the next. (Just in case a client doesn't support it.)
+
+\dt \cw{-B}
+
+\dd Inhibits \cw{xcopy}, in write mode, from storing its data in the
+persistent \q{cut buffers} on the root window as well as using the
+peer-to-peer selection mechanism.
+
+\U BUGS
 
 Automatic conversion between compound text and UTF-8 is not
 currently supported. There are Xlib functions to do it, although
 they don't appear to work very well (missing out many characters
 which they could have converted).
 
-\H{xcopy-manpage-licence} LICENCE
+\U LICENCE
 
 \cw{xcopy} is free software, distributed under the MIT licence. Type
 \cw{xcopy --licence} to see the full licence text.
+
+\versionid $Id$