summaryrefslogtreecommitdiff
path: root/man/Xv.man
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2009-10-02 08:55:52 -0700
committerAlan Coopersmith <alan.coopersmith@sun.com>2009-10-03 01:32:22 -0700
commit7303af622984579e600893934a3958c0654d57bf (patch)
treefd3956f647d2a525cc4f122ab1121c5fec80766c /man/Xv.man
parentea79759a6940855dab10472a876e784fb8494eee (diff)
downloadxorg-lib-libXv-7303af622984579e600893934a3958c0654d57bf.tar.gz
Man page cleanups and formatting fixes
- Convert man page section headings to traditional style/names Make them all caps, and use 'synopsis' instead of 'syntax' - Strip trailing whitespace from man pages - Add return types to function prototypes - Fix unbalanced quoting and other formatting issues - Use .BR for formatting man page references - Add "libXv Functions" to man page header Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
Diffstat (limited to 'man/Xv.man')
-rw-r--r--man/Xv.man78
1 files changed, 50 insertions, 28 deletions
diff --git a/man/Xv.man b/man/Xv.man
index 92f1608..3e41c5e 100644
--- a/man/Xv.man
+++ b/man/Xv.man
@@ -1,12 +1,12 @@
-.TH Xv __libmansuffix__ __vendorversion__
+.TH Xv __libmansuffix__ __vendorversion__ "libXv Functions"
.\"
-.SH Name
+.SH NAME
Xv \- X Window System video extension
-.SH Description
+.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.
+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,
@@ -14,55 +14,77 @@ PAL, SECAM, etc...) and drawable format (depth and visual-id pair). An
adaptor may support multiple video encodings and/or multiple drawable
formats.
.PP
-Clients use Xv(__libmansuffix__) to gain access and manage sharing of a display's
-video resources. Typically, a client will use XvQueryExtension(__libmansuffix__) to
-determine the status of the extension, XvQueryAdaptors(__libmansuffix__) to get a
-description of what video adaptors exist, and XvQueryEncodings(__libmansuffix__) to
-get a description of what video encodings an adaptor supports.
+Clients use
+.BR Xv (__libmansuffix__)
+to gain access and manage sharing of a display's
+video resources. Typically, a client will use
+.BR XvQueryExtension (__libmansuffix__)
+to determine the status of the extension,
+.BR XvQueryAdaptors (__libmansuffix__)
+to get a description of what video adaptors exist, and
+.BR XvQueryEncodings (__libmansuffix__)
+to get a description of what video encodings an adaptor supports.
.PP
Once a client has determined what video resources are available, it is
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.
-.SH Summary of Library Functions
+.SH SUMMARY OF LIBRARY FUNCTIONS
The following is a summary of Xv library functions:
.sp 1l
-XvGetPortAttribute(__libmansuffix__) \- return current port attribute value
+.BR XvGetPortAttribute (__libmansuffix__)
+\- return current port attribute value
.sp 1l
-XvGetStill(__libmansuffix__) \- capture a single frame of video from a drawable
+.BR XvGetStill (__libmansuffix__)
+\- capture a single frame of video from a drawable
.sp 1l
-XvGetVideo(__libmansuffix__) \- capture video from a drawable
+.BR XvGetVideo (__libmansuffix__)
+\- capture video from a drawable
.sp 1l
-XvGrabPort(__libmansuffix__) \- lock port for exclusive use by client
+.BR XvGrabPort (__libmansuffix__)
+\- lock port for exclusive use by client
.sp 1l
-XvPortNotify(__libmansuffix__) \- event generated when port attributes change
+.BR XvPortNotify (__libmansuffix__)
+\- event generated when port attributes change
.sp 1l
-XvPutStill(__libmansuffix__) \- write a single frame of video to a drawable
+.BR XvPutStill (__libmansuffix__)
+\- write a single frame of video to a drawable
.sp 1l
-XvPutVideo(__libmansuffix__) \- write video into a drawable
+.BR XvPutVideo (__libmansuffix__)
+\- write video into a drawable
.sp 1l
-XvQueryAdaptors(__libmansuffix__) \- return adaptor information for a screen
+.BR XvQueryAdaptors (__libmansuffix__)
+\- return adaptor information for a screen
.sp 1l
-XvQueryBestSize(__libmansuffix__) \- determine the optimum drawable region size
+.BR XvQueryBestSize (__libmansuffix__)
+\- determine the optimum drawable region size
.sp 1l
-XvQueryEncodings(__libmansuffix__) \- return list of encodings for an adaptor
+.BR XvQueryEncodings (__libmansuffix__)
+\- return list of encodings for an adaptor
.sp 1l
-XvQueryExtension(__libmansuffix__) \- return version and revision of extension
+.BR XvQueryExtension (__libmansuffix__)
+\- return version and revision of extension
.sp 1l
-XvSelectPortNotify(__libmansuffix__) \- enable or disable XvPortNotify events
+.BR XvSelectPortNotify (__libmansuffix__)
+\- enable or disable XvPortNotify events
.sp 1l
-XvSelectVideoNotify(__libmansuffix__) \- enable or disable XvVideoNotify events
+.BR XvSelectVideoNotify (__libmansuffix__)
+\- enable or disable XvVideoNotify events
.sp 1l
-XvSetPortAttribute(__libmansuffix__) \- set an attribute for a port
+.BR XvSetPortAttribute (__libmansuffix__)
+\- set an attribute for a port
.sp 1l
-XvStopVideo(__libmansuffix__) \- stop active video
+.BR XvStopVideo (__libmansuffix__)
+\- stop active video
.sp 1l
-XvUngrabPort(__libmansuffix__) \- release a grabbed port
+.BR XvUngrabPort (__libmansuffix__)
+\- release a grabbed port
.sp 1l
-XvVideoNotify(__libmansuffix__) \- event generated for video processing
+.BR XvVideoNotify (__libmansuffix__)
+\- event generated for video processing
.sp 1l
.PP
Each of these functions is described in its own Xv man page.
-.br
+