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/XvSelectVideoNotify.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/XvSelectVideoNotify.man')
| -rw-r--r-- | man/XvSelectVideoNotify.man | 37 |
1 files changed, 21 insertions, 16 deletions
diff --git a/man/XvSelectVideoNotify.man b/man/XvSelectVideoNotify.man index f9cbab5..096d006 100644 --- a/man/XvSelectVideoNotify.man +++ b/man/XvSelectVideoNotify.man @@ -1,14 +1,14 @@ -.TH XvSelectVideoNotify __libmansuffix__ __vendorversion__ -.SH Name +.TH XvSelectVideoNotify __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvSelectVideoNotify \- enable or disable VideoNotify events .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvSelectVideoNotify(Display *" dpy ", Drawable " drawable ", Bool " onoff ");" +.BI "int XvSelectVideoNotify(Display *" dpy ", Drawable " drawable ", Bool " onoff ");" .fi -.SH Arguments +.SH ARGUMENTS .IP \fIdpy\fR 15 Specifies the connection to the X server. .IP \fIdrawable\fR 15 @@ -16,22 +16,27 @@ Defines the drawable in which video activity is to be reported. .IP \fIonoff\fR 15 Selects whether video notification is enabled or disabled. .\" -.SH Description -XvSelectVideoNotify(__libmansuffix__) enables or disables events to be reported for -video activity in a drawable. +.SH DESCRIPTION +.BR XvSelectVideoNotify (__libmansuffix__) +enables or disables +.BR XvVideoNotify (__libmansuffix__) +events to be reported for video activity in a drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvSelectVideoNotify(__libmansuffix__) completed successfully. +Returned if +.BR XvSelectVideoNotify (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvSelectVideoNotify(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvSelectVideoNotify (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [BadDrawable] 8 Generated if the requested drawable does not exist. -.SH See Also +.SH SEE ALSO .\" -XvVideoNotify -.br +.BR XvVideoNotify (__libmansuffix__) + |