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