1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
Origin: d6a928004a6784ef9e44d6ffdf34c9288f62a3ac Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@simnet.is>
Last-Update: 2025-04-12
Subject: [PATCH] XF86VM.3: Some editorial changes for this man page [Debian bug #1102885]
Bug-Debian: https://bugs.debian.org/1102885
Forwarded: no
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libxxf86vm/-/merge_requests/10>
---
man/XF86VM.man | 42 ++++++++++++++++++++++++++++++------------
1 file changed, 30 insertions(+), 12 deletions(-)
diff --git a/man/XF86VM.man b/man/XF86VM.man
index aa03da1..931f476 100644
--- a/man/XF86VM.man
+++ b/man/XF86VM.man
@@ -9,17 +9,31 @@
.RS
.nf
.sp 1
-.ft CW
+.if t \{\
+. ie \\n(.g .ft CR
+. el .ft CW
+.\}
..
.de EE
.ft
.sp 1
.fi
+.if t .ft R
.RE
..
.TH XF86VIDMODE __libmansuffix__ __vendorversion__
.SH NAME
-XF86VidModeQueryExtension, XF86VidModeQueryVersion, XF86VidModeSetClientVersion, XF86VidModeGetModeLine, XF86VidModeGetAllModeLines, XF86VidModeAddModeLine, XF86VidModeDeleteModeLine, XF86VidModeModModeLine, XF86VidModeValidateModeLine, XF86VidModeSwitchMode, XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor, XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks, XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp, XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize, XF86VidModeGetPermissions \- Extension library for the XFree86-VidMode X extension
+XF86VidModeQueryExtension, XF86VidModeQueryVersion,
+XF86VidModeSetClientVersion, XF86VidModeGetModeLine,
+XF86VidModeGetAllModeLines, XF86VidModeAddModeLine,
+XF86VidModeDeleteModeLine, XF86VidModeModModeLine,
+XF86VidModeValidateModeLine, XF86VidModeSwitchMode,
+XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor,
+XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks,
+XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp,
+XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize,
+XF86VidModeGetPermissions \- Extension library for the XFree86-VidMode X
+extension
.SH SYNOPSIS
.nf
@@ -256,8 +270,8 @@ These functions provide an interface to the server extension
which allows the video modes to be
queried and adjusted dynamically and mode switching to be controlled.
Applications that use these functions must be linked with
-.ZN -lXxf86vm
-.SS "MODELINE FUNCTIONS"
+.ZN \-lXxf86vm
+.SS MODELINE FUNCTIONS
The
.ZN XF86VidModeGetModeLine
function is used to query the settings for the currently selected
@@ -288,7 +302,7 @@ The first element of the array corresponds to the current video mode.
The
.ZN XF86VidModeModModeLine
function can be used to change the settings of the current video mode
-provided the requested settings are valid (e.g. they don't exceed the
+provided the requested settings are valid (e.g., they don't exceed the
capabilities of the monitor).
.PP
To add a mode to the list of available modes, the
@@ -327,13 +341,13 @@ be deleted.
The validity of a mode can be checked with the
.ZN XF86VidModeValidateModeLine
function.
-If the specified mode can be used by the server (i.e. meets all the
+If the specified mode can be used by the server (i.e., meets all the
constraints placed upon a mode by the combination of the server, card,
and monitor) the function returns
.ZN MODE_OK ,
otherwise it returns a value indicating the reason why the mode is
invalid (as defined in \fIxf86.h\fP)
-.SS "MODE SWITCH FUNCTIONS"
+.SS MODE SWITCH FUNCTIONS
When the function
.ZN XF86VidModeSwitchMode
is called, the server will change the video mode to next (or previous)
@@ -352,7 +366,7 @@ or
.ZN XF86VidModeSwitchToMode
functions or from one of the mode switch key sequences.
.PP
-.RB Note:
+.BR Note :
Because of the asynchronous nature of the X protocol, a call to
.ZN XFlush
is needed if the application wants to see the mode change immediately.
@@ -360,7 +374,7 @@ To be informed of the execution status of the request, a
custom error handler should be installed using
.ZN XSetErrorHandler
before calling the mode switching function.
-.SS "MONITOR FUNCTIONS"
+.SS MONITOR FUNCTIONS
Information known to the server about the monitor is returned by the
.ZN XF86VidModeGetMonitor
function. The
@@ -390,14 +404,14 @@ and
.ZN vsync
fields point to dynamically allocated storage that should be freed
by the caller.
-.SS "VIEWPORT FUNCTIONS"
+.SS VIEWPORT FUNCTIONS
The
.ZN XF86VidModeGetViewPort
and
.ZN XF86VidModeSetViewPort
functions can be used to, respectively, query and change the location
of the upper left corner of the viewport into the virtual screen.
-.SS "OTHER FUNCTIONS"
+.SS OTHER FUNCTIONS
The
.ZN XF86VidModeQueryVersion
function can be used to determine the version of the extension
@@ -421,6 +435,10 @@ XF86VidModeGetPermissions
functions need to be documented. In the meantime, check the source
code for information about how to use them.
.SH SEE ALSO
-__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), XFlush(__libmansuffix__), XSetErrorHandler(__libmansuffix__), xvidtune(__appmansuffix__)
+.BR __xservername__ (__appmansuffix__),
+.BR __xconfigfile__ (__filemansuffix__),
+.BR XFlush (__libmansuffix__),
+.BR XSetErrorHandler (__libmansuffix__),
+.BR xvidtune (__appmansuffix__)
.SH AUTHORS
Kaleb Keithley, Jon Tombs, David Dawes, and Joe Moss
--
GitLab
|
