summaryrefslogtreecommitdiff
path: root/man/XvQueryAdaptors.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/XvQueryAdaptors.man
parentea79759a6940855dab10472a876e784fb8494eee (diff)
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/XvQueryAdaptors.man')
-rw-r--r--man/XvQueryAdaptors.man40
1 files changed, 22 insertions, 18 deletions
diff --git a/man/XvQueryAdaptors.man b/man/XvQueryAdaptors.man
index 628d932..bb52ff5 100644
--- a/man/XvQueryAdaptors.man
+++ b/man/XvQueryAdaptors.man
@@ -1,32 +1,33 @@
-.TH XvQueryAdaptors __libmansuffix__ __vendorversion__
-.SH Name
+.TH XvQueryAdaptors __libmansuffix__ __vendorversion__ "libXv Functions"
+.SH NAME
XvQueryAdaptors \- return adaptor information for a screen
.\"
-.SH Syntax
+.SH SYNOPSIS
.B #include <X11/extensions/Xvlib.h>
.sp
.nf
-.BI "XvQueryAdaptors(Display *" dpy ", Window " window ",
-.BI " unsigned int *" p_num_adaptors ",
-.BI " XvAdaptorInfo **" pp_adaptor_info ");"
+.BI "int XvQueryAdaptors(Display *" dpy ", Window " window ","
+.BI " unsigned int *" p_num_adaptors ","
+.BI " XvAdaptorInfo **" pp_adaptor_info ");"
.fi
-.SH Arguments
+.SH ARGUMENTS
.\"
.IP \fIdpy\fR 8
Specifies the connection to the X server.
.IP \fIwindow\fR 8
-Specifies a window of the screen for which the adaptor
+Specifies a window of the screen for which the adaptor
information is desired.
.IP \fIp_num_adaptors\fR 8
-A pointer to where the number of adaptors for the specified screen
+A pointer to where the number of adaptors for the specified screen
is returned.
.IP \fIpp_adaptor_info\fR 8
A pointer to where the list of returned adaptor information is
returned.
.\"
-.SH Description
+.SH DESCRIPTION
.\"
-XvQueryAdaptors(__libmansuffix__) returns an video adaptor information for
+.BR XvQueryAdaptors (__libmansuffix__)
+ returns an video adaptor information for
the screen of the specified drawable. The XvAdaptorInfo structure
has the following organization:
.EX
@@ -70,17 +71,20 @@ A drawable depth supported by the adaptor.
.IP \fIvisual_id\fR 8
A visual-id supported for the given depth by the adaptor.
.\"
-.SH Returned Values
+.SH RETURN VALUES
.IP [Success] 8
-Returned if XvQueryAdaptors(__libmansuffix__) completed successfully.
+Returned if
+.BR XvQueryAdaptors (__libmansuffix__)
+completed successfully.
.IP [XvBadExtension] 8
Returned if the Xv extension is unavailable.
.IP [XvBadAlloc] 8
-Returned if XvQueryAdaptors(__libmansuffix__) failed to allocate memory to process
-the request.
-.SH Diagnostics
+Returned if
+.BR XvQueryAdaptors (__libmansuffix__)
+failed to allocate memory to process the request.
+.SH DIAGNOSTICS
.IP [Drawable] 8
Returned if the requested drawable does not exist.
-.SH See Also
-XvFreeAdaptorInfo(__libmansuffix__)
+.SH SEE ALSO
+.BR XvFreeAdaptorInfo (__libmansuffix__)
.\"