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/XvGrabPort.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/XvGrabPort.man')
-rw-r--r-- | man/XvGrabPort.man | 47 |
1 files changed, 28 insertions, 19 deletions
diff --git a/man/XvGrabPort.man b/man/XvGrabPort.man index 50e6539..0e052df 100644 --- a/man/XvGrabPort.man +++ b/man/XvGrabPort.man @@ -1,14 +1,14 @@ -.TH XvGrabPort __libmansuffix__ __vendorversion__ -.SH Name +.TH XvGrabPort __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvGrabPort \- lock port for exclusive use by client .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" +.BI "int XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -17,26 +17,33 @@ Defines the port to be grabbed. .IP \fItime\fR 8 Specifies the request timestamp. .\" -.SH Description +.SH DESCRIPTION .\" -XvGrabPort(__libmansuffix__) grabs a port. Once a client grabs a port, -only that client can make video requests -to that port. +.BR XvGrabPort (__libmansuffix__) +grabs a port. Once a client grabs a port, only that client can make video +requests to that port. .PP If the time is before the current port time, the XvGrabPort request is ignored and XvInvalidTime is returned. If the port is already grabbed by another client, XvAlreadyGrabbed is returned. Otherwise it returns a status of \fISuccess\fR. The port time is updated when the following -requests are processed: XvGrabPort(__libmansuffix__), XvUngrabPort(__libmansuffix__), -XvPutVideo(__libmansuffix__), XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvGetStill(__libmansuffix__). +requests are processed: +.BR XvGrabPort (__libmansuffix__), +.BR XvUngrabPort (__libmansuffix__), +.BR XvPutVideo (__libmansuffix__), +.BR XvPutStill (__libmansuffix__), +.BR XvGetVideo (__libmansuffix__), +.BR XvGetStill (__libmansuffix__). .PP If the port is actively processing video for another client, the video is preempted, and an XvVideoNotify event with detail XvPreempted is generated for its drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvGrabPort(__libmansuffix__) completed successfully. +Returned if +.BR XvGrabPort (__libmansuffix__) +completed successfully. .IP [XvInvalidTime] 8 Returned if requested time is older than the current port time. .IP [XvAlreadyGrabbed] 8 @@ -44,13 +51,15 @@ Returned if the port is already grabbed by another client. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvGrabPort(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvGrabPort (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 15 Generated if the requested port does not exist. .\" -.SH See Also +.SH SEE ALSO .\" -XvUngrabPort(__libmansuffix__) XvVideoNotify(__libmansuffix__) -.br +.BR XvUngrabPort (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) + |