Commit a7fb5759 authored by Eric S. Raymond's avatar Eric S. Raymond

Eliminate all uses of tab stops in the libX11 man pages.

Two steps: First, expand tabs to 8 spaces in code and structure
listings.  Second, make the .Ds used to wrap code listings switch to
constant-width font (CW) rather than numeric font position 1, which
maps to R on most systems.

It is possible some archaic systems won't know what CW is, but the
only risk is that code listings won't look quite right on troff
devices; the PostScript and DVI drivers definitely grok it, so those
important cases are OK.

The purpose of these changes is to get rid of presentation-level
markup so these pages will lift clean to DocBook.
Signed-off-by: default avatarEric S. Raymond <esr@thyrsus.com>
parent 8042f88a
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -228,12 +228,10 @@ structure provides an interface to the pixmap format information
that is returned at the time of a connection setup.
It contains:
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int depth;
int bits_per_pixel;
int scanline_pad;
int depth;
int bits_per_pixel;
int scanline_pad;
} XPixmapFormatValues;
.De
.SH "SEE ALSO"
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -75,7 +75,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -320,12 +320,10 @@ The
structure contains:
.LP
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int family; /\&* for example FamilyInternet */
int length; /\&* length of address, in bytes */
char *address; /\&* pointer to where to find the address */
int family; /\&* for example FamilyInternet */
int length; /\&* length of address, in bytes */
char *address; /\&* pointer to where to find the address */
} XHostAddress;
.De
.LP
......@@ -346,13 +344,11 @@ member is a pointer to a
structure which contains:
.LP
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int typelength; /\&* length of type string, in bytes */
int valuelength; /\&* length of value string, in bytes */
char *type; /\&* pointer to where to find the type string */
char *value; /\&* pointer to where to find the address */
int typelength; /\&* length of type string, in bytes */
int valuelength; /\&* length of value string, in bytes */
char *type; /\&* pointer to where to find the type string */
char *value; /\&* pointer to where to find the address */
} XServerInterpretedAddress;
.De
.LP
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -221,13 +221,10 @@ structure contains:
.LP
.IN "XClassHint" "" "@DEF@"
.Ds 0
.TA .5i
.ta .5i
typedef struct {
char *res_name;
char *res_class;
char *res_name;
char *res_class;
} XClassHint;
.De
.LP
The res_name member contains the application name,
and the res_class member contains the application class.
......
......@@ -50,7 +50,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -224,12 +224,10 @@ structure contains:
.LP
.IN "XIconSize" "" "@DEF@"
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
typedef struct {
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
} XIconSize;
.De
.LP
......
......@@ -50,7 +50,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -426,24 +426,22 @@ T}
.TE
.IN "XSizeHints" "" "@DEF@"
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
/\&* Values */
typedef struct {
long flags; /\&* marks which fields in this structure are defined */
int x, y; /\&* Obsolete */
int width, height; /\&* Obsolete */
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
struct {
int x; /\&* numerator */
int y; /\&* denominator */
} min_aspect, max_aspect;
int base_width, base_height;
int win_gravity;
/\&* this structure may be extended in the future */
long flags; /\&* marks which fields in this structure are defined */
int x, y; /\&* Obsolete */
int width, height; /\&* Obsolete */
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
struct {
int x; /\&* numerator */
int y; /\&* denominator */
} min_aspect, max_aspect;
int base_width, base_height;
int win_gravity;
/\&* this structure may be extended in the future */
} XSizeHints;
.De
.LP
......
......@@ -50,7 +50,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -296,19 +296,17 @@ T}
/\&* Values */
.IN "XStandardColormap" "" "@DEF@"
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
typedef struct {
Colormap colormap;
unsigned long red_max;
unsigned long red_mult;
unsigned long green_max;
unsigned long green_mult;
unsigned long blue_max;
unsigned long blue_mult;
unsigned long base_pixel;
VisualID visualid;
XID killid;
Colormap colormap;
unsigned long red_max;
unsigned long red_mult;
unsigned long green_max;
unsigned long green_mult;
unsigned long blue_max;
unsigned long blue_mult;
unsigned long base_pixel;
VisualID visualid;
XID killid;
} XStandardColormap;
.De
.LP
......
......@@ -50,7 +50,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -147,14 +147,12 @@ All the event structures declared in
.Pn < X11/Xlib.h >
have the following common members:
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type;
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window;
int type;
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window;
} XAnyEvent;
.De
.LP
......@@ -181,42 +179,40 @@ The
.ZN XEvent
structure is a union of the individual structures declared for each event type:
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef union _XEvent {
int type; /\&* must not be changed */
XAnyEvent xany;
XKeyEvent xkey;
XButtonEvent xbutton;
XMotionEvent xmotion;
XCrossingEvent xcrossing;
XFocusChangeEvent xfocus;
XExposeEvent xexpose;
XGraphicsExposeEvent xgraphicsexpose;
XNoExposeEvent xnoexpose;
XVisibilityEvent xvisibility;
XCreateWindowEvent xcreatewindow;
XDestroyWindowEvent xdestroywindow;
XUnmapEvent xunmap;
XMapEvent xmap;
XMapRequestEvent xmaprequest;
XReparentEvent xreparent;
XConfigureEvent xconfigure;
XGravityEvent xgravity;
XResizeRequestEvent xresizerequest;
XConfigureRequestEvent xconfigurerequest;
XCirculateEvent xcirculate;
XCirculateRequestEvent xcirculaterequest;
XPropertyEvent xproperty;
XSelectionClearEvent xselectionclear;
XSelectionRequestEvent xselectionrequest;
XSelectionEvent xselection;
XColormapEvent xcolormap;
XClientMessageEvent xclient;
XMappingEvent xmapping;
XErrorEvent xerror;
XKeymapEvent xkeymap;
long pad[24];
int type; /\&* must not be changed */
XAnyEvent xany;
XKeyEvent xkey;
XButtonEvent xbutton;
XMotionEvent xmotion;
XCrossingEvent xcrossing;
XFocusChangeEvent xfocus;
XExposeEvent xexpose;
XGraphicsExposeEvent xgraphicsexpose;
XNoExposeEvent xnoexpose;
XVisibilityEvent xvisibility;
XCreateWindowEvent xcreatewindow;
XDestroyWindowEvent xdestroywindow;
XUnmapEvent xunmap;
XMapEvent xmap;
XMapRequestEvent xmaprequest;
XReparentEvent xreparent;
XConfigureEvent xconfigure;
XGravityEvent xgravity;
XResizeRequestEvent xresizerequest;
XConfigureRequestEvent xconfigurerequest;
XCirculateEvent xcirculate;
XCirculateRequestEvent xcirculaterequest;
XPropertyEvent xproperty;
XSelectionClearEvent xselectionclear;
XSelectionRequestEvent xselectionrequest;
XSelectionEvent xselection;
XColormapEvent xcolormap;
XClientMessageEvent xclient;
XMappingEvent xmapping;
XErrorEvent xerror;
XKeymapEvent xkeymap;
long pad[24];
} XEvent;
.De
.LP
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -153,66 +153,60 @@ and
events contain:
.LP
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\&* ButtonPress or ButtonRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int button; /\&* detail */
Bool same_screen; /\&* same screen flag */
int type; /\&* ButtonPress or ButtonRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int button; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XButtonEvent;
typedef XButtonEvent XButtonPressedEvent;
typedef XButtonEvent XButtonReleasedEvent;
.De
.LP
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\&* KeyPress or KeyRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int keycode; /\&* detail */
Bool same_screen; /\&* same screen flag */
int type; /\&* KeyPress or KeyRelease */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window it is reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
unsigned int keycode; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XKeyEvent;
typedef XKeyEvent XKeyPressedEvent;
typedef XKeyEvent XKeyReleasedEvent;
.De
.LP
.Ds 0
.TA .5i 3i
.ta .5i 3i
typedef struct {
int type; /\&* MotionNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
char is_hint; /\&* detail */
Bool same_screen; /\&* same screen flag */
int type; /\&* MotionNotify */
unsigned long serial; /\&* # of last request processed by server */
Bool send_event; /\&* true if this came from a SendEvent request */
Display *display; /\&* Display the event was read from */
Window window; /\&* ``event'' window reported relative to */
Window root; /\&* root window that the event occurred on */
Window subwindow; /\&* child window */
Time time; /\&* milliseconds */
int x, y; /\&* pointer x, y coordinates in event window */
int x_root, y_root; /\&* coordinates relative to root */
unsigned int state; /\&* key or button mask */
char is_hint; /\&* detail */
Bool same_screen; /\&* same screen flag */
} XMotionEvent;
typedef XMotionEvent XPointerMovedEvent;
.De
......
......@@ -50,7 +50,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -311,20 +311,18 @@ T}
.TE
.IN "XKeyboardControl" "" "@DEF@"
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
/\&* Values */
typedef struct {
int key_click_percent;
int bell_percent;
int bell_pitch;
int bell_duration;
int led;
int led_mode; /\&* LedModeOn, LedModeOff */
int key;
int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn,
AutoRepeatModeDefault */
int key_click_percent;
int bell_percent;
int bell_pitch;
int bell_duration;
int led;
int led_mode; /\&* LedModeOn, LedModeOff */
int key;
int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn,
AutoRepeatModeDefault */
} XKeyboardControl;
.De
.LP
......@@ -405,15 +403,13 @@ The
structure contains:
.LP
.Ds 0
.TA .5i
.ta .5i
typedef struct {
int key_click_percent;
int bell_percent;
unsigned int bell_pitch, bell_duration;
unsigned long led_mask;
int global_auto_repeat;
char auto_repeats[32];
int key_click_percent;
int bell_percent;
unsigned int bell_pitch, bell_duration;
unsigned long led_mask;
int global_auto_repeat;
char auto_repeats[32];
} XKeyboardState;
.De
.LP
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......@@ -423,11 +423,9 @@ The
structure contains:
.LP
.Ds 0
.TA .5i 2.5i
.ta .5i 2.5i
typedef struct {
int max_keypermod; /\&* This server's max number of keys per modifier */
KeyCode *modifiermap; /\&* An 8 by max_keypermod array of the modifiers */
int max_keypermod; /\&* This server's max number of keys per modifier */
KeyCode *modifiermap; /\&* An 8 by max_keypermod array of the modifiers */
} XModifierKeymap;
.De
.SH DIAGNOSTICS
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......
......@@ -49,7 +49,7 @@
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.ft CW
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
......