diff options
| author | Alan Coopersmith <alan.coopersmith@sun.com> | 2009-10-02 08:55:52 -0700 |
|---|---|---|
| committer | Alan Coopersmith <alan.coopersmith@sun.com> | 2009-10-03 01:32:22 -0700 |
| commit | 7303af622984579e600893934a3958c0654d57bf (patch) | |
| tree | fd3956f647d2a525cc4f122ab1121c5fec80766c /man/XvQueryExtension.man | |
| parent | ea79759a6940855dab10472a876e784fb8494eee (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/XvQueryExtension.man')
| -rw-r--r-- | man/XvQueryExtension.man | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/man/XvQueryExtension.man b/man/XvQueryExtension.man index b238a79..4cce6dc 100644 --- a/man/XvQueryExtension.man +++ b/man/XvQueryExtension.man @@ -1,18 +1,18 @@ -.TH XvQueryExtension __libmansuffix__ __vendorversion__ -.SH Name +.TH XvQueryExtension __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvQueryExtension \- return version and release of extension .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvQueryExtension(Display *" dpy ", unsigned int *" p_version ", -.BI " unsigned int *" p_revision ", -.BI " unsigned int *" p_request_base ", -.BI " unsigned int *" p_event_base ", -.BI " unsigned int *" p_error_base ");" +.BI "int XvQueryExtension(Display *" dpy ", unsigned int *" p_version "," +.BI " unsigned int *" p_revision "," +.BI " unsigned int *" p_request_base "," +.BI " unsigned int *" p_event_base "," +.BI " unsigned int *" p_error_base ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. @@ -29,21 +29,24 @@ Pointer to where the extension event base is returned .IP \fIp_error_base\fR 15 Pointer to where the extension error base is returned .\" -.SH Description +.SH DESCRIPTION .\" .PP -XvQueryExtension(__libmansuffix__) returns the version and release -numbers for the Xv video extension currently loaded -on the system. The extension major request number, event base, and error -base are also returned. +.BR XvQueryExtension (__libmansuffix__) +returns the version and release numbers for the Xv video extension +currently loaded on the system. The extension major request number, +event base, and error base are also returned. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvQueryExtension(__libmansuffix__) completed successfully. +Returned if +.BR XvQueryExtension (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 -Returned if the Xv video extension is not available for -the named display. +Returned if the Xv video extension is not available for the named display. .IP [XvBadAlloc] 8 -Returned if XvQueryExtension(__libmansuffix__) failed to allocate memory to process -the request. -.br +Returned if +.BR XvQueryExtension (__libmansuffix__) +failed to allocate memory to process the request. +.SH SEE ALSO +.BR Xv (__libmansuffix__) |