diff options
Diffstat (limited to 'lib/libX11/man/xkb/XkbGetKeyboard.man')
| -rw-r--r-- | lib/libX11/man/xkb/XkbGetKeyboard.man | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/lib/libX11/man/xkb/XkbGetKeyboard.man b/lib/libX11/man/xkb/XkbGetKeyboard.man index ef44afb74..c5daf5b02 100644 --- a/lib/libX11/man/xkb/XkbGetKeyboard.man +++ b/lib/libX11/man/xkb/XkbGetKeyboard.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -47,7 +47,7 @@ determines events to be selected / deselected 1=>select, 0->deselect; for events in bits_to_change .SH DESCRIPTION .LP -.I XkbGetKeyboard +.B XkbGetKeyboard allocates and returns a pointer to a keyboard description. It queries the server for those components specified in the .I which @@ -76,17 +76,32 @@ XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (1L<<7) .TE -.I XkbGetKeyboard +.B XkbGetKeyboard is used to read the current description for one or more components of a keyboard device. It calls -.I XkbGetKeyboardByName +.BR XkbGetKeyboardByName (__libmansuffix__) as follows: .I XkbGetKeyboardByName(dpy, device_spec, NULL, .I which, which, False). +.LP +If successful, +.B XkbGetKeyboard +returns a pointer to a newly allocated +.B XkbDescRec +structure, +which is described in +.BR XkbGetKeyboardByName (__libmansuffix__), +and which should be freed with +.BR XkbFreeKeyboard (__libmansuffix__). +If +.B XkbGetKeyboard +does not succeed, it returns +.BR NULL . .SH DIAGNOSTICS .TP 15 .SM BadAlloc Unable to allocate storage - +.SH "SEE ALSO" +.BR XkbGetKeyboardByName (__libmansuffix__) |