Convert documentation from xv-library-v2.2.txt into man pages

Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>

1 files changed, 43 insertions, 8 deletions

diff --git a/man/Xv.man b/man/Xv.man
index 3e41c5e..14abb71 100644
--- a/man/Xv.man
+++ b/man/Xv.man
@@ -3,10 +3,10 @@
 .SH NAME
 Xv \- X Window System video extension
 .SH DESCRIPTION
-The Xv extension provides support for video adaptors attached to an X
-display.  It takes the approach that a display may have one or more
-video adaptors, each of which has one or more ports through which
-independent video streams pass.
+The X Video Extension (Xv) extension provides support for video
+adaptors attached to an X display.  It takes the approach that a
+display may have one or more video adaptors, each of which has one or
+more ports through which independent video streams pass.
 .PP
 An adaptor may be able to display video in a drawable, capture video
 from a drawable, or both.  It translates between video encoding (NTSC,
@@ -30,8 +30,30 @@ free to put video into a drawable or get video from a drawable,
 according the capabilities supported.  Clients can select to receive
 events when video activity changes in a drawable and when port
 attributes have changed.
+.PP
+The Xv protocol version 2.2 and later is extended to
+support client images in alternate colorspaces (XvImages).
+Xv adaptors which are capable of displaying XvImages will have
+the XvImageMask field set in the type field of the XvAdaptorInfo.
+XvImage formats supported by the port may be queried with
+.BR XvListImageFormats (__libmansuffix__).
+XvImages may be created with the help of
+.BR XvCreateImage (__libmansuffix__)
+or
+.BR XvShmCreateImage (__libmansuffix__);
+XvImages may be displayed with
+.BR XvPutImage (__libmansuffix__)
+or
+.BR XvShmPutImage (__libmansuffix__).
+The Port attributes of the port specified in the Xv(Shm)PutImage
+command will be valid for the image operation when applicable.
+There will be a port encoding with the name "XV_IMAGE".  The width and height
+of that encoding will indicate the maximum source image size.
 .SH SUMMARY OF LIBRARY FUNCTIONS
-The following is a summary of Xv library functions:
+The following is a summary of Xv library functions and events:
+.sp 1l
+.BR XvCreateImage (__libmansuffix__)
+\- create an XvImage
 .sp 1l
 .BR XvGetPortAttribute (__libmansuffix__)
 \- return current port attribute value
@@ -45,9 +67,15 @@ The following is a summary of Xv library functions:
 .BR XvGrabPort (__libmansuffix__)
 \- lock port for exclusive use by client
 .sp 1l
+.BR XvListImageFormats (__libmansuffix__)
+\- return list of image formats for a port
+.sp 1l
 .BR XvPortNotify (__libmansuffix__)
 \- event generated when port attributes change
 .sp 1l
+.BR XvPutImage (__libmansuffix__)
+\- write a XvImage to a drawable
+.sp 1l
 .BR XvPutStill (__libmansuffix__)
 \- write a single frame of video to a drawable
 .sp 1l
@@ -66,6 +94,9 @@ The following is a summary of Xv library functions:
 .BR XvQueryExtension (__libmansuffix__)
 \- return version and revision of extension
 .sp 1l
+.BR XvQueryPortAttributes (__libmansuffix__)
+\- return list of attributes of a port
+.sp 1l
 .BR XvSelectPortNotify (__libmansuffix__)
 \- enable or disable XvPortNotify events
 .sp 1l
@@ -75,6 +106,12 @@ The following is a summary of Xv library functions:
 .BR XvSetPortAttribute (__libmansuffix__)
 \- set an attribute for a port
 .sp 1l
+.BR XvShmCreateImage (__libmansuffix__)
+\- create an XvImage in shared memory
+.sp 1l
+.BR XvShmPutImage (__libmansuffix__)
+\- write a XvImage in shared memory to a drawable
+.sp 1l
 .BR XvStopVideo (__libmansuffix__)
 \- stop active video
 .sp 1l
@@ -85,6 +122,4 @@ The following is a summary of Xv library functions:
 \- event generated for video processing
 .sp 1l
 .PP
-Each of these functions is described in its own Xv man page.
-
-
+Each of these functions and events is described in its own Xv man page.