summaryrefslogtreecommitdiff
path: root/man
AgeCommit message (Collapse)AuthorFilesLines
2022-06-23docs: hard-wrap some items so that Table 2 fits within 80 charactersBenno Schulenberg1-5/+13
(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-04-23XkbOpenDisplay: Add _Xconst qualifier to display name argumentAlan Coopersmith1-1/+1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-04-23XKBgeom.h: Add _Xconst qualifier to char * arguments in functionsAlan Coopersmith5-7/+8
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-01-14docs: unwrap the comments of structure elements in the man pagesBenno Schulenberg21-222/+111
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-14docs: unwrap some mistakenly wrapped lines, and correct a commentBenno Schulenberg1-10/+12
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>
2021-11-14Fix a typoHodong1-1/+1
2020-11-28fix same roff codeWalter Harms1-25/+14
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-28Fix some roff code add see alsoWalter Harms1-45/+35
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-28fix broken nroff coding for code commentsWalter Harms85-1054/+1054
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-27FIX: warning: macro `hN' not definedWalter Harms1-1/+1
Signed-off-by: Walter Harms <wharms@bfs.de>
2020-11-27FIX: warning: macro `IN' not definedWalter Harms19-44/+0
just remove an other dead macro use.
2020-11-27fix warning: macro `s' not definedWalter Harms1-40/+35
this is caused by bad nroff coding, fix some more issues on the fly
2020-11-27FIX: warning: macro `hN' not definedWalter Harms8-8/+8
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-27FIX: warning: macro `Pn' not definedWalter Harms11-14/+14
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-10-15Add XSetIOErrorExitHandler() functionCarlos Garnacho1-3/+9
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-08-10Fix typo GCCLipYOrigin -> GCClipYOrigin in XCreateGC() manpageChristopher Chavez1-1/+1
2020-07-22Fix spelling/wording issuesAlan Coopersmith4-148/+148
Found by using: codespell --builtin clear,rare,usage,informal,code,names Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2020-04-25document an ancient performance problem (see Debian #954845).Thomas E. Dickey1-0/+7
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2020-04-25update/correct function prototypes in manpages to match headersThomas E. Dickey49-104/+119
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30improve some formattingThomas E. Dickey5-16/+33
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30fix a substitution error from recent commit, e.g, "s/^\.EE/XDe/"Thomas E. Dickey29-30/+30
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30split lines at sentence endingsThomas E. Dickey72-109/+208
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30trim trailing whitespace from manpagesThomas E. Dickey185-2074/+2084
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30another fake-quote fixThomas E. Dickey1-1/+1
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-30the last commit overlooked some fake-quote pairsThomas E. Dickey7-7/+7
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-07-29fix ``fake quotes'' in textWalter Harms16-50/+50
to remove the fake quotes replace them with propper predefined macros \*(lq and \*(rq. this will allow nroff to choose the propper characters when using ps etc. Signed-off-by: Walter Harms <wharms@bfs.de>
2019-07-29get rid of ``fake quotes''Walter Harms181-181/+181
these fake quotes are inside a comment and can be replaced with some double quotes Signed-off-by: Walter Harms <wharms@bfs.de>
2019-07-29remove all private macro definesWalter Harms182-6136/+0
after converting everything to st. man page macros there is no need to maintain X11 private nroff macros, so remove them. Signed-off-by: Walter Harms <wharms@bfs.de>
2019-07-29Replace home-grown .Ds .De macro with man page .EX/.EE macroWalter Harms63-235/+235
Same pages use the man page .EX/.EE macro. Replace all occurences of .De/.Ds with the std. macros to make the code better to maintain. Signed-off-by: Walter Harms <wharms@bfs.de>
2019-07-03fix TBL formatWalter Harms1-1/+1
Signed-off-by: Walter Harms <wharms@bfs.de>
2019-07-03replace home grown .ZN with std, .B and .BRWalter Harms182-3834/+3834
Replace the home grown macro .ZN with std. macros from man macro paket. So we can get rid of the definition an get a clean header. Signed-off-by: Walter Harms <wharms@bfs.de>
2019-06-22remove in-text macrosWalter Harms67-227/+144
remove in-text macros an fix a few typos on the way. hopefuly that will make maintenance more easy. Signed-off-by: Walter Harms <wharms@bfs.de>
2019-06-21note that we can handle kbd==NULLWalter Harms2-0/+16
Signed-off-by: Walter Harms <wharms@bfs.de>
2019-06-09Compose.man: fix escaped hexadecimal char descriptionRan Benita1-1/+1
The man page says: Strings may be direct text encoded in the locale for which the compose file is to be used, or an escaped octal or hexadecimal character code. Octal codes are specified as "\123" and hexadecimal codes as "\0x123a". But the grammar in the parser and the implementation say: ESCAPED_CHAR ::= ('\\' | '\"' | OCTAL | HEX ) HEX ::= '\' (x|X) HEX_CHAR [HEX_CHAR]] HEX_CHAR ::= (0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|a|b|c|d|e|f) So "\0x123a" -> "\x3a". Signed-off-by: Ran Benita <ran234@gmail.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-03-09Add missing close paren to XrmGetStringDatabase synopsis in man pageAlan Coopersmith1-1/+1
Fixes: commit 0642e99ac05afb0c Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-23XkbAllocGeomOverlayKey man page should be named XkbAllocGeomOverlayKeysAlan Coopersmith2-1/+1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-17Fix man page typo: XkbAllBellNotifyMask -> XkbAllBellEventsMaskAlan Coopersmith6-6/+6
Reported-by: Daniel Hahler <git@thequod.de> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2018-06-13XkbOpenDisplay.3: fix typoSamuel Thibault1-1/+1
XkbOpenDisplay returns a pointer to Display, not a Display. Signed-off-by: Samuel Thibault <samuel.thibault@ens-lyon.org>
2017-04-07Improve table formatting in XkbChangeControls & XkbKeyNumGroups man pagesAlan Coopersmith2-74/+91
Includes fix for Solaris Bug 24564279: "XkbKeyNumGroups.3x11 man page contains some malformed text" caused by extra whitespace after .TE macros Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2017-03-24Clarify state parameter to XkbSetNamedDeviceIndicatorAlan Coopersmith1-3/+6
Checking a Bool to see if it's NULL does not work well in C. Also reported in https://bugs.freedesktop.org/show_bug.cgi?id=251 Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Adam Jackson <ajax@redhat.com>
2017-03-24Make Xkb{Get,Set}NamedIndicator spec & manpages match codeAlan Coopersmith5-25/+118
The XKB Library spec and the man pages for XkbGetNamedIndicator & XkbSetNamedIndicator included a device_spec argument neither function takes, and do not include the XkbGetNamedDeviceIndicator & XkbSetNamedDeviceIndicator variants that do take it (along with two other arguments). This updates them to match the interfaces the code has provided for decades. This has been reported multiple times, so this fixes: https://bugs.freedesktop.org/show_bug.cgi?id=251 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=729812 Sun Bug 4528016 XkbSetNamedIndicator & XkbGetNamedIndicator man pages are wrong (filed: alan.coopersmith@sun.com 2001-11-15 - now aka Oracle bug 15087506) X.Org Group Defect Id #9418 Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Adam Jackson <ajax@redhat.com>
2016-08-26XFree will accept NULL as argumentwalter harms1-1/+2
since Xfree is a define for free(): Xlibint.h:#define Xfree(ptr) free((ptr)) Xfree will accept NULL and do nothing. Signed-off-by: Hans de Goede <hdegoede@redhat.com>
2015-02-06Fix XErrorEvent struct field order in man pageJoonas Javanainen1-1/+1
In the man page the field "resourceid" was in a different place than in the actual struct layout in Xlib.h Signed-off-by: Joonas Javanainen <joonas.javanainen@gmail.com> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2015-02-05compose: fix the description of modifiers in compose sequencesRan Benita1-7/+9
The Compose format has a feature which allows specifying certain modifiers must (or must not) be present with a given keysym in the sequence. The grammar in imLcPrs.c and the Compose man page both do not match what the code actually does (see the handling of the variables `modifier_mask` and `modifier` in parseline() in imLcPrs.c, which are eventually matched as `ev->state & modifier_mask == modifier`). Also explicitly list the accepted modifier names, since they are not standard (e.g. "Ctrl" instead of "Control"). Signed-off-by: Ran Benita <ran234@gmail.com> Signed-off-by: James Cloos <cloos@jhcloos.com>
2015-02-05xkb: fix misleading comment about consumed modifiersRan Benita2-2/+2
In the spec and the man page the `mods_rtrn` argument is described as "backfilled with unconsumed modifiers" but actually it is backfilled with the *consumed* modifiers. This is also mentioned a few lines below in each case. Signed-off-by: Ran Benita <ran234@gmail.com> Signed-off-by: James Cloos <cloos@jhcloos.com>
2014-12-10Fix pasto in XkbGetKeyBehaviors(3) manualIngo Schwarze1-3/+3
Reviewed-by: Thomas Klausner <wiz@NetBSD.org> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-05-20Add missing .TE tags to end tables in Xkb man pagesAlan Coopersmith2-0/+2
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-05-20XCreateGC.man: simplify table to work with Solaris tblAlan Coopersmith1-70/+24
Having every table cell be a text diversion (T{...T}) was too much for Solaris tbl to handle, and thus "man XCreateGC" would print the error /usr/man/man3x11/XCreateGC.3x11: line 402: Too many text block diversions tbl quits and not display the table of mask bits or any text in the man page after that table. Since the #define column doesn't need special handling, making it not use text diversions brings the table under the tbl limit. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-03-03man: fix man page for XkbGetMapPeter Hutterer1-1/+1
Returned structure must be freed with XkbFreeKeyboard(). Reported-by: Morten Bøgeskov <mb@dbc.dk> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-06-06Remove call to undefined macro.Eric S. Raymond1-1/+0
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-29 19:05:04 +0000