summaryrefslogtreecommitdiff
path: root/man/XvSelectPortNotify.man
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2009-10-02 08:55:52 -0700
committerAlan Coopersmith <alan.coopersmith@sun.com>2009-10-03 01:32:22 -0700
commit7303af622984579e600893934a3958c0654d57bf (patch)
treefd3956f647d2a525cc4f122ab1121c5fec80766c /man/XvSelectPortNotify.man
parentea79759a6940855dab10472a876e784fb8494eee (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/XvSelectPortNotify.man')
-rw-r--r--man/XvSelectPortNotify.man46
1 files changed, 27 insertions, 19 deletions
diff --git a/man/XvSelectPortNotify.man b/man/XvSelectPortNotify.man
index 745d828..f31fa24 100644
--- a/man/XvSelectPortNotify.man
+++ b/man/XvSelectPortNotify.man
@@ -1,41 +1,49 @@
-.TH XvSelectPortNotify __libmansuffix__ __vendorversion__
-.SH Name
-XvSelectPortNotify \- enable or disable XvPortNotify(__libmansuffix__) events
+.TH XvSelectPortNotify __libmansuffix__ __vendorversion__ "libXv Functions"
+.SH NAME
+XvSelectPortNotify \- enable or disable XvPortNotify events
.\"
-.SH Syntax
+.SH SYNOPSIS
.B #include <X11/extensions/Xvlib.h>
.sp
.nf
-.BI "XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");"
+.BI "int XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");"
.fi
-.SH Arguments
+.SH ARGUMENTS
.\"
.IP \fIdpy\fR 8
Specifies the connection to the X server.
.IP \fIport\fR 8
Specifies the port for which PortNotify events are to be generated
-when its attributes are changed using XvSetPortAttribute(__libmansuffix__).
+when its attributes are changed using
+.BR XvSetPortAttribute (__libmansuffix__)
+.
.IP \fIonoff\fR 8
Specifies whether notification is to be enabled or disabled.
.\"
-.SH Description
+.SH DESCRIPTION
.\"
-XvSelectPortNotify(__libmansuffix__) enables or disables PortNotify event
-delivery to the requesting client. XvPortNotify(__libmansuffix__) events are
-generated when port attributes are changed using XvSetPortAttribute(__libmansuffix__).
+.BR XvSelectPortNotify (__libmansuffix__)
+enables or disables PortNotify event delivery to the requesting client.
+.BR XvPortNotify (__libmansuffix__)
+events are generated when port attributes are changed using
+.BR XvSetPortAttribute (__libmansuffix__).
.\"
-.SH Returned Values
+.SH RETURN VALUES
.IP [Success] 8
-Returned if XvSelectPortNotify(__libmansuffix__) completed successfully.
+Returned if
+.BR XvSelectPortNotify (__libmansuffix__)
+completed successfully.
.IP [XvBadExtension] 8
Returned if the Xv extension is unavailable.
.IP [XvBadAlloc] 8
-Returned if XvSelectPortNotify(__libmansuffix__) failed to allocate memory to process
-the request.
-.SH Diagnostics
+Returned if
+.BR XvSelectPortNotify (__libmansuffix__)
+failed to allocate memory to process the request.
+.SH DIAGNOSTICS
.IP [XvBadPort] 8
Generated if the requested port does not exist.
-.SH See Also
+.SH SEE ALSO
.\"
-XvSetPortNotify(__libmansuffix__), XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__)
-.br
+.BR XvSetPortNotify (__libmansuffix__),
+.BR XvSetPortAttribute (__libmansuffix__),
+.BR XvPortNotify (__libmansuffix__)