From 14829c9e2986c5f654f78adfb2c5e73f5f6abb81 Mon Sep 17 00:00:00 2001 From: Ademar de Souza Reis Jr Date: Mon, 20 Aug 2007 18:58:44 -0300 Subject: [PATCH] convert manpages prototypes to C ANSI format Closes: #8360 (libXv man pages should be converted to ANSI prototypes) --- man/XvFreeAdaptorInfo.man | 4 +--- man/XvFreeEncodingInfo.man | 4 +--- man/XvGetPortAttribute.man | 25 +++++++++---------------- man/XvGetStill.man | 39 +++++++-------------------------------- man/XvGetVideo.man | 39 +++++++-------------------------------- man/XvGrabPort.man | 17 +++++------------ man/XvPortNotify.man | 14 +++++++------- man/XvPutStill.man | 36 ++++++------------------------------ man/XvPutVideo.man | 36 ++++++------------------------------ man/XvQueryAdaptors.man | 23 ++++++++--------------- man/XvQueryBestSize.man | 23 +++++++---------------- man/XvQueryEncodings.man | 34 +++++++++++++++------------------- man/XvQueryExtension.man | 27 +++++++++++++-------------- man/XvSelectPortNotify.man | 13 ++++--------- man/XvSelectVideoNotify.man | 15 +++++---------- man/XvSetPortAttribute.man | 17 ++++++----------- man/XvStopVideo.man | 22 ++++++++-------------- man/XvUngrabPort.man | 20 ++++++++------------ 18 files changed, 123 insertions(+), 285 deletions(-) diff --git a/man/XvFreeAdaptorInfo.man b/man/XvFreeAdaptorInfo.man index 141f9d5..14a3eaa 100644 --- a/man/XvFreeAdaptorInfo.man +++ b/man/XvFreeAdaptorInfo.man @@ -4,9 +4,7 @@ XvFreeAdaptorInfo \- free adaptor information .\" .SH Syntax -\fBXvFreeAdaptorInfo(\fIp_adaptor_info\fR) -.sp 1l -\fBXvAdaptorInfo \fI*p_adaptor_info\fR; +\fBXvFreeAdaptorInfo(XvAdaptorInfo *\fIp_adaptor_info\fR) .SH Arguments .\" .IP \fIp_adaptor_info\fR 8 diff --git a/man/XvFreeEncodingInfo.man b/man/XvFreeEncodingInfo.man index 43635e8..4b578e0 100644 --- a/man/XvFreeEncodingInfo.man +++ b/man/XvFreeEncodingInfo.man @@ -4,9 +4,7 @@ XvFreeEncodingInfo \- free encoding information .\" .SH Syntax -\fBXvFreeEncodingInfo(\fIp_encoding_info\fR) -.sp 1l -\fBXvEncodingInfo \fI*p_encoding_info\fR; +\fBXvFreeEncodingInfo(XvEncodingInfo *\fIp_encoding_info\fR)" .SH Arguments .\" .IP \fIp_encoding_info\fR 8 diff --git a/man/XvGetPortAttribute.man b/man/XvGetPortAttribute.man index 83b9e38..163cd5f 100644 --- a/man/XvGetPortAttribute.man +++ b/man/XvGetPortAttribute.man @@ -5,30 +5,23 @@ XvGetPortAttribute \- return current port attribute value .\" .SH Syntax .B #include -.sp 1l -.B XvGetPortAttribute(\fIdpy, port, attribute, p_value\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBAtom \fIattribute\fR; -.br -\fBint \fI*p_value\fR; -.sp 1l -.\" +.sp +.nf +.BI "XvGetPortAttribute(Display *" dpy ", XvPortID " port ", +.BI " Atom " attribute ", int " p_value ");" +.fi .SH Arguments .\" -.IP \fIdpy\fR 8 +.IP \fIdpy\fR 12 Specifies the connection to the X server. -.IP \fIport\fR 8 +.IP \fIport\fR 12 Specifies the port, associated with the given display, for which the attribute values are to be returned. -.IP \fIattribute\fR 8 +.IP \fIattribute\fR 12 An atom that identifies the attribute to be queried by this request. Control atoms are obtained using the XInternAtom request with a string from the following table. -.IP \fIp_value\fR 8 +.IP \fIp_value\fR 12 Pointer to the location where the attribute value is written on return. .\" diff --git a/man/XvGetStill.man b/man/XvGetStill.man index 90540ea..1a9bb61 100644 --- a/man/XvGetStill.man +++ b/man/XvGetStill.man @@ -4,38 +4,13 @@ XvGetStill \- capture a single frame of video from a drawable .\" .SH Syntax -.B include "Xvlib.h" -.sp 1l -.B XvGetStill(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fP) -.sp 1l -.B register -.I Display -.I *dpy; -.br -.B XvPortID -.I port; -.br -.B Drawable -.I d; -.br -.B GC -.I gc; -.br -.B int -.I vx, -.I vy, -.I dx, -.I dy; -.br -.B unsigned int -.I vw, -.I vh; -.br -.B unsigned int -.I dw, -.I dh; -.sp 1l -.\" +.B #include +.sp +.nf +.BI "XvGetStill(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 .\" .IP \fIdpy\fR 15 diff --git a/man/XvGetVideo.man b/man/XvGetVideo.man index 725ed29..958ee8b 100644 --- a/man/XvGetVideo.man +++ b/man/XvGetVideo.man @@ -4,38 +4,13 @@ XvGetVideo \- capture video from a drawable .\" .SH Syntax -.B include "Xvlib.h" -.sp 1l -.B XvGetVideo(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh) -.sp 1l -.B register -.I Display -.I *dpy; -.br -.B XvPortID -.I port; -.br -.B Drawable -.I d; -.br -.B GC -.I gc; -.br -.B int -.I vx, -.I vy, -.I dx, -.I dy; -.br -unsigned int -.I vw, -.I vh; -.br -unsigned int -.I dw, -.I dh; -.sp 1l -.\" +.B #include +.sp +.nf +.BI "XvGetVideo(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 .\" .IP \fIdpy\fR 15 diff --git a/man/XvGrabPort.man b/man/XvGrabPort.man index ffb7972..660660a 100644 --- a/man/XvGrabPort.man +++ b/man/XvGrabPort.man @@ -5,20 +5,13 @@ XvGrabPort \- lock port for exclusive use by client .\" .SH Syntax .B #include -.sp 1l -.B XvGrabPort(\fIdpy, port, time)\fR -.sp 1l -.B Display \fI*dpy;\fR -.br -.B XvPortID -.I port; -.br -.B Time -.I time; -.\" +.sp +.nf +.BI "XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" +.fi .SH Arguments .\" -.IP \fIdpy\fR 8 +.IP \fIdpy\fR 8 Specifies the connection to the X server. .IP \fIport\fR 8 Defines the port to be grabbed. diff --git a/man/XvPortNotify.man b/man/XvPortNotify.man index d487b5e..876a025 100644 --- a/man/XvPortNotify.man +++ b/man/XvPortNotify.man @@ -29,19 +29,19 @@ XvPortNotify \- event generated when port attributes change .EE .\" -.IP \fItype\fR 8 +.IP \fItype\fR 15 Specifies the type of event: XvPortNotify. -.IP \fIserial\fR 8 +.IP \fIserial\fR 15 Number of the last request processed by the server. -.IP \fIsend_event\fR 8 +.IP \fIsend_event\fR 15 True if the event was generated by a SendEvent request. -.IP \fIdisplay\fR 8 +.IP \fIdisplay\fR 15 A pointer to the display the event was read from. -.IP \fIport_id\fR 8 +.IP \fIport_id\fR 15 The port whose attribute has changed. -.IP \fIattribute\fR 8 +.IP \fIattribute\fR 15 An atom specifying the attribute that changed. -.IP \fIvalue\fR 8 +.IP \fIvalue\fR 15 The new value of the attribute. .\" .SH Description diff --git a/man/XvPutStill.man b/man/XvPutStill.man index 2231ff6..4ba896c 100644 --- a/man/XvPutStill.man +++ b/man/XvPutStill.man @@ -5,36 +5,12 @@ XvPutStill \- write a single frame of video to a drawable .\" .SH Syntax .B #include -.sp 1l -\fBXvPutStill(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fR) -.sp 1l -.B Display -.I *dpy; -.br -.B XvPortID -.I port; -.br -.B Drawable -.I d; -.br -.B GC -.I gc; -.br -.B int -.I vx, -.I vy, -.I dx, -.I dy; -.br -.B unsigned int -.I vw, -.I vh; -.br -.B unsigned int -.I dw, -.I dh; -.sp 1l -.\" +.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 ");" +.fi .SH Arguments .\" .IP \fIdpy\fR 15 diff --git a/man/XvPutVideo.man b/man/XvPutVideo.man index c0854e9..473a49c 100644 --- a/man/XvPutVideo.man +++ b/man/XvPutVideo.man @@ -5,36 +5,12 @@ XvPutVideo \- write video into a drawable .\" .SH Syntax .B #include -.sp 1l -\fBXvPutVideo(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fR) -.sp 1l -.B Display -.I *dpy; -.br -.B XvPortID -.I port; -.br -.B Drawable -.I d; -.br -.B GC -.I gc; -.br -.B int -.I vx, -.I vy, -.I dx, -.I dy; -.br -.B unsigned int -.I vw, -.I vh; -.br -.B unsigned int -.I dw, -.I dh; -.sp 1l -.\" +.sp +.nf +.BI "XvPutVideo(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 .\" .IP \fIdpy\fR 15 diff --git a/man/XvQueryAdaptors.man b/man/XvQueryAdaptors.man index b9ff5b7..03b9d2b 100644 --- a/man/XvQueryAdaptors.man +++ b/man/XvQueryAdaptors.man @@ -5,25 +5,18 @@ XvQueryAdaptors \- return adaptor information for a screen .\" .SH Syntax .B #include -.br -.sp 1l -.B XvQueryAdaptors(\fIdpy, win, p_num_adaptors, pp_adaptor_info\fR) -.sp 1l -\fBDisplay \fI*dpy;\fR -.br -\fBDrawable \fI draw;\fR -.br -\fBint \fI*p_num_adaptors\fR; -.br -\fBXvAdaptorInfo \fI**pp_adaptor_info\fR; -.br -.\" +.sp +.nf +.BI "XvQueryAdaptors(Display *" dpy ", Window " window ", +.BI " unsigned int *" p_num_adaptors ", +.BI " XvAdaptorInfo **" pp_adaptor_info ");" +.fi .SH Arguments .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. -.IP \fIdraw\fR 8 -Specifies a drawable of the screen for which the adaptor +.IP \fIwindow\fR 8 +Specifies a window of the screen for which the adaptor information is desired. .IP \fIp_num_adaptors\fR 8 A pointer to where the number of adaptors for the specified screen diff --git a/man/XvQueryBestSize.man b/man/XvQueryBestSize.man index 7bec931..478b9d8 100644 --- a/man/XvQueryBestSize.man +++ b/man/XvQueryBestSize.man @@ -5,22 +5,13 @@ XvQueryBestSize \- determine the optimum drawable region size .\" .SH Syntax .B #include -.sp 1l -\fBXvQueryBestSize\fP(\fIdpy, port, motion, vw, vh, dw, dh, p_dw, p_dh\fR) -.sp 1l -.B Display \fI*dpy\fR; -.br -.B XvPortID \fIport\fR; -.br -.B Bool \fImotion\fR; -.br -.B unsigned -.B int \fIvw, vh\fR; -.br -\fBunsigned int \fIdw, dh;\fR -.br -\fBunsigned int \fI*p_dw, *p_dh;\fR -.\" +.sp +.nf +.BI "XvQueryBestSize(Display *" dpy ", XvPort " port ", Bool " motion ", +.BI " unsigned int " vw ", unsigned int " vh ", +.BI " unsigned int " dw ", unsigned int " dh ", +.BI " unsigned int *" p_dw ", unsigned int *" p_dh ");" +.fi .SH Arguments .\" .IP \fIdpy\fR 15 diff --git a/man/XvQueryEncodings.man b/man/XvQueryEncodings.man index ae37825..2882375 100644 --- a/man/XvQueryEncodings.man +++ b/man/XvQueryEncodings.man @@ -5,27 +5,23 @@ XvQueryEncodings \- return list of encodings for an adaptor .\" .SH Syntax .B #include -.sp 1l -\fBXvQueryEncodings(\fIdpy, port, p_num_encodings, pp_encoding_info)\fR -.sp 1l -\fBregister Display \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBunsigned long \fI*p_num_encodings\fR; -.br -\fBXvEncodingInfo \fI**pp_encoding_info\fR; -.\" +.sp +.nf +.BI "XvQueryEncodings(Display *" dpy ", XvPortID " port ", +.BI " unsigned int *" p_num_encodings ", +.BI " XvEncodingInfo **" pp_encoding_info ");" +.fi .SH Arguments -.IP \fI*dpy\fR 15 +.\" +.IP \fIdpy\fR 8 Specifies the connection to the X server. -.IP \fIport\fR 15 +.IP \fIXvPortID\fR 8 Specifies the port whose adaptor is to be queried for its list of encodings. -.IP \fIp_num_encodings\fR 15 +.IP \fIp_num_encodings\fR 8 A pointer to where the number of encodings supported by the adaptor is written. -.IP \fIpp_encoding_info\fR 15 +.IP \fIpp_encoding_info\fR 8 A pointer to where the list of returned encoding information is returned. XvEncodingInfo has the following structure: @@ -41,15 +37,15 @@ XvEncodingInfo has the following structure: } XvEncodingInfo; .EE -.IP \fIencoding_id\fR 15 +.IP \fIencoding_id\fR 8 Specifies the encoding-id of the encoding. The encoding-id is used to identify an encoding when a port's encoding attribute is changed. -.IP \fIname\fR 15 +.IP \fIname\fR 8 A pointer to a formatted string that identifies the encoding. The string has the format "\fItiming-signaltype\fR". For example "ntsc-composite". -.IP \fIwidth,height\fR 15 +.IP \fIwidth,height\fR 8 The width and height, in pixels, of the decoded video image. -.IP \fIrate\fR 15 +.IP \fIrate\fR 8 The field rate of the decoded video. .PP The XvRational structure is used to specify a fractional number. diff --git a/man/XvQueryExtension.man b/man/XvQueryExtension.man index 9ba283b..b390814 100644 --- a/man/XvQueryExtension.man +++ b/man/XvQueryExtension.man @@ -4,25 +4,24 @@ XvQueryExtension \- return version and release of extension .\" .SH Syntax -.B #include -.sp 1l -\fBXvQueryExtension(\fIdpy, p_version, p_release, -.br - p_request_base, p_event_base, p_error_base\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBunsigned int \fI*p_version, *p_release\fR; -.br -\fBunsigned int \fI*p_request_base, *p_event_base, *p_error_base\fR; -.\" +.B #include +.sp +.nf +.BI "XvQueryExtension(Display *" dpy ", unsigned int *" p_version ", +.BI " unsigned int *" p_revision ", +.BI " unsigned int *" p_request_base ", +.BI " unsigned int *" p_event_base ", +.BI " unsigned int *" p_error_base ");" +.fi .SH Arguments .\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. .IP \fIp_version\fR 15 Pointer to where the current version number of the \fIXv\fP video extension is written. -.IP \fIp_release\fR 15 -Pointer to where the release number of the \fIXv\fP video extension +.IP \fIp_revision\fR 15 +Pointer to where the revision number of the \fIXv\fP video extension is written. .IP \fIp_request_base\fR 15 Pointer to where the extension major request number is returned diff --git a/man/XvSelectPortNotify.man b/man/XvSelectPortNotify.man index f146b7d..332618a 100644 --- a/man/XvSelectPortNotify.man +++ b/man/XvSelectPortNotify.man @@ -5,15 +5,10 @@ XvSelectPortNotify \- enable or disable XvPortNotify(__libmansuffix__) events .\" .SH Syntax .B #include -.sp 1l -\fBXvSelectPortNotify(\fIdpy, port, onoff\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBBool \fIonoff\fR; -.\" +.sp +.nf +.BI "XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");" +.fi .SH Arguments .\" .IP \fIdpy\fR 8 diff --git a/man/XvSelectVideoNotify.man b/man/XvSelectVideoNotify.man index d8e2dc4..4a74bac 100644 --- a/man/XvSelectVideoNotify.man +++ b/man/XvSelectVideoNotify.man @@ -4,17 +4,12 @@ XvSelectVideoNotify \- enable or disable VideoNotify events .\" .SH Syntax -\fB#include\fI \fR -.sp 1l -\fBXvSelectVideoNotify(\fIdpy, drawable, onoff\fR) -.sp 1l -\fBregister Display \fI*dpy\fR; -.br -\fBDrawable \fIdrawable\fR; -.br -\fBBool \fIonoff\fR; +.B #include +.sp +.nf +.BI "XvSelectVideoNotify(Display *" dpy ", Drawable " drawable ", Bool " onoff ");" +.fi .SH Arguments -.\" .IP \fIdpy\fR 15 Specifies the connection to the X server. .IP \fIdrawable\fR 15 diff --git a/man/XvSetPortAttribute.man b/man/XvSetPortAttribute.man index db4bf5f..fc46d5d 100644 --- a/man/XvSetPortAttribute.man +++ b/man/XvSetPortAttribute.man @@ -4,17 +4,12 @@ XvSetPortAttribute \- sets an attribute of a video port .\" .SH Syntax -\fB#include \fR -.sp 1l -\fBXvSetPortAttribute(\fIdpy, port, attribute, value\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBAtom \fIattribute\fR; -.br -\fBint \fIvalue\fR; +.B #include +.sp +.nf +.BI "XvSetPortAttribute(Display *" dpy ", XvPortID " port ", +.BI " Atom " attribute ", int " value ");" +.fi .SH Arguments .\" .IP \fIdpy\fR 15 diff --git a/man/XvStopVideo.man b/man/XvStopVideo.man index e2222e3..dc64303 100644 --- a/man/XvStopVideo.man +++ b/man/XvStopVideo.man @@ -4,24 +4,18 @@ XvStopVideo \- stop active video .\" .SH Syntax -\fB#include -.sp 1l -\fBXvStopVideo(\fIdpy, port, draw\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBDrawable \fIdraw\fR; -.\" +.B #include +.sp +.nf +.BI "XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " draw ");" +.fi .SH Arguments .\" -.\" -.IP \fIdpy\fR 15 +.IP \fIdpy\fR 8 Specifies the connection to the X server. -.IP \fIport\fR 15 +.IP \fIport\fR 8 Specifies the port for which video is to be stopped. -.IP \fIdraw\fR 15 +.IP \fIdraw\fR 8 Specifies the drawable associated with the named port. .SH Description .\" diff --git a/man/XvUngrabPort.man b/man/XvUngrabPort.man index d2f073b..fb1a4af 100644 --- a/man/XvUngrabPort.man +++ b/man/XvUngrabPort.man @@ -4,23 +4,19 @@ XvUngrabPort \- release port grabbed for video operation .\" .SH Syntax -\fB#include -.sp 1l -XvUngrabPort(\fIdpy, port, time\fR) -.sp 1l -\fBDisplay \fI*dpy\fR; -.br -\fBXvPortID \fIport\fR; -.br -\fBTime \fItime\fR; +.B #include +.sp +.nf +.BI "XvUngrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" +.fi .SH Arguments .\" -.IP \fIdpy\fR 15 +.IP \fIdpy\fR 8 Specifies the connection to the X server. -.IP \fIport\fR 15 +.IP \fIport\fR 8 Specifies the port to be released. If the port had not been previously grabbed, the request is ignored. -.IP \fItime\fR 15 +.IP \fItime\fR 8 Specifies the request timestamp. .\" .SH Description -- 1.5.0.4