aboutsummaryrefslogtreecommitdiff
path: root/nx-X11/lib/Xxf86vm/XF86VM.man
diff options
context:
space:
mode:
authorMike Gabriel <mike.gabriel@das-netzwerkteam.de>2015-05-27 12:34:12 +0200
committerMike Gabriel <mike.gabriel@das-netzwerkteam.de>2015-06-22 08:17:34 +0200
commit06d389a0ce41d1a3d1f214c64a1241be0fdf440b (patch)
tree38c8bef6fd2f529249ff2ce1b3c8d95178576f7a /nx-X11/lib/Xxf86vm/XF86VM.man
parente7dfbd511d3b0a358f94b880f2212b74f9e42e70 (diff)
downloadnx-libs-06d389a0ce41d1a3d1f214c64a1241be0fdf440b.tar.gz
nx-libs-06d389a0ce41d1a3d1f214c64a1241be0fdf440b.tar.bz2
nx-libs-06d389a0ce41d1a3d1f214c64a1241be0fdf440b.zip
library clean-up: Drop libXx86{misc,vm,dga} libraries. Not needed by nx-libs.
Diffstat (limited to 'nx-X11/lib/Xxf86vm/XF86VM.man')
-rw-r--r--nx-X11/lib/Xxf86vm/XF86VM.man425
1 files changed, 0 insertions, 425 deletions
diff --git a/nx-X11/lib/Xxf86vm/XF86VM.man b/nx-X11/lib/Xxf86vm/XF86VM.man
deleted file mode 100644
index 6e53ad158..000000000
--- a/nx-X11/lib/Xxf86vm/XF86VM.man
+++ /dev/null
@@ -1,425 +0,0 @@
-.\" $XdotOrg: xc/lib/Xxf86vm/XF86VM.man,v 1.2 2004/04/23 19:23:08 eich Exp $
-.\" $TOG: XF86VM.man /main/6 1997/07/19 10:30:39 kaleb $
-.\"
-.\"
-.\"
-.\"
-.\" Copyright (c) 1996 Joe Moss, The XFree86 Project
-.\" $XFree86: xc/programs/Xserver/hw/xfree86/doc/man/XF86VM.man,v 3.14 2003/10/02 13:29:56 eich Exp $
-.\"
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.TH XF86VIDMODE __libmansuffix__ __vendorversion__
-.SH NAME
-XF86VidModeQueryExtension, XF86VidModeQueryVersion, XF86VidModeSetClientVersion, XF86VidModeGetModeLine, XF86VidModeGetAllModeLines, XF86VidModeDeleteModeLine, XF86VidModeModModeLine, XF86VidModeValidateModeLine, XF86VidModeSwitchMode, XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor, XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks, XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp, XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize, XF86VidModeGetPermissions \- Extension libary for the XFree86-VidMode X extension
-.SH SYNTAX
-.nf
-.LP
-\&#include <X11/extensions/xf86vmode.h>
-.LP
-Bool XF86VidModeQueryExtension(
- Display *\fIdisplay\fP\^,
- int *\fIevent_base_return\fP\^,
- int *\fIerror_base_return\fP\^);
-.LP
-Bool XF86VidModeQueryVersion(
- Display *\fIdisplay\fP\^,
- int *\fImajor_version_return\fP\^,
- int *\fIminor_version_return\fP\^);
-.LP
-Bool XF86VidModeSetClientVersion(
- Display *\fIdisplay\fP\^);
-.LP
-Bool XF86VidModeGetModeLine(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int *\fIdotclock_return\fP\^,
- XF86VidModeModeLine *\fImodeline\fP\^);
-.LP
-Bool XF86VidModeGetAllModeLines(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int *\fImodecount_return\fP\^,
- XF86VidModeModeInfo ***\fImodesinfo\fP\^);
-.ig
-.LP
-Bool XF86VidModeAddModeLine(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeModeInfo *\fImodeline\fP\,
- XF86VidModeModeInfo *\fIaftermode\fP\^);
-..
-.LP
-Bool XF86VidModeDeleteModeLine(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeModeInfo *\fImodeline\fP\^);
-.LP
-Bool XF86VidModeModModeLine(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeModeLine *\fImodeline\fP\^);
-.LP
-Status XF86VidModeValidateModeLine(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeModeLine *\fImodeline\fP\^);
-.LP
-Bool XF86VidModeSwitchMode(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int \fIzoom\fP\^);
-.LP
-Bool XF86VidModeSwitchToMode(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeModeInfo *\fImodeline\fP\^);
-.LP
-Bool XF86VidModeLockModeSwitch(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int \fIlock\fP\^);
-.LP
-Bool XF86VidModeGetMonitor(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeMonitor *\fImonitor\fP\^);
-.LP
-Bool XF86VidModeGetViewPort(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int *\fIx_return\fP\^,
- int *\fIy_return\fP\^);
-.LP
-Bool XF86VidModeSetViewPort(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int \fIx\fP\^,
- int \fIy\fP\^);
-.LP
-XF86VidModeGetDotClocks(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int *\fIflags return\fP\^,
- int *\fInumber of clocks return\fP\^,
- int *\fImax dot clock return\fP\^,
- int **\fIclocks return\fP\^);
-.LP
-XF86VidModeGetGamma(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeGamma *\fIGamma\fP\^);
-.LP
-XF86VidModeSetGamma(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- XF86VidModeGamma *\fIGamma\fP\^);
-.LP
-XF86VidModeGetGammaRamp(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int \fIsize\fP\^,
- unsigned short *\fIred array\fP\^,
- unsigned short *\fIgreen array\fP\^,
- unsigned short *\fIblue array\fP\^);
-.LP
-XF86VidModeSetGammaRamp(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int \fIsize\fP\^,
- unsigned short *\fIred array\fP\^,
- unsigned short *\fIgreen array\fP\^,
- unsigned short *\fIblue array\fP\^);
-.LP
-XF86VidModeGetGammaRampSize(
- Display *\fIdisplay\fP\^,
- int \fIscreen\fP\^,
- int *\fIsize\fP\^);
-.fi
-.SH ARGUMENTS
-.IP \fIdisplay\fP 2i
-Specifies the connection to the X server.
-.IP \fIscreen\fP 2i
-Specifies which screen number the setting apply to.
-.IP \fIevent_base_return\fP 2i
-Returns the base event number for the extension.
-.IP \fIerror_base_return\fP 2i
-Returns the base error number for the extension.
-.IP \fImajor_version_return\fP 2i
-Returns the major version number of the extension.
-.IP \fIminor_version_return\fP 2i
-Returns the minor version number of the extension.
-.IP \fIdotclock_return\fP 2i
-Returns the clock for the mode line.
-.IP \fImodecount_return\fP 2i
-Returns the number of video modes available in the server.
-.IP \fIzoom\fP 2i
-If greater than zero, indicates that the server should switch to
-the next mode, otherwise switch to the previous mode.
-.IP \fIlock\fP 2i
-Indicates that mode switching should be locked, if non-zero.
-.IP \fImodeline\fP 2i
-Specifies or returns the timing values for a video mode.
-.ig
-.IP \fIaftermode\fP 2i
-Specifies the timing values for the video mode after which the
-new mode will added.
-..
-.IP \fImodesinfo\fP 2i
-Returns the timing values and dotclocks for all of the available
-video modes.
-.IP \fImonitor\fP 2i
-Returns information about the monitor.
-.IP \fIx\fP 2i
-Specifies the desired X location for the viewport.
-.IP \fIx_return\fP 2i
-Returns the current X location of the viewport.
-.IP \fIy\fP 2i
-Specifies the desired Y location for the viewport.
-.IP \fIy_return\fP 2i
-Returns the current Y location of the viewport.
-.SH STRUCTURES
-.nf
-.ta 2.25i 3.5i
-\fIVideo Mode Settings:\fP
-typedef struct {
- unsigned short hdisplay; /\(** Number of display pixels horizontally */
- unsigned short hsyncstart; /\(** Horizontal sync start */
- unsigned short hsyncend; /\(** Horizontal sync end */
- unsigned short htotal; /\(** Total horizontal pixels */
- unsigned short vdisplay; /\(** Number of display pixels vertically */
- unsigned short vsyncstart; /\(** Vertical sync start */
- unsigned short vsyncend; /\(** Vertical sync start */
- unsigned short vtotal; /\(** Total vertical pixels */
- unsigned int flags; /\(** Mode flags */
- int privsize; /\(** Size of private */
- INT32 *private; /\(** Server privates */
-} XF86VidModeModeLine;
-.sp
-typedef struct {
- unsigned int dotclock; /\(** Pixel clock */
- unsigned short hdisplay; /\(** Number of display pixels horizontally */
- unsigned short hsyncstart; /\(** Horizontal sync start */
- unsigned short hsyncend; /\(** Horizontal sync end */
- unsigned short htotal; /\(** Total horizontal pixels */
- unsigned short vdisplay; /\(** Number of display pixels vertically */
- unsigned short vsyncstart; /\(** Vertical sync start */
- unsigned short vsyncend; /\(** Vertical sync start */
- unsigned short vtotal; /\(** Total vertical pixels */
- unsigned int flags; /\(** Mode flags */
- int privsize; /\(** Size of private */
- INT32 *private; /\(** Server privates */
-} XF86VidModeModeInfo;
-.LP
-\fIMonitor information:\fP
-typedef struct {
- char* vendor; /\(** Name of manufacturer */
- char* model; /\(** Model name */
- float EMPTY; /\(** unused, for backward compatibility */
- unsigned char nhsync; /\(** Number of horiz sync ranges */
- XF86VidModeSyncRange* hsync; /\(** Horizontal sync ranges */
- unsigned char nvsync; /\(** Number of vert sync ranges */
- XF86VidModeSyncRange* vsync; /\(** Vertical sync ranges */
-} XF86VidModeMonitor;
-.sp
-typedef struct {
- float hi; /\(** Top of range */
- float lo; /\(** Bottom of range */
-} XF86VidModeSyncRange;
-.LP
-typedef struct {
- int type; /\(** of event */
- unsigned long serial; /\(** # of last request processed by server */
- Bool send_event; /\(** true if this came from a SendEvent req */
- Display *display; /\(** Display the event was read from */
- Window root; /\(** root window of event screen */
- int state; /\(** What happened */
- int kind; /\(** What happened */
- Bool forced; /\(** extents of new region */
- Time time; /\(** event timestamp */
-} XF86VidModeNotifyEvent;
-.LP
-typedef struct {
- float red; /\(** Red Gamma value */
- float green; /\(** Green Gamma value */
- float blue; /\(** Blue Gamma value */
-} XF86VidModeGamma;
-.fi
-.SH DESCRIPTION
-These functions provide an interface to the server extension
-\fIXFree86-VidModeExtension\fP
-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"
-The
-.ZN XF86VidModeGetModeLine
-function is used to query the settings for the currently selected
-video mode. The calling program should pass a pointer to a
-.ZN XF86VidModeModeLine
-structure that it has already allocated. The function fills in
-the fields of the structure.
-.PP
-If there are any server private values (currently only applicable to
-the S3 server) the function will allocate storage for them.
-Therefore, if the
-.ZN privsize
-field is non-zero, the calling program should call
-.ZN Xfree(private)
-to free the storage.
-.PP
-.ZN XF86VidModeGetAllModeLines
-returns the settings for all video modes.
-The calling program supplies the address of a pointer which will be
-set by the function to point to an array of
-.ZN XF86VidModeModeInfo
-structures. The memory occupied by the array is dynamically allocated
-by the
-.ZN XF86VidModeGetAllModeLines
-function and should be freed by the caller.
-The first element of the array corresponds to the current video mode.
-.PP
-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
-capabilities of the monitor).
-.PP
-.ig
-To add a mode to the list of available modes, the
-.ZN XF86VidModeAddModeLine
-function can be used.
-Assuming the settings are valid, the video mode will be added after
-the existing mode which matches the timings specified by the
-.ZN aftermode
-parameter.
-To be considered a match, all of the fields of the given
-.ZN XF86VidModeModeInfo
-structure must match, except the
-.ZN privsize
-and
-.ZN private
-fields.
-If the
-.ZN aftermode
-parameter is zero, the mode will be added
-after the current mode.
-.PP
-..
-Modes can be deleted with the
-.ZN XF86VidModeDeleteModeLine
-function. The specified mode must match an existing mode.
-To be considered a match, all of the fields of the given
-.ZN XF86VidModeModeInfo
-structure must match, except the
-.ZN privsize
-and
-.ZN private
-fields.
-If the mode to be deleted is the current mode, a mode switch
-to the next mode will occur first. The last remaining mode can not
-be deleted.
-.PP
-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
-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"
-When the function
-.ZN XF86VidModeSwitchMode
-is called, the server will change the video mode to next (or previous)
-video mode. The
-.ZN XF86VidModeSwitchToMode
-function can be used to switch directly to the specified mode.
-Matching is as specified in the description of the
-.ZN XF86VidModeAddModeLine
-function above.
-The
-.ZN XF86VidModeLockModeSwitch
-function can be used to allow or disallow mode switching whether
-the request to switch modes comes from a call to the
-.ZN XF86VidModeSwitchMode
-or
-.ZN XF86VidModeSwitchToMode
-functions or from one of the mode switch key sequences.
-.PP
-.RB 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.
-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"
-Information known to the server about the monitor is returned by the
-.ZN XF86VidModeGetMonitor
-function. The
-.ZN hsync
-and
-.ZN vsync
-fields each point to an array of
-.ZN XF86VidModeSyncRange
-structures. The arrays contain
-.ZN nhsync
-and
-.ZN nvsync
-elements, respectively.
-The
-.ZN hi
-and
-.ZN low
-values will be equal if a discreate value was given in the
-.ZN XF86Config
-file.
-.PP
-The
-.ZN vendor ,
-.ZN model ,
-.ZN hsync ,
-and
-.ZN vsync
-fields point to dynamically allocated storage that should be freed
-by the caller.
-.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"
-The
-.ZN XF86VidModeQueryVersion
-function can be used to determine the version of the extension
-built into the server.
-.PP
-The function
-.ZN XF86VidModeQueryExtension
-returns the lowest numbered error and event values
-assigned to the extension.
-.SH BUGS
-The
-XF86VidModeSetClientVersion,
-XF86VidModeGetDotClocks,
-XF86VidModeGetGamma,
-XF86VidModeSetGamma,
-XF86VidModeSetGammaRamp,
-XF86VidModeGetGammaRamp,
-XF86VidModeGetGammaRampSize,
-and
-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__)
-.SH AUTHORS
-Kaleb Keithley, Jon Tombs, David Dawes, and Joe Moss