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/XvStopVideo.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/XvStopVideo.man')
-rw-r--r-- | man/XvStopVideo.man | 45 |
1 files changed, 25 insertions, 20 deletions
diff --git a/man/XvStopVideo.man b/man/XvStopVideo.man index 0c472b0..3904521 100644 --- a/man/XvStopVideo.man +++ b/man/XvStopVideo.man @@ -1,14 +1,14 @@ -.TH XvStopVideo __libmansuffix__ __vendorversion__ -.SH Name -XvStopVideo \- stop active video +.TH XvStopVideo __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvStopVideo \- stop active video .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " draw ");" +.BI "int XvStopVideo(Display *" dpy ", XvPortID " port ", Drawable " draw ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -16,28 +16,33 @@ Specifies the connection to the X server. Specifies the port for which video is to be stopped. .IP \fIdraw\fR 8 Specifies the drawable associated with the named port. -.SH Description +.SH DESCRIPTION .\" -XvStopVideo(__libmansuffix__) stops active video for the specified port and -drawable. If the port is not processing video, or if it is processing -video in a different drawable, the request is ignored. When video is -stopped a XvVideoNotify(__libmansuffix__) event with detail XvStopped is generated -for the associated drawable. +.BR XvStopVideo (__libmansuffix__) +stops active video for the specified port and drawable. If the port +is not processing video, or if it is processing video in a different +drawable, the request is ignored. When video is stopped a +.BR XvVideoNotify (__libmansuffix__) +event with detail XvStopped is generated for the associated drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvStopVideo(__libmansuffix__) completed successfully. +Returned if +.BR XvStopVideo (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvStopVideo(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvStopVideo (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .IP [BadDrawable] 8 Generated if the requested drawable does not exist. .\" -.SH See Also -XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotifyEvent(__libmansuffix__) -.br +.SH SEE ALSO +.BR XvGetVideo (__libmansuffix__), +.BR XvPutVideo (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) |