Commit graph

193 commits

Author SHA1 Message Date
Alan Coopersmith
8b77c86a06 Strip trailing whitespace from source files
Performed with: `git ls-files | xargs perl -i -p -e 's{[ \t]+$}{}'`

`git diff -w` & `git diff -b` show no diffs from this change

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/287>
2025-08-02 18:38:26 -07:00
Alan Coopersmith
e003f52661 man pages: Use .BR markup for references to other man pages
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/286>
2025-07-13 10:57:31 -07:00
Alan Coopersmith
d71dbf816b XSetErrorHandler.man: .BR expects at least 2 arguments, got 1
Fix warning from `groff -rCHECKSTYLE=10`

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/286>
2025-07-13 10:16:33 -07:00
Alan Coopersmith
0bddfd82d0 Compose.man: \\ should be \e in troff markup
Fixes warnings from `mandoc -T lint`:
mandoc: Compose.5:121:27: WARNING: undefined escape, printing literally: \\
mandoc: Compose.5:122:10: WARNING: undefined escape, printing literally: \\
mandoc: Compose.5:129:29: WARNING: undefined escape, printing literally: \\

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/286>
2025-07-13 10:09:14 -07:00
Alan Coopersmith
eb400f6fda man pages: remove extraneous paragraph macros
Fixes warnings from `mandoc -T lint`:

mandoc: XChangeKeyboardControl.3:156:2: WARNING: skipping paragraph macro: PP empty
mandoc: XcmsAllocColor.3:147:2: WARNING: skipping paragraph macro: PP empty
mandoc: XcmsStoreColor.3:183:2: WARNING: skipping paragraph macro: PP empty
mandoc: XConfigureWindow.3:236:2: WARNING: skipping paragraph macro: PP empty
mandoc: XCreateWindow.3:221:2: WARNING: skipping paragraph macro: PP empty
mandoc: XGetVisualInfo.3:114:2: WARNING: skipping paragraph macro: PP empty
mandoc: XOpenIM.3:73:2: WARNING: skipping paragraph macro: PP empty
mandoc: XQueryExtension.3:44:2: WARNING: skipping paragraph macro: PP after SH

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/286>
2025-07-13 10:04:44 -07:00
Alan Coopersmith
8848085323 man pages: remove whitespace at end of lines in xkb man pages
Clears 6571 complaints from `mandoc -T lint` of the form:
mandoc: man/xkb/XkbActionCtrls.3:107:4: STYLE: whitespace at end of input line

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/286>
2025-07-13 09:47:54 -07:00
Walter Harms
1261802fb3 fix table width
the width of first column was to small and
caused a hyphenation. there is only one word,
fix for me.
2024-01-07 18:30:30 +01:00
Alan Coopersmith
44f908d928 docs: fix names for XkbKeyKeyType & XkbKeyKeyTypeIndex
Implementation had "Key" twice in these macro names,
but the docs had only listed it once.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
7b16c55063 docs: remove XkbKeySymsOffset
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
41a157dfee docs: remove XkbGetNameChanges
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
3442a8cee2 docs: remove XkbChangeIndicators and Xkb{Get,Note}IndicatorChanges
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:13 -07:00
Alan Coopersmith
b7a15d6c6e docs: XkbSAActionSetCtrls is really named XkbActionSetCtrls
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:31:20 -07:00
Alan Coopersmith
a1d8dd7267 docs: remove XkbGetStickyKeysOptions & XkbSetStickyKeysOptions
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:18:32 -07:00
Alan Coopersmith
bf13f19740 docs: remove XkbGetSlowKeysDelay & XkbSetSlowKeysDelay
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:09:35 -07:00
Alan Coopersmith
caab7321d2 docs: remove XkbGetAccessXTimeout & XkbSetAccessXTimeout
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:04:15 -07:00
Alan Coopersmith
843e89bd24 docs: remove XkbAllocDeviceLedInfo
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 12:58:47 -07:00
Alan Coopersmith
2686dd7a9d docs: finish removing XkbGetBounceKeysDelay & XkbSetBounceKeysDelay
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 12:41:42 -07:00
Alan Coopersmith
757ab5ddd8 Remove XkbSetBounceKeysDelay.man from list of man pages to build
Fixes: f90e6bfa ("rm XkbSetBounceKeysDelay.man")

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-14 08:45:01 -07:00
Walter Harms
f90e6bface rm XkbSetBounceKeysDelay.man
there is no function XkbSetBounceKeysDelay().
It is listed in the specs but never implemented if someone
does it, feel free to get the file back.

closes issue #105
2023-08-13 22:42:50 +02:00
Benno Schulenberg
a6528d92b3 XSetScreenSaver.man: restore the part that was accidentally snipped
Four years ago, while removing private macros, commit fe46eb2871
unintentionally truncated the XSetScreenSaver manpage.  Restore
the snipped part (minus trailing spaces and a mistaken singular).

This fixes issue #187.

Reported-by: Sergio Gelato

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2023-04-04 14:15:05 +02:00
Oliver
696d19d5db Add XFreeThreads function. 2022-11-11 17:04:00 +00:00
Alan Coopersmith
1a7e54609c man pages: document XCloseIM frees its argument
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-11-03 14:44:22 -07:00
Alan Coopersmith
a04b84f0f7 Copyright & license cleanup 2022-11-03 20:31:31 +00:00
Alan Coopersmith
9a90b3a63d doc: Document possible return values for XkbGetKeyboard()
Fixes: #160

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-07-15 22:35:49 +00:00
Matthieu Herrb
9702b83686 Mention that the predicate function is called with the display lock
Signed-off-by: Matthieu Herrb <matthieu@herrb.eu>
2022-07-01 11:13:13 +02:00
Benno Schulenberg
a5d00f889f docs: replace three placeholders with something that makes sense
Also, uncapitalize two arguments, to match the style of all others.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-06-24 16:23:14 +02:00
Benno Schulenberg
9ff8502040 docs: remove the unsightly dashes from the overviews of arguments
Seventeen months ago, commits 78027fdb7a and 4f15cfc645 removed
these dashes from two of the man pages.  Now, remove them all.
They are unhelpful and just make one wonder why they are there
(probably to function as improvised bullet points).

Also remove four leading spaces and a trailing comma.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-06-24 16:11:53 +02:00
Benno Schulenberg
a7968c47e3 docs: hard-wrap some items so that Table 2 fits within 80 characters
(Table 1 hard-wraps the first-column items in the same way.)

Also, correct the formatting of the subsequent paragraph.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-06-23 16:11:23 +02:00
Alan Coopersmith
35d1513bc7 XkbOpenDisplay: Add _Xconst qualifier to display name argument
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-04-23 16:38:49 +00:00
Alan Coopersmith
c88ceaad4a XKBgeom.h: Add _Xconst qualifier to char * arguments in functions
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-04-23 16:38:49 +00:00
Benno Schulenberg
1adb531cd5 docs: unwrap the comments of structure elements in the man pages
It doesn't matter that these lines get wider than 80 columns, as it's
easy enough to make the pager scroll a bit to the right, or to have a
terminal that is a 100 or more columns wide.  It looks better to not
hard-wrap these comments.

Also, fix the layout of two table elements.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-01-14 17:19:37 +00:00
Benno Schulenberg
da330a1644 docs: unwrap some mistakenly wrapped lines, and correct a comment
The wrapped lines messed up the table.  Also, add some blank lines
to make the table more readable.

Elsewhere, add spaces around an operator (for consistency),
and correct a copy-paste error.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-01-14 17:19:37 +00:00
Hodong
150154c994 Fix a typo 2021-11-14 06:36:42 +00:00
Walter Harms
78027fdb7a fix same roff code
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-28 21:05:33 +01:00
Walter Harms
4f15cfc645 Fix some roff code add see also
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-28 20:56:35 +01:00
Walter Harms
daa106927f fix broken nroff coding for code comments
the comments /* */ are code as /\(**  */ that does not work.
the coding in other X11 man pages is /\&* */ so we do the same here.
2020-11-28 17:49:25 +01:00
Walter Harms
7bdeae239b FIX: warning: macro `hN' not defined
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-27 22:43:21 +01:00
Walter Harms
b7ec67d3ea FIX: warning: macro `IN' not defined
just remove an other dead macro use.
2020-11-27 22:26:15 +01:00
Walter Harms
7ca3ceb917 fix warning: macro `s' not defined
this is caused by bad nroff coding, fix some more issues on the fly
2020-11-27 21:58:04 +01:00
Walter Harms
14fb4e5356 FIX: warning: macro `hN' not defined
this was found by checking man pages with
 groff -t -mandoc -Z  -wmac -Tutf8 $FILE >/dev/null

In most cases .hN could be replaced with .BR

Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-27 20:04:22 +01:00
Walter Harms
cb03da4447 FIX: warning: macro `Pn' not defined
The missing macro is found via:
roff -t -mandoc -Z  -wmac -Tutf8 XAnyEvent.man >/dev/null

To fix the problem the macro is replaced with .RB.

Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-27 19:00:00 +01:00
Carlos Garnacho
9f9c536581 Add XSetIOErrorExitHandler() function
This function complements XSetIOErrorHandler(), allowing to override
the default behavior that trusts on I/O errors never coming back
(i.e. exit()ing the process).

This is meant as a mechanism for Wayland compositors (that are too
a X11 client + compositing manager) to unfasten seatbelts and jump
through the car window. It might get lucky and land on a stack of
pillows.

In consequence, some functions labeled as _X_NORETURN can as a
matter of fact return. So those hints were removed.

Signed-off-by: Carlos Garnacho <carlosg@gnome.org>
Reviewed-by: Michel Dänzer <mdaenzer@redhat.com>
2020-10-15 11:14:53 +02:00
Christopher Chavez
780d222343 Fix typo GCCLipYOrigin -> GCClipYOrigin in XCreateGC() manpage 2020-08-10 17:08:39 +00:00
Alan Coopersmith
2b7598221d Fix spelling/wording issues
Found by using:
    codespell --builtin clear,rare,usage,informal,code,names

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2020-07-22 15:19:58 -07:00
Thomas E. Dickey
3ec9264d01
document an ancient performance problem (see Debian #954845).
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2020-04-25 14:44:06 -04:00
Thomas E. Dickey
791c93816c
update/correct function prototypes in manpages to match headers
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2020-04-25 14:44:00 -04:00
Thomas E. Dickey
f111bf3ac0
improve some formatting
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30 16:53:27 -04:00
Thomas E. Dickey
1d0a6fe912
fix a substitution error from recent commit, e.g, "s/^\.EE/XDe/"
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30 15:49:09 -04:00
Thomas E. Dickey
8fe8aafe7e
split lines at sentence endings
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30 05:07:40 -04:00
Thomas E. Dickey
6f2cbcea5d
trim trailing whitespace from manpages
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30 04:52:25 -04:00