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/XvPutStill.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/XvPutStill.man')
-rw-r--r-- | man/XvPutStill.man | 72 |
1 files changed, 43 insertions, 29 deletions
diff --git a/man/XvPutStill.man b/man/XvPutStill.man index e7552d4..fb22659 100644 --- a/man/XvPutStill.man +++ b/man/XvPutStill.man @@ -1,16 +1,16 @@ -.TH XvPutStill __libmansuffix__ __vendorversion__ -.SH Name +.TH XvPutStill __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvPutStill \- write a single frame of video to a drawable .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvPutStill(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc ", -.BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh ", -.BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");" +.BI "int XvPutStill(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc "," +.BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh "," +.BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. @@ -20,30 +20,40 @@ Defines the port from which to get the still. Defines the drawable into which the still is to be written. Pixmaps are currently not supported. .IP \fIgc\fR 15 -Defines the graphical context. -GC components are: -.I subwindow-mode, -.I clip-x-origin, -.I clip-y-origin, -and -.I clip-mask. +Defines the graphical context. +GC components are: +.IR subwindow-mode , +.IR clip-x-origin , +.IR clip-y-origin , +and +.IR clip-mask . .IP \fIvx,vy,vw,vh\fR 15 Define the location and size of the video region -to be written. \fIvx\fP and \fIvy\fP define the +to be written. \fIvx\fP and \fIvy\fP define the upper-left pixel of the region. \fIvw\fP and \fIvh\fP define the width and height, in pixels, of the region. .IP \fIdx,dy,dw,dh\fR 15 Define the location and size of the destination region into which the -still image is written. \fIdx\fP and \fIdy\fP define the upper-left +still image is written. \fIdx\fP and \fIdy\fP define the upper-left corner of the region. \fIdw\fP and \fIdh\fP define the width and height, in pixels, of the region. .\" -.SH Description +.SH DESCRIPTION .\" -XvPutStill(__libmansuffix__) writes a single frame of video to a drawable. -The position and size of the source (video) rectangle is specified by \fIvx, -vy, vw\fR, and \fIvh\fR. The position and size of the destination (drawable) -rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. +.BR XvPutStill (__libmansuffix__) +writes a single frame of video to a drawable. +The position and size of the source (video) rectangle is specified by +.IR vx , +.IR vy , +.IR vw , +and +.IR vh . +The position and size of the destination (drawable) rectangle is specified by +.IR dx , +.IR dy , +.IR dw , +and +.IR dh . .PP Video data is clipped to the bounds of the video encoding, scaled to the requested drawable region size (or the closest size supported) and @@ -54,15 +64,18 @@ an XvVideoNotify event with detail XvBusy is generated for the drawable. If the port is not receiving a valid video signal a VideoNotify event with detail XvHardError is generated for the drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvPutStill(__libmansuffix__) completed successfully. +Returned if +.BR XvPutStill (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvGetStill(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvGetStill (__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 @@ -71,7 +84,8 @@ Generated if the requested drawable does not exist. Generated if the requested graphics context does not exist. .IP [BadAlloc] 8 Generated if there were insufficient resources to process the request. -.SH See Also +.SH SEE ALSO .\" -XvPutVideo(__libmansuffix__), XvGetStill(__libmansuffix__), XvVideoNotify(__libmansuffix__) -.br +.BR XvPutVideo (__libmansuffix__), +.BR XvGetStill (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) |